com.github.mangstadt.vinnie.io

Class VObjectPropertyValues.StructuredValueBuilder

java.lang.Object

com.github.mangstadt.vinnie.io.VObjectPropertyValues.StructuredValueBuilder

Enclosing class:

VObjectPropertyValues

public static class VObjectPropertyValues.StructuredValueBuilder
extends Object

Helper class for building "structured" property values.

Structured values are essentially 2-D arrays. They contain multiple components separated by semicolons, and each component can have multiple values separated by commas. The order that the components are in matters, but the order that each component's list of values are in usually doesn't matter.

Example:

 StructuredValueBuilder b = new StructuredValueBuilder();
 b.append("one").append(Arrays.asList("two", "three")).append("");
 assertEquals("one;two,three;", b.build());
 assertEquals("one;two,three", b.build(false));
 

Constructor Summary

Constructors

Constructor and Description
StructuredValueBuilder()

Method Summary

Modifier and Type	Method and Description
VObjectPropertyValues.StructuredValueBuilder	append(List<?> component) Appends a component.
VObjectPropertyValues.StructuredValueBuilder	append(Object value) Appends a single-valued component.
String	build() Builds the structured value string.
String	build(boolean includeTrailingSemicolons) Builds the structured value string.

Methods inherited from class java.lang.Object

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

Constructor Detail

StructuredValueBuilder

public StructuredValueBuilder()

Method Detail

append

public VObjectPropertyValues.StructuredValueBuilder append(Object value)

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

Parameters:

value - the value

Returns:

this

append

public VObjectPropertyValues.StructuredValueBuilder append(List<?> component)

Appends a component. The toString() method of each component value will be called to generate its string representation. If a value is null, then "null" will be outputted.

Parameters:

component - the component

Returns:

this

build

public String build()

Builds the structured value string. Trailing semicolon delimiters will not be trimmed.

Returns:

the structured value string

build

public String build(boolean includeTrailingSemicolons)

Builds the structured value string.

Parameters:

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

Returns:

the structured value string