Package com.intellij.usages.rules

Class SingleParentUsageGroupingRule

java.lang.Object

com.intellij.usages.rules.SingleParentUsageGroupingRule

All Implemented Interfaces:

UsageGroupingRule

Direct Known Subclasses:

ClassGroupingRule, DirectoryGroupingRule, FileGroupingRule, MethodGroupingRule, NonCodeUsageGroupingRule, UsageScopeGroupingRule, UsageTypeGroupingRule

public abstract class SingleParentUsageGroupingRule
extends java.lang.Object
implements UsageGroupingRule

Field Summary

Fields inherited from interface com.intellij.usages.rules.UsageGroupingRule

EMPTY_ARRAY

Constructor Summary

Constructors

Constructor and Description
SingleParentUsageGroupingRule()

Method Summary

Modifier and Type	Method and Description
protected abstract UsageGroup	getParentGroupFor(Usage usage, UsageTarget [] targets)
java.util.List<UsageGroup>	getParentGroupsFor(Usage usage, UsageTarget [] targets) Return list of nested parent groups for a usage.
UsageGroup	groupUsage(Usage usage) Deprecated. override getParentGroupFor(Usage, UsageTarget[]) instead

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.intellij.usages.rules.UsageGroupingRule

getRank

Constructor Detail

SingleParentUsageGroupingRule

public SingleParentUsageGroupingRule()

Method Detail

getParentGroupFor

protected abstract UsageGroup getParentGroupFor(Usage usage,
                                                UsageTarget [] targets)

Returns:

a group a specific usage should be placed into, or null, if this rule doesn't apply to this kind of usages.

getParentGroupsFor

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

Description copied from interface: UsageGroupingRule

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.

Specified by:

getParentGroupsFor in interface UsageGroupingRule

groupUsage

@Deprecated
public UsageGroup groupUsage(Usage usage)

Deprecated. override getParentGroupFor(Usage, UsageTarget[]) instead

Specified by:

groupUsage in interface UsageGroupingRule