Class SchemaGenerator

java.lang.Object

com.github.darksoulq.abyssallib.common.serialization.schema.SchemaGenerator

All Implemented Interfaces:

CodecVisitor<SchemaNode>

public class SchemaGenerator
extends Object
implements CodecVisitor<SchemaNode>

Generates schema representations from codec definitions.

Constructor Summary

Constructors

Constructor	Description
SchemaGenerator()

Method Summary

Modifier and Type	Method	Description
static SchemaNode	generate(Codec<?> codec)	Generates a schema from the supplied codec.
SchemaNode	visitCustom(SchemaNode customSchema)	Visits a predefined explicit custom schema representation.
SchemaNode	visitDispatch(String discriminator)	Visits a dispatch codec.
SchemaNode	visitEither(Codec<?> left, Codec<?> right)	Visits a codec representing one of two possible types.
SchemaNode	visitEnum(Class<? extends Enum<?>> enumClass)	Visits an enum codec.
SchemaNode	visitList(Codec<?> elementCodec)	Visits a list codec.
SchemaNode	visitMap(Codec<?> keyCodec, Codec<?> valueCodec)	Visits a map codec.
SchemaNode	visitOneOf(List<Codec<?>> codecs)	Visits a codec that may match one of several alternatives.
SchemaNode	visitOptional(Codec<?> wrapped)	Visits an optional codec.
SchemaNode	visitPrimitive(String type)	Visits a primitive codec type.
SchemaNode	visitRecord(Iterable<RecordField<?,?>> fields)	Visits a record codec structurally mapped from field parameters.
SchemaNode	visitTuple(List<Codec<?>> codecs)	Visits a codec representing a fixed ordered sequence of values.
SchemaNode	visitUnknown(String description)	Visits an unknown or unsupported codec type.

Methods inherited from class Object

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

Constructor Details

SchemaGenerator

public SchemaGenerator()

Method Details

generate

public static SchemaNode generate(Codec<?> codec)

Generates a schema from the supplied codec.

Parameters:

codec - root codec

Returns:

generated schema

visitPrimitive

public SchemaNode visitPrimitive(String type)

Description copied from interface: CodecVisitor

Visits a primitive codec type.

Specified by:

visitPrimitive in interface CodecVisitor<SchemaNode>

Parameters:

type - primitive type identifier

Returns:

visitor result

visitRecord

public SchemaNode visitRecord(Iterable<RecordField<?,?>> fields)

Description copied from interface: CodecVisitor

Visits a record codec structurally mapped from field parameters.

Specified by:

visitRecord in interface CodecVisitor<SchemaNode>

Parameters:

fields - the iterable structure of fields mapped to the record

Returns:

visitor result

visitList

public SchemaNode visitList(Codec<?> elementCodec)

Description copied from interface: CodecVisitor

Visits a list codec.

Specified by:

visitList in interface CodecVisitor<SchemaNode>

Parameters:

elementCodec - codec describing list elements

Returns:

visitor result

visitMap

public SchemaNode visitMap(Codec<?> keyCodec,
 Codec<?> valueCodec)

Description copied from interface: CodecVisitor

Visits a map codec.

Specified by:

visitMap in interface CodecVisitor<SchemaNode>

Parameters:

keyCodec - codec describing map keys

valueCodec - codec describing map values

Returns:

visitor result

visitEnum

public SchemaNode visitEnum(Class<? extends Enum<?>> enumClass)

Description copied from interface: CodecVisitor

Visits an enum codec.

Specified by:

visitEnum in interface CodecVisitor<SchemaNode>

Parameters:

enumClass - enum type represented by the codec

Returns:

visitor result

visitOptional

public SchemaNode visitOptional(Codec<?> wrapped)

Description copied from interface: CodecVisitor

Visits an optional codec.

Specified by:

visitOptional in interface CodecVisitor<SchemaNode>

Parameters:

wrapped - wrapped codec

Returns:

visitor result

visitEither

public SchemaNode visitEither(Codec<?> left,
 Codec<?> right)

Description copied from interface: CodecVisitor

Visits a codec representing one of two possible types.

Specified by:

visitEither in interface CodecVisitor<SchemaNode>

Parameters:

left - left codec

right - right codec

Returns:

visitor result

visitDispatch

public SchemaNode visitDispatch(String discriminator)

Description copied from interface: CodecVisitor

Visits a dispatch codec.

Specified by:

visitDispatch in interface CodecVisitor<SchemaNode>

Parameters:

discriminator - field used to determine the target variant

Returns:

visitor result

visitOneOf

public SchemaNode visitOneOf(List<Codec<?>> codecs)

Description copied from interface: CodecVisitor

Visits a codec that may match one of several alternatives.

Specified by:

visitOneOf in interface CodecVisitor<SchemaNode>

Parameters:

codecs - alternative codecs

Returns:

visitor result

visitTuple

public SchemaNode visitTuple(List<Codec<?>> codecs)

Description copied from interface: CodecVisitor

Visits a codec representing a fixed ordered sequence of values.

Specified by:

visitTuple in interface CodecVisitor<SchemaNode>

Parameters:

codecs - codecs describing tuple elements

Returns:

visitor result

visitUnknown

public SchemaNode visitUnknown(String description)

Description copied from interface: CodecVisitor

Visits an unknown or unsupported codec type.

Specified by:

visitUnknown in interface CodecVisitor<SchemaNode>

Parameters:

description - description of the codec

Returns:

visitor result

visitCustom

public SchemaNode visitCustom(SchemaNode customSchema)

Description copied from interface: CodecVisitor

Visits a predefined explicit custom schema representation.

Specified by:

visitCustom in interface CodecVisitor<SchemaNode>

Parameters:

customSchema - explicitly defined custom schema node

Returns:

visitor result