us.bpsm.edn.parser

Class Parsers

java.lang.Object

us.bpsm.edn.parser.Parsers

public class Parsers
extends Object

Factory methods for all things related to Parser. Typical usage is as follows:

1. Ask newParserConfigBuilder() for a new Parser.Config.Builder.
2. Make any desired customizations. Primarily, this will mean using Parser.Config.Builder.putTagHandler(Tag, TagHandler) to register TagHandlers for any custom Tags used by your expected input documents.
3. Pass the resulting Parser.Config to newParser(Parser.Config) to create a Parser.
4. Create one or more Parseables using newParseable(CharSequence) or newParseable(Readable).
5. Use Parser.nextValue(Parseable) to get the edn values contained in your Parseable

Method Summary

Methods

Modifier and Type	Method and Description
static Parser.Config	defaultConfiguration() Return the default configuration.
static Parseable	newParseable(CharSequence cs) Create a new Parseable wrapping the given CharSequence.
static Parseable	newParseable(Readable r) Create a new Parseable wrapping the given Readable.
static Parser	newParser(Parser.Config cfg) Return a Parser configured by the given Parser.Config.
static Parser.Config.Builder	newParserConfigBuilder() Return a new Parser.Config.Builder.

Methods inherited from class java.lang.Object

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

Method Detail

newParser

public static Parser newParser(Parser.Config cfg)

Return a Parser configured by the given Parser.Config.

Parameters:

cfg - The configuration of the Parser. Must not be null.

Returns:

a Parser, never null.

newParseable

public static Parseable newParseable(CharSequence cs)

Create a new Parseable wrapping the given CharSequence.

The Closeable.close() method of the resulting Parseable is a no-op.

Parameters:

cs - must not be null.

Returns:

a Parseable, never null.

newParseable

public static Parseable newParseable(Readable r)

Create a new Parseable wrapping the given Readable.

The Closeable.close() method of the resulting Parseable closes the r if r is itself Closable.

Parameters:

r - a Readable which must not be null.

Returns:

a Parseable over the given Readable.

newParserConfigBuilder

public static Parser.Config.Builder newParserConfigBuilder()

Return a new Parser.Config.Builder.

Returns:

a new Parser.Config.Builder, never null.

defaultConfiguration

public static Parser.Config defaultConfiguration()

Return the default configuration. This is equivalent to newParserConfigBuilder().build().

Returns:

a new Parser.Config, never null.