Package de.xima.fc.helper

Class PlaceholderStringTokenizer

java.lang.Object

de.xima.fc.helper.PlaceholderStringTokenizer

public final class PlaceholderStringTokenizer
extends Object

Helper for splitting strings containing placeholders into the surrounding text and the placeholders.

Since:

7.0.0

Author:

XIMA MEDIA GmbH

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	PlaceholderStringTokenizer.PlaceholderStringLiteralToken	Represents a non-placeholder part of a string.
static final class	PlaceholderStringTokenizer.PlaceholderStringPlaceholderToken	Represents a placeholder part of a string.
static class	PlaceholderStringTokenizer.PlaceholderStringToken	Represents either a literal (non-placeholder) or placeholder part of a string.

Constructor Summary

Constructors

Constructor	Description
PlaceholderStringTokenizer()

Method Summary

Modifier and Type	Method	Description
static final String	stringify(Iterable<PlaceholderStringTokenizer.PlaceholderStringToken> tokens)	Takes a list of parts produced by tokenize(String) and converts it back into a string.
static final List<PlaceholderStringTokenizer.PlaceholderStringToken>	tokenize(String value)	Takes a string that may contain placeholders and splits it into the literal (non-placeholder) parts and the placeholder parts.

Methods inherited from class java.lang.Object

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

Constructor Details

PlaceholderStringTokenizer

public PlaceholderStringTokenizer()

Method Details

stringify

public static final String stringify(Iterable<PlaceholderStringTokenizer.PlaceholderStringToken> tokens)

Takes a list of parts produced by tokenize(String) and converts it back into a string.

Parameters:

tokens - Tokens to convert back into a string.

Returns:

The string that represents the tokens.

tokenize

public static final List<PlaceholderStringTokenizer.PlaceholderStringToken> tokenize(String value)

Takes a string that may contain placeholders and splits it into the literal (non-placeholder) parts and the placeholder parts. For example, hello [%tf1%] world would be split into the literal <hello >, the placeholder <tf1>, and the literal < world>.

Parameters:

value - A string to split that may contain placeholders.

Returns:

The parts of the string, each element is either a PlaceholderStringTokenizer.PlaceholderStringLiteralToken or PlaceholderStringTokenizer.PlaceholderStringPlaceholderToken.