Package com.intellij.psi.codeStyle.arrangement

Interface ArrangementEntry

All Known Subinterfaces:

LanguageAwareArrangementEntry, ModifierAwareArrangementEntry, NameAwareArrangementEntry, TextAwareArrangementEntry, TypeAwareArrangementEntry

All Known Implementing Classes:

DefaultArrangementEntry, JavaElementArrangementEntry, JavaSectionArrangementEntry, XmlElementArrangementEntry

public interface ArrangementEntry

Represents a processing unit during 'rearrangement' operation. I.e. entry's position can be changed during the processing.

Example: we can provide a grouping rule for class methods (e.g. getters and setters). Every such method will be represented by a ArrangementEntry then.

The entries can be organised into hierarchies where every sub-hierarchy is independent (see getParent(), getChildren()).

Implementations of this interface are not obliged to be thread-safe.

Method Summary

Modifier and Type	Method and Description
boolean	canBeMatched() Sometimes we want particular entry to serve just as another entries holder.
java.util.List<? extends ArrangementEntry>	getChildren() Entries can be organised into hierarchies, that means that only siblings position can be changed during the rearrangement.
java.util.List<? extends ArrangementEntry>	getDependencies() There is a possible case that particular entry position depends on another entries positions.
int	getEndOffset()
ArrangementEntry	getParent()
int	getStartOffset()

Method Detail

getParent

ArrangementEntry getParent()

Returns:

parent entry, e.g. it would be a class entry for a method entry

See Also:

getChildren()

getChildren

java.util.List<? extends ArrangementEntry> getChildren()

Entries can be organised into hierarchies, that means that only siblings position can be changed during the rearrangement.

Example: there are two classes at file and every class has two methods. Rearranger should not swap positions of methods from the different classes here.

Returns:

current entry's children. Empty collection if there are no children

See Also:

getParent()

getDependencies

java.util.List<? extends ArrangementEntry> getDependencies()

There is a possible case that particular entry position depends on another entries positions. E.g. static initialization block which uses static fields from the same class must be declared after them.

This method allows to answer what sibling entries must be located before the current one at the resulting arrangement algorithm.

There is also a special case when a list with the single entry which is the current's entry parent is returned - that means that current entry should be arranged to be the first child.

Returns:

current entry's dependencies (if any)

getStartOffset

int getStartOffset()

Returns:

start offset of the current entry (inclusive) within the target document. Rearranger engine uses this information to move rearranged entries

getEndOffset

int getEndOffset()

Returns:

end offset of the current entry (exclusive) within the target document. Rearranger engine uses this information to move rearranged entries

canBeMatched

boolean canBeMatched()

Sometimes we want particular entry to serve just as another entries holder. For example, we might want to arrange anonymous class entries but don't want the class itself, say, to be arranged with normal inner classes.

That is achieved for entries which return 'false' from this method call.

Returns:

true if current entry can be matched; false otherwise