Utility class for string manipulation. More...

Collaboration diagram for net.sf.gridarta.utils.StringUtils:

Static Public Member Functions
static CharSequence	diffTextString (@NotNull final CharSequence base, @NotNull final String str, final boolean ignoreValues)
	Helper function for 'diffArchText()': Looks for occurrence of the attribute 'str' in 'base' and if found, returns the full line where 'str' occurs in base. More...

static CharSequence	ensureTrailingNewline (@NotNull final String str)
	Returns a given string which ends with a trailing newline character; empty strings remain empty. More...

static String	getAttribute (@NotNull final CharSequence attributes, @NotNull final String attributeName)
	Returns an attribute line from a set of attribute definitions. More...

static String	removeTrailingWhitespace (@NotNull final CharSequence str)
	Removes trailing whitespace from a string. More...

static String	removeTrailingWhitespaceFromLines (@NotNull final CharSequence str)
	Removes trailing whitespace from all lines of a string. More...

static String	sortLines (@NotNull final CharSequence string)
	Sorts newline separated lines in a string. More...

Static Public Attributes
static final Pattern	PATTERN_BACKSLASH = Pattern.compile("\\\\")
	The pattern that matches a single backslash ("\"). More...

static final Pattern	PATTERN_COLON = Pattern.compile(":")
	The pattern that matches a single colon (":"). More...

static final Pattern	PATTERN_COMMA = Pattern.compile(",")
	The pattern that matches a single comma (","). More...

static final Pattern	PATTERN_END_OF_LINE = Pattern.compile("\\s*\n")
	The pattern to match end of line characters separating lines. More...

static final Pattern	PATTERN_EQUAL = Pattern.compile("=")
	The pattern that matches a single equal sign ("="). More...

static final Pattern	PATTERN_NEWLINE = Pattern.compile("\n")
	The pattern that matches a single newline ("\n"). More...

static final Pattern	PATTERN_SLASH = Pattern.compile("/")
	The pattern that matches a single slash ("/"). More...

static final Pattern	PATTERN_SPACE = Pattern.compile(" ")
	The pattern that matches a single space. More...

static final Pattern	PATTERN_SPACES = Pattern.compile(" +")
	The pattern that matches a non-empty sequence of spaces. More...

static final Pattern	PATTERN_WHITESPACE = Pattern.compile("[\\x00-\\x09\\x0b\\x20]+")
	Pattern to match whitespace excluding NL and CR. More...

static final Pattern	PATTERN_WHITESPACE_NEWLINE = Pattern.compile("[\\x00-\\x0b\\x0d\\x20]+")
	Pattern to match whitespace including NL and CR. More...

Private Member Functions
	StringUtils ()
	Private constructor to prevent instantiation. More...

Static Private Attributes
static final Pattern	PATTERN_MULTI_LINE_TRAILING_WHITESPACE = Pattern.compile("(?m)[\\x00-\\x09\\x0b\\x20]+$")
	Pattern to match trailing whitespace in a multi line string. More...

static final Pattern	PATTERN_TRAILING_WHITESPACE = Pattern.compile("[\\x00-\\x09\\x0b\\x20]+$")
	Pattern to match trailing whitespace. More...

Detailed Description

Utility class for string manipulation.

Author: Andreas Kirschbaum

Definition at line 31 of file StringUtils.java.

Constructor & Destructor Documentation

◆ StringUtils()

net.sf.gridarta.utils.StringUtils.StringUtils ( )

private

Private constructor to prevent instantiation.

Definition at line 114 of file StringUtils.java.

Member Function Documentation

◆ diffTextString()

static CharSequence net.sf.gridarta.utils.StringUtils.diffTextString	(	@NotNull final CharSequence	base,
		@NotNull final String	str,
		final boolean	ignoreValues
	)

static

Helper function for 'diffArchText()': Looks for occurrence of the attribute 'str' in 'base' and if found, returns the full line where 'str' occurs in base.

Only occurrences of 'str' at the beginning of a new line are counted as valid. If not found, null is returned.

Parameters

base	full text to search
str	string (attribute) to look for
ignoreValues	if true, lines are matched against 'str' only till the first space (" ")

Returns: the text that differs

Definition at line 159 of file StringUtils.java.

Referenced by net.sf.gridarta.model.io.AttributeListUtils.diffArchTextKeys(), net.sf.gridarta.model.io.AttributeListUtils.diffArchTextValues(), and net.sf.gridarta.utils.StringUtilsTest.testDiffTextString().

Here is the caller graph for this function:

◆ ensureTrailingNewline()

static CharSequence net.sf.gridarta.utils.StringUtils.ensureTrailingNewline ( @NotNull final String str )

static

Returns a given string which ends with a trailing newline character; empty strings remain empty.

If the input strings ends in a newline character or if it is empty, it is returned; else a newline character is appended first.

Parameters

str	the input string

Returns: the string with a trailing newline character

Definition at line 143 of file StringUtils.java.

Referenced by net.sf.gridarta.model.baseobject.AbstractBaseObject< G, A, R, G >.setMsgText(), and net.sf.gridarta.utils.StringUtilsTest.testEnsureTrailingNewline().

Here is the caller graph for this function:

◆ getAttribute()

static String net.sf.gridarta.utils.StringUtils.getAttribute	(	@NotNull final CharSequence	attributes,
		@NotNull final String	attributeName
	)

static

Returns an attribute line from a set of attribute definitions.

If the set contains more than one instance of

attributeName

, only the first instance is returned.

Parameters

attributes	the attribute set to search
attributeName	the attribute name to search for

Returns: the set of attribute value or
null
if the attribute was not found

Definition at line 178 of file StringUtils.java.

Referenced by net.sf.gridarta.utils.StringUtilsTest.testGetAttribute().

Here is the caller graph for this function:

◆ removeTrailingWhitespace()

static String net.sf.gridarta.utils.StringUtils.removeTrailingWhitespace ( @NotNull final CharSequence str )

static

Removes trailing whitespace from a string.

Parameters

str	the string

Returns: the trimmed string

Definition at line 122 of file StringUtils.java.

Referenced by net.sf.gridarta.model.baseobject.AbstractBaseObject< G, A, R, G >.addMsgTextLine(), net.sf.gridarta.model.io.AbstractMapArchObjectParser< MapArchObject >.load(), net.sf.gridarta.model.baseobject.AbstractBaseObject< G, A, R, G >.setLoreText(), and net.sf.gridarta.utils.StringUtilsTest.testRemoveTrailingWhitespace().

Here is the caller graph for this function:

◆ removeTrailingWhitespaceFromLines()

static String net.sf.gridarta.utils.StringUtils.removeTrailingWhitespaceFromLines ( @NotNull final CharSequence str )

static

Removes trailing whitespace from all lines of a string.

Parameters

str	the string

Returns: the trimmed string

Definition at line 131 of file StringUtils.java.

Referenced by net.sf.gridarta.gui.dialog.gameobjectattributes.GameObjectAttributesDialog< G extends GameObject< G, A, R, A extends MapArchObject< A, R extends Archetype< G, A, R >.applySettings2(), net.sf.gridarta.gui.panel.gameobjectattributes.MsgTextTab< G extends GameObject< G, A, R, A extends MapArchObject< A, R extends Archetype< G, A, R >.getMsgText(), net.sf.gridarta.gui.dialog.gameobjectattributes.DialogAttributeText< G extends GameObject< G, A, R, A extends MapArchObject< A, R extends Archetype< G, A, R >.getObjectText(), net.sf.gridarta.model.baseobject.AbstractBaseObject< G, A, R, G >.setMsgText(), and net.sf.gridarta.utils.StringUtilsTest.testRemoveTrailingWhitespaceFromLines().

Here is the caller graph for this function:

◆ sortLines()

static String net.sf.gridarta.utils.StringUtils.sortLines ( @NotNull final CharSequence string )

static

Sorts newline separated lines in a string.

Parameters

string the string to sort

Returns: the sorted string

Definition at line 194 of file StringUtils.java.

Referenced by net.sf.gridarta.model.baseobject.GameObjectText.setObjectText().

Here is the caller graph for this function:

Member Data Documentation

◆ PATTERN_BACKSLASH

final Pattern net.sf.gridarta.utils.StringUtils.PATTERN_BACKSLASH = Pattern.compile("\\\\")

static

The pattern that matches a single backslash ("\").

Definition at line 85 of file StringUtils.java.

Referenced by net.sf.gridarta.model.io.PathManagerUtils.path().

◆ PATTERN_COLON

final Pattern net.sf.gridarta.utils.StringUtils.PATTERN_COLON = Pattern.compile(":")

static

The pattern that matches a single colon (":").

Definition at line 91 of file StringUtils.java.

Referenced by net.sf.gridarta.model.mapcontrol.TestMapControlCreator.createMaps(), and net.sf.gridarta.model.baseobject.AbstractBaseObject< G, A, R, G >.toString().

◆ PATTERN_COMMA

final Pattern net.sf.gridarta.utils.StringUtils.PATTERN_COMMA = Pattern.compile(",")

static

The pattern that matches a single comma (",").

Definition at line 97 of file StringUtils.java.

Referenced by net.sf.gridarta.model.mapmodel.TestMapModelHelper.checkMapContents(), net.sf.gridarta.model.validation.checks.ValidatorFactory< G extends GameObject< G, A, R, A extends MapArchObject< A, R extends Archetype< G, A, R >.createIntegerArray(), net.sf.gridarta.model.validation.checks.ValidatorFactory< G extends GameObject< G, A, R, A extends MapArchObject< A, R extends Archetype< G, A, R >.newValidator(), and net.sf.gridarta.model.archetypetype.ArchetypeTypeParser.parseInv().

◆ PATTERN_END_OF_LINE

final Pattern net.sf.gridarta.utils.StringUtils.PATTERN_END_OF_LINE = Pattern.compile("\\s*\n")

static

The pattern to match end of line characters separating lines.

Definition at line 61 of file StringUtils.java.

◆ PATTERN_EQUAL

final Pattern net.sf.gridarta.utils.StringUtils.PATTERN_EQUAL = Pattern.compile("=")

static

The pattern that matches a single equal sign ("=").

Definition at line 103 of file StringUtils.java.

Referenced by net.sf.gridarta.plugin.PluginExecutor< G extends GameObject< G, A, R, A extends MapArchObject< A, R extends Archetype< G, A, R >.executePlugin(), and net.sf.gridarta.textedit.textarea.tokenmarker.DaimoninAITokenMarker.markTokensImpl().

◆ PATTERN_MULTI_LINE_TRAILING_WHITESPACE

final Pattern net.sf.gridarta.utils.StringUtils.PATTERN_MULTI_LINE_TRAILING_WHITESPACE = Pattern.compile("(?m)[\\x00-\\x09\\x0b\\x20]+$")

staticprivate

Pattern to match trailing whitespace in a multi line string.

Definition at line 55 of file StringUtils.java.

◆ PATTERN_NEWLINE

final Pattern net.sf.gridarta.utils.StringUtils.PATTERN_NEWLINE = Pattern.compile("\n")

static

The pattern that matches a single newline ("\n").

Definition at line 109 of file StringUtils.java.

Referenced by net.sf.gridarta.gui.map.renderer.ToolTipAppender< G extends GameObject< G, A, R, A extends MapArchObject< A, R extends Archetype< G, A, R >.appendGameObject(), net.sf.gridarta.model.anim.DefaultAnimationObject.DefaultAnimationObject(), net.sf.gridarta.gui.map.renderer.ToolTipAppender< G extends GameObject< G, A, R, A extends MapArchObject< A, R extends Archetype< G, A, R >.finish(), net.sf.gridarta.model.anim.AnimationValidator.validateAnimation(), and net.sf.gridarta.model.validation.checks.MapCheckerScriptChecker< G extends GameObject< G, A, R, A extends MapArchObject< A, R extends Archetype< G, A, R >.waitForTermination().

◆ PATTERN_SLASH

final Pattern net.sf.gridarta.utils.StringUtils.PATTERN_SLASH = Pattern.compile("/")

static

The pattern that matches a single slash ("/").

Definition at line 79 of file StringUtils.java.

Referenced by net.sf.gridarta.gui.mapmenu.MapMenu.addMapMenuEntry(), and net.sf.gridarta.model.io.AbstractArchetypeParser< G, A, R, ?>.parseArchetypeFromStream().

◆ PATTERN_SPACE

final Pattern net.sf.gridarta.utils.StringUtils.PATTERN_SPACE = Pattern.compile(" ")

static

The pattern that matches a single space.

Definition at line 67 of file StringUtils.java.

Referenced by net.sf.gridarta.model.configsource.DefaultConfigSourceFactory.DefaultConfigSourceFactory(), and net.sf.gridarta.model.gameobject.MultiPositionData.load().

◆ PATTERN_SPACES

final Pattern net.sf.gridarta.utils.StringUtils.PATTERN_SPACES = Pattern.compile(" +")

static

The pattern that matches a non-empty sequence of spaces.

Definition at line 73 of file StringUtils.java.

Referenced by net.sf.gridarta.model.io.AbstractGameObjectParser< TestGameObject, TestMapArchObject, TestArchetype >.addModifiedFields(), net.sf.gridarta.model.archetype.AbstractArchetypeBuilder< TestGameObject, TestMapArchObject, TestArchetype >.addObjectText(), net.sf.gridarta.model.archetypetype.AttributeBitmask.decodeValue(), net.sf.gridarta.model.archetype.AbstractArchetypeBuilder< TestGameObject, TestMapArchObject, TestArchetype >.finish(), net.sf.gridarta.model.maplocation.MapLocation.getRandomMapParameter(), net.sf.gridarta.gui.dialog.shortcuts.ShortcutsManager.loadShortcuts(), and net.sf.gridarta.model.select.AttributeOtherValueMatchCriteria< G extends GameObject< G, A, R, A extends MapArchObject< A, R extends Archetype< G, A, R >.matches().

◆ PATTERN_TRAILING_WHITESPACE

final Pattern net.sf.gridarta.utils.StringUtils.PATTERN_TRAILING_WHITESPACE = Pattern.compile("[\\x00-\\x09\\x0b\\x20]+$")

staticprivate

Pattern to match trailing whitespace.

Definition at line 49 of file StringUtils.java.

◆ PATTERN_WHITESPACE

final Pattern net.sf.gridarta.utils.StringUtils.PATTERN_WHITESPACE = Pattern.compile("[\\x00-\\x09\\x0b\\x20]+")

static

Pattern to match whitespace excluding NL and CR.

Definition at line 37 of file StringUtils.java.

Referenced by net.sf.gridarta.gui.dialog.prefs.ResPreferences.buildImageSetBox(), net.sf.gridarta.gui.dialog.prefs.GUIPreferences.buildLocaleBox(), net.sf.gridarta.model.match.GameObjectMatcherParser.createTypeNrsArchObjectMatcher(), net.sf.gridarta.model.validation.checks.ValidatorFactory< G extends GameObject< G, A, R, A extends MapArchObject< A, R extends Archetype< G, A, R >.newValidator(), and net.sf.gridarta.var.crossfire.model.io.ArchetypeParser.processLine().

◆ PATTERN_WHITESPACE_NEWLINE

final Pattern net.sf.gridarta.utils.StringUtils.PATTERN_WHITESPACE_NEWLINE = Pattern.compile("[\\x00-\\x0b\\x0d\\x20]+")

static

Pattern to match whitespace including NL and CR.

Definition at line 43 of file StringUtils.java.

Referenced by net.sf.gridarta.model.archetypetype.ArchetypeTypeSetParser.parseAttributeOrder().

The documentation for this class was generated from the following file:

gridarta-gridarta/src/utils/src/main/java/net/sf/gridarta/utils/StringUtils.java

Static Public Member Functions

Static Public Attributes

Private Member Functions

Static Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ StringUtils()

Member Function Documentation

◆ diffTextString()

◆ ensureTrailingNewline()

◆ getAttribute()

◆ removeTrailingWhitespace()

◆ removeTrailingWhitespaceFromLines()

◆ sortLines()

Member Data Documentation

◆ PATTERN_BACKSLASH

◆ PATTERN_COLON

◆ PATTERN_COMMA

◆ PATTERN_END_OF_LINE

◆ PATTERN_EQUAL

◆ PATTERN_MULTI_LINE_TRAILING_WHITESPACE

◆ PATTERN_NEWLINE

◆ PATTERN_SLASH

◆ PATTERN_SPACE

◆ PATTERN_SPACES

◆ PATTERN_TRAILING_WHITESPACE

◆ PATTERN_WHITESPACE

◆ PATTERN_WHITESPACE_NEWLINE