org.eclipse.xtend2.lib

Class StringConcatenation

java.lang.Object

org.eclipse.xtend2.lib.StringConcatenation

All Implemented Interfaces:

CharSequence

@GwtCompatible
public class StringConcatenation
extends Object
implements CharSequence

A StringConcatenation allows for efficient, indentation aware concatenation of character sequences.

In addition to the methods that are specified by the implemented interface CharSequence, there are some other public operations that allow to modify the contents of this sequence. The string representation of arbitrary objects can be appended to an instance of StringConcatenation. There are overloaded variants of append(Object, String) that allow to pass an indentation that should be applied to each line of the appended content. Each line break that is part of the new content will be replaced by the line delimiter that was configured for this StringConcatenation.

The append-operation ignores null arguments. This is different to what StringBuffer or StringBuilder do and that's the reason why the Appendable interface is not fulfilled by a StringConcatenation.

The object uses an internal List of Strings that is concatenated on demand to a complete sequence. Use toString() to get the joined version of a StringConcatenation.

Object.equals(Object) and Object.hashCode() are not specialized for a StringConcatenation, that is, the semantics are based on identity similar to what StringBuffer and StringBuilder do.

Since:

2.3

Author:

Sebastian Zarnekow - Initial contribution and API

Field Summary

Fields

Modifier and Type	Field and Description
static String	DEFAULT_LINE_DELIMITER The default line delimiter that is used by instances of StringConcatenation.

Constructor Summary

Constructors

Constructor and Description
StringConcatenation() Create a new concatenation that uses the system line delimiter.
StringConcatenation(String lineDelimiter) Create a new concatenation with the specified delimiter.

Method Summary

Methods

Modifier and Type	Method and Description
void	append(Object object) Append the string representation of the given object to this sequence.
protected void	append(Object object, int index) Add the string representation of the given object to this sequence at the given index.
void	append(Object object, String indentation) Add the string representation of the given object to this sequence.
protected void	append(Object object, String indentation, int index) Add the string representation of the given object to this sequence at the given index.
void	appendImmediate(Object object, String indentation) Add the string representation of the given object to this sequence immediately.
protected void	appendSegments(int index, List<String> otherSegments) Add the list of segments to this sequence at the given index.
protected void	appendSegments(int index, List<String> otherSegments, String otherDelimiter) Add the list of segments to this sequence at the given index.
protected void	appendSegments(String indentation, int index, List<String> otherSegments, String otherDelimiter) Add the list of segments to this sequence at the given index.
char	charAt(int index) Only the significant content of this sequence is considered.
protected List<String>	getContent() Return the actual content of this sequence, including all trailing whitespace.
protected String	getLineDelimiter() Allows subtypes to access the configured line delimiter.
protected List<String>	getSignificantContent() Compute the significant content of this sequence.
protected String	getStringRepresentation(Object object) Computes the string representation of the given object.
int	length() Only the significant content of this sequence is considered.
void	newLine() Add a newline to this sequence according to the configured lineDelimiter.
void	newLineIfNotEmpty() Add a newline to this sequence according to the configured lineDelimiter if the last line contains something besides whitespace.
protected List<String>	splitLinesAndNewLines(String text) Return a list of segments where each segment is either the content of a line in the given text or a line-break according to the configured delimiter.
CharSequence	subSequence(int start, int end) Only the significant content of this sequence is considered.
String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_LINE_DELIMITER

public static final String DEFAULT_LINE_DELIMITER

The default line delimiter that is used by instances of StringConcatenation. It uses System.getProperty("line.separator").

Since:

2.3

Constructor Detail

StringConcatenation

public StringConcatenation()

Create a new concatenation that uses the system line delimiter.

See Also:

System.getProperties(), System.getProperty(String)

StringConcatenation

public StringConcatenation(String lineDelimiter)

Create a new concatenation with the specified delimiter.

Parameters:

lineDelimiter - the used delimiter.

Throws:

IllegalArgumentException - if the lineDelimiter is null or the empty String.

Since:

2.3

Method Detail

append

public void append(Object object)

Append the string representation of the given object to this sequence. Does nothing if the object is null.

Parameters:

object - the to-be-appended object.

append

protected void append(Object object,
          int index)

Add the string representation of the given object to this sequence at the given index. Does nothing if the object is null.

Parameters:

object - the to-be-appended object.

