Package com.intellij.psi.codeStyle.arrangement

Class JavaRearranger

java.lang.Object

com.intellij.psi.codeStyle.arrangement.JavaRearranger

All Implemented Interfaces:

Rearranger<JavaElementArrangementEntry>, ArrangementColorsAware, ArrangementSectionRuleAwareSettings, ArrangementStandardSettingsAware, java.lang.Cloneable

public class JavaRearranger
extends java.lang.Object
implements Rearranger<JavaElementArrangementEntry>, ArrangementSectionRuleAwareSettings, ArrangementStandardSettingsAware, ArrangementColorsAware

Field Summary

Fields inherited from interface com.intellij.psi.codeStyle.arrangement.Rearranger

EXTENSION

Constructor Summary

Constructors

Constructor and Description
JavaRearranger()

Method Summary

Modifier and Type	Method and Description
ArrangementEntryMatcher	buildMatcher(ArrangementMatchCondition condition) This method is assumed to be used only by third-party developers.
int	getBlankLines(CodeStyleSettings settings, JavaElementArrangementEntry parent, JavaElementArrangementEntry previous, JavaElementArrangementEntry target) Allows to answer how many blank lines should be inserted before the target arrangement entry which position is changed.
java.awt.Color	getBorderColor(EditorColorsScheme scheme, boolean selected)
StdArrangementSettings	getDefaultSettings()
java.util.Collection<java.util.Set<ArrangementSettingsToken>>	getMutexes()
ArrangementSettingsSerializer	getSerializer()
java.util.List<CompositeArrangementSettingsToken>	getSupportedGroupingTokens()
java.util.List<CompositeArrangementSettingsToken>	getSupportedMatchingTokens()
TextAttributes	getTextAttributes(EditorColorsScheme scheme, ArrangementSettingsToken token, boolean selected)
boolean	isEnabled(ArrangementSettingsToken token, ArrangementMatchCondition current) Allows to answer if given token is enabled in combination with other conditions specified by the given condition object.
java.util.List<JavaElementArrangementEntry>	parse(PsiElement root, Document document, java.util.Collection<TextRange> ranges, ArrangementSettings settings) Allows to build rearranger-interested data for the given element.
Pair<JavaElementArrangementEntry,java.util.List<JavaElementArrangementEntry>>	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.
void	setupFieldInitializationDependencies(java.util.List<? extends ArrangementEntryDependencyInfo> fieldDependencyRoots, ArrangementSettings settings, JavaArrangementParseInfo parseInfo)

Methods inherited from class java.lang.Object

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

Constructor Detail

JavaRearranger

public JavaRearranger()

Method Detail

parseWithNew

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

Description copied from interface: Rearranger

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').

Specified by:

parseWithNew in interface Rearranger<JavaElementArrangementEntry>

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

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

Description copied from interface: Rearranger

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

Specified by:

parse in interface Rearranger<JavaElementArrangementEntry>

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

setupFieldInitializationDependencies

public void setupFieldInitializationDependencies(java.util.List<? extends ArrangementEntryDependencyInfo> fieldDependencyRoots,
                                                 ArrangementSettings settings,
                                                 JavaArrangementParseInfo parseInfo)

getBlankLines

public int getBlankLines(CodeStyleSettings settings,
                         JavaElementArrangementEntry parent,
                         JavaElementArrangementEntry previous,
                         JavaElementArrangementEntry target)

Description copied from interface: Rearranger

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

Specified by:

getBlankLines in interface Rearranger<JavaElementArrangementEntry>

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

public ArrangementSettingsSerializer getSerializer()

Specified by:

getSerializer in interface Rearranger<JavaElementArrangementEntry>

Returns:

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

See Also:

DefaultArrangementSettingsSerializer

getDefaultSettings

public StdArrangementSettings getDefaultSettings()

Specified by:

getDefaultSettings in interface ArrangementStandardSettingsAware

Returns:

settings to use by default, i.e. when a user hasn't been explicitly modified arrangement settings; null as an indication that no default settings are available

getSupportedGroupingTokens

public java.util.List<CompositeArrangementSettingsToken> getSupportedGroupingTokens()

Specified by:

getSupportedGroupingTokens in interface ArrangementStandardSettingsAware

Returns:

ordered collection of grouping tokens eligible to use with the current rearranger. Note: platform code which uses this method caches returned results

getSupportedMatchingTokens

public java.util.List<CompositeArrangementSettingsToken> getSupportedMatchingTokens()

Specified by:

getSupportedMatchingTokens in interface ArrangementStandardSettingsAware

Returns:

ordered collection of matching tokens eligible to use with the current rearranger Note: platform code which uses this method caches returned results

isEnabled

public boolean isEnabled(ArrangementSettingsToken token,
                         ArrangementMatchCondition current)

Description copied from interface: ArrangementStandardSettingsAware

Allows to answer if given token is enabled in combination with other conditions specified by the given condition object.

Example: say, current rearranger is for java and given condition is like 'public class'. This method is expected to return false for token 'volatile' (because it can be applied only to fields) but true for token 'abstract' (a java class can be abstract).

Specified by:

isEnabled in interface ArrangementStandardSettingsAware

Parameters:

token - target token to check

current - an object which represents currently chosen tokens; null if no other token is selected

Returns:

true if given token is enabled with the given condition; false otherwise

buildMatcher

public ArrangementEntryMatcher buildMatcher(ArrangementMatchCondition condition)
                                     throws java.lang.IllegalArgumentException

Description copied from interface: ArrangementStandardSettingsAware

This method is assumed to be used only by third-party developers. All built-in IJ conditions are supposed to be implemented in terms of StdArrangementTokens.

Specified by:

buildMatcher in interface ArrangementStandardSettingsAware

Parameters:

condition - target condition

Returns:

a matcher for the given condition

Throws:

java.lang.IllegalArgumentException - if current rearranger doesn't know how to build a matcher from the given condition

getMutexes

public java.util.Collection<java.util.Set<ArrangementSettingsToken>> getMutexes()

Specified by:

getMutexes in interface ArrangementStandardSettingsAware

Returns:

collections of mutual exclusion settings. It's is used by standard arrangement settings UI to automatically deselect elements on selection change. Example: 'private' modifier was selected. When any other modifier is selected 'public' modifier is deselected if returned collection contains set of all supported visibility modifiers

getTextAttributes

public TextAttributes getTextAttributes(EditorColorsScheme scheme,
                                        ArrangementSettingsToken token,
                                        boolean selected)

Specified by:

getTextAttributes in interface ArrangementColorsAware

getBorderColor

public java.awt.Color getBorderColor(EditorColorsScheme scheme,
                                     boolean selected)

Specified by:

getBorderColor in interface ArrangementColorsAware