io.doov.core.dsl.meta

Class ConverterMetadata

java.lang.Object

io.doov.core.dsl.meta.ConverterMetadata

All Implemented Interfaces:

Readable, Metadata, SyntaxTree

public class ConverterMetadata
extends java.lang.Object
implements Metadata

Constructor Summary

Constructors

Constructor and Description
ConverterMetadata(Element element, MetadataType type)

Method Summary

Modifier and Type	Method and Description
void	accept(MetadataVisitor visitor, int depth)
java.util.List<Metadata>	children() Returns the direct children of this node in a flat list.
java.util.List<Element>	flatten() Returns the tree of elements under this node in a flat list.
static ConverterMetadata	identity()
Metadata	message(Context context) Returns the failure message from the given context.
static ConverterMetadata	metadata(java.lang.String description)
java.lang.String	readable(java.util.Locale locale) Returns the human readable version of this object.
MetadataType	type() Returns the metadata type.

Methods inherited from class java.lang.Object

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

Methods inherited from interface io.doov.core.dsl.meta.Metadata

merge

Methods inherited from interface io.doov.core.dsl.meta.SyntaxTree

markdown, markdown, readable

Constructor Detail

ConverterMetadata

public ConverterMetadata(Element element,
                         MetadataType type)

Method Detail

metadata

public static ConverterMetadata metadata(java.lang.String description)

identity

public static ConverterMetadata identity()

accept

public void accept(MetadataVisitor visitor,
                   int depth)

Specified by:

accept in interface SyntaxTree

flatten

public java.util.List<Element> flatten()

Description copied from interface: Metadata

Returns the tree of elements under this node in a flat list.

Specified by:

flatten in interface Metadata

Returns:

the list of elements

children

public java.util.List<Metadata> children()

Description copied from interface: Metadata

Returns the direct children of this node in a flat list.

Specified by:

children in interface Metadata

Returns:

the list of metadata

readable

public java.lang.String readable(java.util.Locale locale)

Description copied from interface: SyntaxTree

Returns the human readable version of this object.

Specified by:

readable in interface SyntaxTree

Parameters:

locale - the locale to use

Returns:

the readable string

See Also:

SyntaxTree.readable()

type

public MetadataType type()

Description copied from interface: Metadata

Returns the metadata type.

Specified by:

type in interface Metadata

Returns:

the type

message

public Metadata message(Context context)

Description copied from interface: Metadata

Returns the failure message from the given context. The message is returned in its shortest form by pruning branches in the evaluated syntax tree that are not needed for the failure message.

Specified by:

message in interface Metadata

Parameters:

context - the evaluated context

Returns:

the metadata