index - the index in the list of segments.

append

public void append(Object object,
          String indentation)

Add the string representation of the given object to this sequence. The given indentation will be prepended to each line except the first one if the object has a multi-line string representation.

Parameters:

object - the appended object.

indentation - the indentation string that should be prepended. May not be null.

append

protected void append(Object object,
          String indentation,
          int index)

Add the string representation of the given object to this sequence at the given index. The given indentation will be prepended to each line except the first one if the object has a multi-line string representation.

Parameters:

object - the to-be-appended object.

indentation - the indentation string that should be prepended. May not be null.

index - the index in the list of segments.

getStringRepresentation

protected String getStringRepresentation(Object object)

Computes the string representation of the given object. The default implementation will just invoke Object.toString() but clients may override and specialize the logic.

Parameters:

object - the object that shall be appended. Never null.

Returns:

the string representation. May not be null.

Since:

2.5

appendImmediate

public void appendImmediate(Object object,
                   String indentation)

Add the string representation of the given object to this sequence immediately. That is, all the trailing whitespace of this sequence will be ignored and the string is appended directly after the last segment that contains something besides whitespace. The given indentation will be prepended to each line except the first one if the object has a multi-line string representation.

Parameters:

object - the to-be-appended object.

indentation - the indentation string that should be prepended. May not be null.

appendSegments

protected void appendSegments(String indentation,
                  int index,
                  List<String> otherSegments,
                  String otherDelimiter)

Add the list of segments to this sequence at the given index. The given indentation will be prepended to each line except the first one if the object has a multi-line string representation.

Parameters:

indentation - the indentation string that should be prepended. May not be null.

index - the index in this instance's list of segments.

otherSegments - the to-be-appended segments. May not be null.

otherDelimiter - the line delimiter that was used in the otherSegments list.

appendSegments

protected void appendSegments(int index,
                  List<String> otherSegments,
                  String otherDelimiter)

Add the list of segments to this sequence at the given index. The given indentation will be prepended to each line except the first one if the object has a multi-line string representation.

Parameters:

index - the index in this instance's list of segments.

otherSegments - the to-be-appended segments. May not be null.

otherDelimiter - the line delimiter that was used in the otherSegments list.

Since:

2.5

appendSegments

protected void appendSegments(int index,
                  List<String> otherSegments)

Add the list of segments to this sequence at the given index. The given indentation will be prepended to each line except the first one if the object has a multi-line string representation.

Parameters:

index - the index in this instance's list of segments.

otherSegments - the to-be-appended segments. May not be null.

Since:

2.5

newLine

public void newLine()

Add a newline to this sequence according to the configured lineDelimiter.

newLineIfNotEmpty

public void newLineIfNotEmpty()

Add a newline to this sequence according to the configured lineDelimiter if the last line contains something besides whitespace.

toString

public String toString()

Specified by:

toString in interface CharSequence

Overrides:

toString in class Object

getContent

protected final List<String> getContent()

Return the actual content of this sequence, including all trailing whitespace. The return value is unsafe, that is modification to this StringConcatenation will cause changes in a previously obtained result and vice versa.

Returns:

the actual content of this instance. Never null.

Since:

2.8

getSignificantContent

protected List<String> getSignificantContent()

Compute the significant content of this sequence. That is, trailing whitespace after the last line-break will be ignored if the last line contains only whitespace. The return value is unsafe, that is modification to this StringConcatenation will cause changes in a previously obtained result and vice versa.

Returns:

the significant content of this instance. Never null.

getLineDelimiter

protected String getLineDelimiter()

Allows subtypes to access the configured line delimiter.

Returns:

the line delimiter

Since:

2.5

length

public int length()

Only the significant content of this sequence is considered.

Specified by:

length in interface CharSequence

charAt

public char charAt(int index)

Only the significant content of this sequence is considered.

Specified by:

charAt in interface CharSequence

subSequence

public CharSequence subSequence(int start,
                       int end)

Only the significant content of this sequence is considered.

Specified by:

subSequence in interface CharSequence

splitLinesAndNewLines

protected List<String> splitLinesAndNewLines(String text)

Return a list of segments where each segment is either the content of a line in the given text or a line-break according to the configured delimiter. Existing line-breaks in the text will be replaced by this's instances delimiter.

Parameters:

text - the to-be-splitted text. May be null.

Returns:

a list of segments. Is never null.