us.bpsm.edn.parser

Interface Parser

public interface Parser

A Parser knows how to parse edn values from any Parseable. Instances are constructed using factory methods in Parsers.

Any Parser can be shared freely between threads because Parsers are all immutable and therad-safe.

See Also:

Parsers

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	Parser.Config Config describes the complete configuration of a Parser.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.Object	END_OF_INPUT The value returned by nextValue(Parseable) to indicate that no more values will can be parsed form the a given Parseable.

Method Summary

Modifier and Type	Method and Description
java.lang.Object	nextValue(Parseable pbr) Return the next value parsed from pbr.

Field Detail

END_OF_INPUT

static final java.lang.Object END_OF_INPUT

The value returned by nextValue(Parseable) to indicate that no more values will can be parsed form the a given Parseable.

Method Detail

nextValue

java.lang.Object nextValue(Parseable pbr)

Return the next value parsed from pbr. Calling nextValue on a Parser created with the default configuration can return any of the following:

• A String with the contents of a string literal.
• A Character for a character literal.
• A Long for an integer small enough to fit in its range and not marked by a trailing 'N'.
• A BigInteger for an integer too large to fit in a Long or marked by a trailing 'N'.
• A Double for a binary floating point literal
• A BigDecimal for an arbitrary precision decimal floating point literal, which is indicated by a trailing 'M' in edn.
• A Symbol for an edn symbol. ('nil', 'true' and 'false' are not symbols.)
• A Boolean for a 'true' or 'false'.
• A null for a 'nil'.
• A Keyword for an edn keyword, which looks like :somename.
• The value END_OF_INPUT to indicate that no more values can be parsed form pbr.
• A List for an edn list.
• A List implementing RandomAccess for an edn vector.
• A Set for an edn set.
• A Map for an edn map.
• A Date for an instant literal.
• A UUID for an uuid literal.

Returns:

some Object or null.

Throws:

EdnIOException - if the underlying Parseable throws an IOException.

EdnSyntaxException - if the contents of the underlying Parseable violates the syntax of edn.