com.moz.fiji.avro.dsl

Interface AvroDSLInterface

public interface AvroDSLInterface

Java interface to the Avro DSL parser. This class is implemented by JavaAvroDSL.

Method Summary

Modifier and Type	Method and Description
org.apache.avro.Schema	parseSchema(String text) Parse a text IDL declaration for a single Avro type.
List<org.apache.avro.Schema>	parseSchemaSequence(String text) Parse a text IDL declaration for a sequence of Avro types.
<T> T	parseValue(String text, org.apache.avro.Schema schema) Parse an Avro value from its DSL string representation.
String	schemaToString(org.apache.avro.Schema schema) Serializes an Avro schema back to its DSL string representation.
<T> String	valueToString(T value, org.apache.avro.Schema schema) Serializes an Avro value to back to its DSL string representation.

Method Detail

parseSchema

org.apache.avro.Schema parseSchema(String text)

Parse a text IDL declaration for a single Avro type.

Parameters:

text - IDL definition to parse into an Avro schema.

Returns:

the Avro schema parsed from the IDL definition.

parseSchemaSequence

List<org.apache.avro.Schema> parseSchemaSequence(String text)

Parse a text IDL declaration for a sequence of Avro types.

Parameters:

text - IDL definition to parse into a sequence of Avro schemas.

Returns:

the Avro schema sequence parsed from the IDL definition.

schemaToString

String schemaToString(org.apache.avro.Schema schema)

Serializes an Avro schema back to its DSL string representation.

Parameters:

schema - Avro schema to represent as a DSL Avro schema definition.

Returns:

the DSL text representation of the given Avro schema.

parseValue

<T> T parseValue(String text,
                 org.apache.avro.Schema schema)

Parse an Avro value from its DSL string representation.

Type Parameters:

T - is the value type to return.

Parameters:

text - Text DSL representation of an Avro value.

schema - Avro schema of the value to parse.

Returns:

the Avro value parsed from the text representation.

valueToString

<T> String valueToString(T value,
                         org.apache.avro.Schema schema)

Serializes an Avro value to back to its DSL string representation.

Type Parameters:

T - is the value type to return.

Parameters:

value - Avro value to serialize.

schema - Avro schema of the value to serialize.

Returns:

the DSL string representation of the Avro value.