Package com.intellij.psi.codeStyle.arrangement

Class DefaultArrangementEntry

java.lang.Object

com.intellij.psi.codeStyle.arrangement.DefaultArrangementEntry

All Implemented Interfaces:

ArrangementEntry

Direct Known Subclasses:

JavaElementArrangementEntry, XmlElementArrangementEntry

public class DefaultArrangementEntry
extends java.lang.Object
implements ArrangementEntry

Not thread-safe.

Constructor Summary

Constructors

Constructor and Description
DefaultArrangementEntry(ArrangementEntry parent, int startOffset, int endOffset, boolean canBeMatched)

Method Summary

Modifier and Type	Method and Description
void	addChild(ArrangementEntry entry)
void	addDependency(ArrangementEntry dependency)
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()

Methods inherited from class java.lang.Object

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

Constructor Detail

DefaultArrangementEntry

public DefaultArrangementEntry(ArrangementEntry parent,
                               int startOffset,
                               int endOffset,
                               boolean canBeMatched)

Method Detail

getParent

public ArrangementEntry getParent()

Specified by:

getParent in interface ArrangementEntry

Returns:

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

See Also:

ArrangementEntry.getChildren()

getChildren

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

Description copied from interface: ArrangementEntry

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.

Specified by:

getChildren in interface ArrangementEntry

Returns:

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

See Also:

ArrangementEntry.getParent()

addChild

public void addChild(ArrangementEntry entry)

getDependencies

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

Description copied from interface: ArrangementEntry

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.

Specified by:

getDependencies in interface ArrangementEntry

Returns:

current entry's dependencies (if any)

addDependency

public void addDependency(ArrangementEntry dependency)

getStartOffset

public int getStartOffset()

Specified by:

getStartOffset in interface ArrangementEntry

Returns:

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

getEndOffset

public int getEndOffset()

Specified by:

getEndOffset in interface ArrangementEntry

Returns:

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

canBeMatched

public boolean canBeMatched()

Description copied from interface: ArrangementEntry

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.

Specified by:

canBeMatched in interface ArrangementEntry

Returns:

true if current entry can be matched; false otherwise