com.github.mangstadt.vinnie.io

Class VObjectPropertyValues.SemiStructuredValueBuilder

java.lang.Object

com.github.mangstadt.vinnie.io.VObjectPropertyValues.SemiStructuredValueBuilder

Enclosing class:

VObjectPropertyValues

public static class VObjectPropertyValues.SemiStructuredValueBuilder
extends Object

Helper class for building "semi-structured" property values.

Semi-structured values contain multiple values separate by semicolons. Unlike structured values, each value cannot have their own comma-delimited list of sub-values. The order that the values are in usually matters.

Example:

 SemiStructuredValueBuilder b = new SemiStructuredValueBuilder();
 b.append("one").append(null).append("two").append("");
 assertEquals("one;;two;", b.build());
 assertEquals("one;;two", b.build(false));
 

Constructor Summary

Constructors

Constructor and Description
SemiStructuredValueBuilder()

Method Summary

Modifier and Type	Method and Description
VObjectPropertyValues.SemiStructuredValueBuilder	append(Object value) Appends a value to the semi-structured value.
String	build(boolean escapeCommas, boolean includeTrailingSemicolons) Builds the semi-structured value string.

Methods inherited from class java.lang.Object

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

Constructor Detail

SemiStructuredValueBuilder

public SemiStructuredValueBuilder()

Method Detail

append

public VObjectPropertyValues.SemiStructuredValueBuilder append(Object value)

Appends a value to the semi-structured value. The value's toString() method will be called to generate its string representation. If the value is null, then an empty string will be appended.

Parameters:

value - the value

Returns:

this

build

public String build(boolean escapeCommas,
                    boolean includeTrailingSemicolons)

Builds the semi-structured value string.

Parameters:

escapeCommas - true to escape comma characters, false not to. Old-style syntax does not expect commas to be escaped in semi-structured values.

includeTrailingSemicolons - true to include the semicolon delimiters of empty values at the end of the value string, false to trim them

Returns:

the semi-structured value string