js.lang

Class PairsList

java.lang.Object

js.lang.PairsList

All Implemented Interfaces:

Iterable<Pair>

public class PairsList
extends Object
implements Iterable<Pair>

Immutable list of string pairs. Instances of this list are constructed from a string expression. Given expression should be a list of semicolon separated pairs, every pair consisting of two values separated by separator. Pairs order from expression is preserved.

Here is supported pairs list syntax. Please note that final semicolon is optional.

    expression = pair *( ";" pair ) [ ";" ]
    pair = first SEP second
    first = string
    second = string
    
    ; separator for pair components 
    SEP = ":" / "="
    
    ; string is any character less semicolon and separators
    ; colon is default separator
 

Version:

final

Author:

Iulian Rotaru

Field Summary

Fields

Modifier and Type	Field and Description
private static char	DEFAULT_SEPARATOR Default pair separator.
private List<Pair>	pairs Underlying pairs storage.

Constructor Summary

Constructors

Constructor and Description
PairsList(String expression) Convenient constructor using default separator.
PairsList(String expression, char separator) Parse expression and extract a list of pairs of string values.

Method Summary

Modifier and Type	Method and Description
Iterator<Pair>	iterator() Returns an iterator for this pairs list instance.

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Field Detail

DEFAULT_SEPARATOR

private static final char DEFAULT_SEPARATOR

Default pair separator.

See Also:

Constant Field Values

pairs

private final List<Pair> pairs

Underlying pairs storage.

Constructor Detail

PairsList

public PairsList(String expression)
          throws SyntaxException

Convenient constructor using default separator.

Parameters:

expression - expression to parse.

Throws:

SyntaxException - if expression is not well formed or on duplicated pairs.

PairsList

public PairsList(String expression,
                 char separator)
          throws SyntaxException

Parse expression and extract a list of pairs of string values. See this class description for expression syntax. Please note that expression values should not contain semicolon used for pairs separation or used values separator.

Parameters:

expression - expression to parse,

separator - separator character.

Throws:

SyntaxException - if expression is not well formed or on duplicated pairs.

Method Detail

iterator

public Iterator<Pair> iterator()

Returns an iterator for this pairs list instance.

Specified by:

iterator in interface Iterable<Pair>

Returns:

pairs iterator.