Package com.intellij.psi.formatter

Class StaticSymbolWhiteSpaceDefinitionStrategy

java.lang.Object

com.intellij.psi.formatter.AbstractWhiteSpaceFormattingStrategy

com.intellij.psi.formatter.StaticSymbolWhiteSpaceDefinitionStrategy

All Implemented Interfaces:

WhiteSpaceFormattingStrategy

Direct Known Subclasses:

PyWhiteSpaceFormattingStrategy

public class StaticSymbolWhiteSpaceDefinitionStrategy
extends AbstractWhiteSpaceFormattingStrategy

WhiteSpaceFormattingStrategy implementation that is pre-configured with the set of symbols that may be treated as white spaces.

Please note that this class exists just for performance reasons (functionally we can use StaticTextWhiteSpaceDefinitionStrategy with strings consisting from single symbol all the time).

Thread-safe.

Constructor Summary

Constructors

Constructor and Description
StaticSymbolWhiteSpaceDefinitionStrategy(char... whiteSpaceSymbols) Creates new StaticWhiteSpaceDefinitionStrategy object with the symbols that should be treated as white spaces.

Method Summary

Modifier and Type	Method and Description
int	check(java.lang.CharSequence text, int start, int end) Checks if given sub-sequence of the given text contains symbols that may be treated as white spaces.

Methods inherited from class com.intellij.psi.formatter.AbstractWhiteSpaceFormattingStrategy

addWhitespace, adjustWhiteSpaceIfNecessary, adjustWhiteSpaceIfNecessary, containsWhitespacesOnly, replaceDefaultStrategy

Methods inherited from class java.lang.Object

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

Constructor Detail

StaticSymbolWhiteSpaceDefinitionStrategy

public StaticSymbolWhiteSpaceDefinitionStrategy(char... whiteSpaceSymbols)

Creates new StaticWhiteSpaceDefinitionStrategy object with the symbols that should be treated as white spaces.

Parameters:

whiteSpaceSymbols - symbols that should be treated as white spaces by the current strategy

Method Detail

check

public int check(java.lang.CharSequence text,
                 int start,
                 int end)

Description copied from interface: WhiteSpaceFormattingStrategy

Checks if given sub-sequence of the given text contains symbols that may be treated as white spaces.

Parameters:

text - text to check

start - start offset to use with the given text (inclusive)

end - end offset to use with the given text (exclusive)

Returns:

offset of the first symbol that belongs to [startOffset; endOffset) range and is not treated as white space by the current strategy or value that is greater or equal to the given 'end' parameter if all target sub-sequence symbols can be treated as white spaces