Package com.intellij.psi.codeStyle.arrangement

Class ArrangementUtil

java.lang.Object

com.intellij.psi.codeStyle.arrangement.ArrangementUtil

public class ArrangementUtil
extends java.lang.Object

Method Summary

Modifier and Type	Method and Description
static ArrangementEntryMatcher	buildMatcher(ArrangementAtomMatchCondition condition)
static ArrangementEntryMatcher	buildMatcher(ArrangementMatchCondition condition)
static ArrangementUiComponent	buildUiComponent(StdArrangementTokenUiRole role, java.util.List<? extends ArrangementSettingsToken> tokens, ArrangementColorsProvider colorsProvider, ArrangementStandardSettingsManager settingsManager)
static java.util.List<StdArrangementMatchRule>	collectMatchRules(java.util.List<? extends ArrangementSectionRule> sections)
static ArrangementMatchCondition	combine(ArrangementMatchCondition... nodes)
static TextRange	expandToLineIfPossible(TextRange initialRange, Document document) Tries to build a text range on the given arguments basis.
static java.util.Map<ArrangementSettingsToken,java.lang.Object>	extractTokens(ArrangementMatchCondition condition)
static java.util.List<CompositeArrangementSettingsToken>	flatten(CompositeArrangementSettingsToken base)
static <T> java.util.Set<T>	flatten(java.lang.Iterable<? extends java.lang.Iterable<? extends T>> data)
static ArrangementSettings	getArrangementSettings(CodeStyleSettings settings, Language language)
static java.util.List<ArrangementSectionRule>	getExtendedSectionRules(ArrangementSettings settings)
static boolean	isAliasedCondition(ArrangementAtomMatchCondition condition)
static ArrangementSettingsToken	parseType(ArrangementMatchCondition condition)
static ArrangementSettings	readExternal(Element element, Language language)
static void	writeExternal(Element element, ArrangementSettings settings, Language language)

Methods inherited from class java.lang.Object

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

Method Detail

getArrangementSettings

public static ArrangementSettings getArrangementSettings(CodeStyleSettings settings,
                                                         Language language)

readExternal

public static ArrangementSettings readExternal(Element element,
                                               Language language)

writeExternal

public static void writeExternal(Element element,
                                 ArrangementSettings settings,
                                 Language language)

combine

public static ArrangementMatchCondition combine(ArrangementMatchCondition... nodes)

expandToLineIfPossible

public static TextRange expandToLineIfPossible(TextRange initialRange,
                                               Document document)

Tries to build a text range on the given arguments basis. Expands to the line start/end if possible.

This method is expected to be used in a situation when we want to arrange complete rows. Example:

   class Test {
        void test() {
        }
      int i;
   }
 

Suppose, we want to locate fields before methods. We can move the exact field and method range then but indent will be broken, i.e. we'll get the result below:

   class Test {
        int i;
      void test() {
        }
   }
 

We can expand field and method range to the whole lines and that would allow to achieve the desired result:

   class Test {
      int i;
        void test() {
        }
   }
 

However, this method is expected to just return given range if there are multiple distinct elements at the same line:

   class Test {
     void test1(){} void test2() {} int i;
   }
 

Parameters:

initialRange - anchor range

document - target document against which the ranges are built

Returns:

expanded range if possible; null otherwise

parseType

public static ArrangementSettingsToken parseType(ArrangementMatchCondition condition)
                                          throws java.lang.IllegalArgumentException

Throws:

java.lang.IllegalArgumentException

flatten

public static <T> java.util.Set<T> flatten(java.lang.Iterable<? extends java.lang.Iterable<? extends T>> data)

extractTokens

public static java.util.Map<ArrangementSettingsToken,java.lang.Object> extractTokens(ArrangementMatchCondition condition)

buildMatcher

public static ArrangementEntryMatcher buildMatcher(ArrangementMatchCondition condition)

buildMatcher

public static ArrangementEntryMatcher buildMatcher(ArrangementAtomMatchCondition condition)

buildUiComponent

public static ArrangementUiComponent buildUiComponent(StdArrangementTokenUiRole role,
                                                      java.util.List<? extends ArrangementSettingsToken> tokens,
                                                      ArrangementColorsProvider colorsProvider,
                                                      ArrangementStandardSettingsManager settingsManager)
                                               throws java.lang.IllegalArgumentException

Throws:

java.lang.IllegalArgumentException

flatten

public static java.util.List<CompositeArrangementSettingsToken> flatten(CompositeArrangementSettingsToken base)

collectMatchRules

public static java.util.List<StdArrangementMatchRule> collectMatchRules(java.util.List<? extends ArrangementSectionRule> sections)

getExtendedSectionRules

public static java.util.List<ArrangementSectionRule> getExtendedSectionRules(ArrangementSettings settings)

isAliasedCondition

public static boolean isAliasedCondition(ArrangementAtomMatchCondition condition)