Package com.intellij.psi.codeStyle.arrangement

Interface Rearranger<E extends ArrangementEntry>

Type Parameters:

E - entry type

All Known Implementing Classes:

HtmlRearranger, JavaRearranger, XmlRearranger

public interface Rearranger<E extends ArrangementEntry>

Encapsulates language-specific rearrangement logic.

Implementations of this interface are expected to be thread-safe.

Field Summary

Fields

Modifier and Type	Field and Description
static LanguageExtension<Rearranger<?>>	EXTENSION

Method Summary

Modifier and Type	Method and Description
int	getBlankLines(CodeStyleSettings settings, E parent, E previous, E target) Allows to answer how many blank lines should be inserted before the target arrangement entry which position is changed.
ArrangementSettingsSerializer	getSerializer()
java.util.List<E>	parse(PsiElement root, Document document, java.util.Collection<TextRange> ranges, ArrangementSettings settings) Allows to build rearranger-interested data for the given element.
Pair<E,java.util.List<E>>	parseWithNew(PsiElement root, Document document, java.util.Collection<TextRange> ranges, PsiElement element, ArrangementSettings settings) Tries to wrap given element into arrangement entry at the target context.

Field Detail

EXTENSION

static final LanguageExtension<Rearranger<?>> EXTENSION

Method Detail

parseWithNew

Pair<E,java.util.List<E>> parseWithNew(PsiElement root,
                                       Document document,
                                       java.util.Collection<TextRange> ranges,
                                       PsiElement element,
                                       ArrangementSettings settings)

Tries to wrap given element into arrangement entry at the target context.

This is useful in a situation when new element is generated and we're deciding where to insert it (e.g. new field is generated and we want to insert it according to the arrangement rules like 'fields before methods').

Parameters:

element - element to wrap into format eligible for further processing by arrangement engine

settings - arrangement settings to use. The primary idea is to make the rearranger aware about grouping rules (if any). E.g. it's not worth to process java method bodies in order to build method dependency graph if no such grouping rule is defined

Returns:

arrangement entry for the given element if it's possible to perform the mapping and list of arrangement entries available at the given context plus newly created entry for the given element; null otherwise

parse

java.util.List<E> parse(PsiElement root,
                        Document document,
                        java.util.Collection<TextRange> ranges,
                        ArrangementSettings settings)

Allows to build rearranger-interested data for the given element.

Parameters:

root - root element which children should be parsed for the rearrangement

document - document which corresponds to the target PSI tree

ranges - target offsets ranges to use for filtering given root's children

settings - arrangement settings to use. The primary idea is to make the rearranger aware about grouping rules (if any). E.g. it's not worth to process java method bodies in order to build method dependency graph if no such grouping rule is defined

Returns:

given root's children which are subject for further rearrangement

getBlankLines

int getBlankLines(CodeStyleSettings settings,
                  E parent,
                  E previous,
                  E target)

Allows to answer how many blank lines should be inserted before the target arrangement entry which position is changed.

Parameters:

settings - code style settings to use (it's assumed that returned result is derived from 'blank lines' code style settings)

parent - target entry's parent (if available)

previous - previous entry (if available)

target - target entry which blank lines number the caller is interested in

Returns:

number of blank lines to insert before the target entry; negative as an indication that no blank lines adjustment is necessary

getSerializer

ArrangementSettingsSerializer getSerializer()

Returns:

serializer to save arrangement settings. Serializer is expected to be lazy and don't save default settings.

See Also:

DefaultArrangementSettingsSerializer