com.github.mangstadt.vinnie.io

Class VObjectPropertyValues.StructuredValueIterator

java.lang.Object

com.github.mangstadt.vinnie.io.VObjectPropertyValues.StructuredValueIterator

Enclosing class:

VObjectPropertyValues

public static class VObjectPropertyValues.StructuredValueIterator
extends Object

Helper class for iterating over the values in a "structured" property value.

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:

 String value = "one;two,three;;;four";
 StructuredValueIterator it = new StructuredValueIterator(value);
 
 assertEquals(Arrays.asList("one"), it.nextComponent());
 assertEquals(Arrays.asList("two", "three"), it.nextComponent());
 assertEquals(Arrays.asList(), it.nextComponent());
 assertNull(it.nextValue());
 assertEquals("four", it.nextValue());
 assertFalse(it.hasNext());
 

Constructor Summary

Constructors

Constructor and Description
StructuredValueIterator(List<List<String>> components) Constructs a new structured value iterator.
StructuredValueIterator(String string) Constructs a new structured value iterator.

Method Summary

Modifier and Type	Method and Description
boolean	hasNext()
List<String>	nextComponent() Gets the next component.
String	nextValue() Gets the first value of the next component.

Methods inherited from class java.lang.Object

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

Constructor Detail

StructuredValueIterator

public StructuredValueIterator(String string)

Constructs a new structured value iterator.

Parameters:

string - the structured value to parse

StructuredValueIterator

public StructuredValueIterator(List<List<String>> components)

Constructs a new structured value iterator.

Parameters:

components - the components to iterator over

Method Detail

nextValue

public String nextValue()

Gets the first value of the next component.

Returns:

the value or null if the component is empty or null if there are no more components

nextComponent

public List<String> nextComponent()

Gets the next component.

Returns:

the next component or an empty list if there are no more components

hasNext

public boolean hasNext()