io.doov.core.dsl.meta

Interface Metadata

All Superinterfaces:

Readable, SyntaxTree

All Known Implementing Classes:

BinaryMetadata, ConverterMetadata, EmptyMetadata, LeafMetadata, MappingMetadata, NaryMetadata, PredicateMetadata, UnaryMetadata

public interface Metadata
extends SyntaxTree

Interface for the description of a node in the syntax tree.

Method Summary

Modifier and Type	Method and Description
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.
default PredicateMetadata	merge(LeafMetadata other) Merges the node with the given node.
Metadata	message(Context context) Returns the failure message from the given context.
MetadataType	type() Returns the metadata type.

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

accept, markdown, markdown, readable, readable

Method Detail

merge

default PredicateMetadata merge(LeafMetadata other)

Merges the node with the given node.

Parameters:

other - the other metadata to merge

Returns:

the merged metadata

flatten

java.util.List<Element> flatten()

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

Returns:

the list of elements

children

java.util.List<Metadata> children()

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

Returns:

the list of metadata

type

MetadataType type()

Returns the metadata type.

Returns:

the type

message

Metadata message(Context context)

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.

Parameters:

context - the evaluated context

Returns:

the metadata