water.api

Class SchemaMetadata

java.lang.Object

water.Iced

water.api.SchemaMetadata

All Implemented Interfaces:

java.io.Externalizable, java.io.Serializable, java.lang.Cloneable, Freezable

public final class SchemaMetadata
extends Iced

The metadata info on all the fields in a Schema. This is used to help Schema be self-documenting, and to generate language bindings for route handlers and entities.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	SchemaMetadata.FieldMetadata

Field Summary

Fields

Modifier and Type	Field and Description
java.util.List<SchemaMetadata.FieldMetadata>	fields
java.lang.String	markdown
java.lang.String	name
java.lang.String	superclass
java.lang.String	type
int	version

Constructor Summary

Constructors

Constructor and Description
SchemaMetadata()
SchemaMetadata(Schema schema)

Method Summary

Modifier and Type	Method and Description
static SchemaMetadata	createSchemaMetadata(java.lang.String classname)
static java.util.List<SchemaMetadata.FieldMetadata>	getFieldMetadata(Schema schema) Returns metadata of all annotated fields.

Methods inherited from class water.Iced

asBytes, clone, copyOver, frozenType, read, readExternal, readJSON, reloadFromBytes, toJsonString, write, writeExternal, writeJSON

Methods inherited from class java.lang.Object

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

Field Detail

version

public int version

name

public java.lang.String name

superclass

public java.lang.String superclass

type

public java.lang.String type

fields

public java.util.List<SchemaMetadata.FieldMetadata> fields

markdown

public java.lang.String markdown

Constructor Detail

SchemaMetadata

public SchemaMetadata()

SchemaMetadata

public SchemaMetadata(Schema schema)

Method Detail

getFieldMetadata

public static java.util.List<SchemaMetadata.FieldMetadata> getFieldMetadata(Schema schema)

Returns metadata of all annotated fields.

Parameters:

schema - a schema instance

Returns:

list of field metadata

createSchemaMetadata

public static SchemaMetadata createSchemaMetadata(java.lang.String classname)
                                           throws java.lang.IllegalArgumentException

Throws:

java.lang.IllegalArgumentException