Package com.intellij.usages.rules

Interface UsageGroupingRule

All Known Implementing Classes:

ClassGroupingRule, DirectoryGroupingRule, FileGroupingRule, MethodGroupingRule, ModuleGroupingRule, NonCodeUsageGroupingRule, NonJavaFileGroupingRule, PackageGroupingRule, SingleParentUsageGroupingRule, UsageScopeGroupingRule, UsageTypeGroupingRule

public interface UsageGroupingRule

A rule specifying how specific Usage View elements should be grouped. During indexing, only instances that implement DumbAware are executed.

Field Summary

Fields

Modifier and Type	Field and Description
static UsageGroupingRule[]	EMPTY_ARRAY

Method Summary

Modifier and Type	Method and Description
default java.util.List<UsageGroup>	getParentGroupsFor(Usage usage, UsageTarget [] targets) Return list of nested parent groups for a usage.
default int	getRank() Override this method to change order in which rules are applied.
default UsageGroup	groupUsage(Usage usage) Deprecated. extend SingleParentUsageGroupingRule and override getParentGroupFor instead

Field Detail

EMPTY_ARRAY

static final UsageGroupingRule[] EMPTY_ARRAY

Method Detail

getParentGroupsFor

default java.util.List<UsageGroup> getParentGroupsFor(Usage usage,
                                                      UsageTarget [] targets)

Return list of nested parent groups for a usage. The specified usage will be placed into the last group from the list, that group will be placed under the next to last group, etc.

If the rule returns at most one parent group extend SingleParentUsageGroupingRule and override getParentGroupFor instead.

getRank

default int getRank()

Override this method to change order in which rules are applied. Rules with smaller ranks are applied earlier, i.e. parent groups returned by them will be placed closer to the tree root.

groupUsage

@Deprecated
default UsageGroup groupUsage(Usage usage)

Deprecated. extend SingleParentUsageGroupingRule and override getParentGroupFor instead