com.brentcroft.tools.materializer.core

Interface Tag<T,R>

Type Parameters:

T - a context object

R - a member to be constructed, modified and/or validated

All Known Subinterfaces:

FlatTag<T>, JumpTag<T,R>, StepTag<T,R>

All Known Implementing Classes:

PropertiesRootTag, SchemaRootTag

public interface Tag<T,R>

Constructs, modifies and/or validates a member of type R on some context object of type T.

A Tag may have child tags of Tag<? super R, ?>.

Method Summary

Modifier and Type	Method and Description
void	close(Object c, Object r, String text, Object cache) Called by TagHandler.endElement to consume text.
default Tag<? super R,?>[]	getChildren() Provide no children by default.
default Closer<T,R,String,?>	getCloser() Override to implement closing behaviour.
default EventMatcher	getElementMatcher() The default ElementMatcher matches if this tag is "*" or either of the localName or the qName equals this tag.
R	getItem(T t, OpenEvent openEvent) Obtains a member R from a context object T.
default Opener<T,R,OpenEvent,?>	getOpener() Override to implement opening behaviour.
String	getTag()
default TagModel<? super R>	getTagModel() Obtain a new TagModel on the children or return null if there are no children.
default java.util.function.BiConsumer<Tag<T,R>,R>	getValidator() Override to implement validation behaviour.
default boolean	isChoice() True if this Tag's children are choices (otherwise they're a sequence).
default boolean	isJump() True if this Tag aliases another Tag.
default boolean	isMultiple() True if this Tag is can be repeated.
default boolean	isOptional() True if this Tag is optional, and can be skipped if encountered unmatched.
default boolean	isStep() True if this Tag steps to another Tag (as implemented by getItem(context, event)).
default boolean	matches(OpenEvent openEvent) True if this Tag matches the supplied open element arguments.
String	name()
Object	open(Object c, Object r, OpenEvent event) Called by TagHandler.startElement to consume attributes.
static <X> Tag<? super X,?>[]	tags(Tag<? super X,?>... tags) Utility method to cast an argument list of Tags as an array.

Method Detail

tags

@SafeVarargs
static <X> Tag<? super X,?>[] tags(Tag<? super X,?>... tags)

Utility method to cast an argument list of Tags as an array.

Type Parameters:

X - a derived super type

Parameters:

tags - an argument list of Tags

Returns:

an array of Tags

getTag

String getTag()

name

String name()

getItem

R getItem(T t,
          OpenEvent openEvent)

Obtains a member R from a context object T.

NB: A FlatTag provides itself as the member.

Parameters:

t - a context object

openEvent - details of the event

Returns:

a member of the context object

open

Object open(Object c,
            Object r,
            OpenEvent event)

Called by TagHandler.startElement to consume attributes.

Parameters:

c - the context object

r - the object in context

event - details of the event

Returns:

an object to cache and pas to the closer

close

void close(Object c,
           Object r,
           String text,
           Object cache)

Called by TagHandler.endElement to consume text.

Parameters:

c - the context object

r - the object in context

text - the text read whilst open

cache - any object cached by the opener

getChildren

default Tag<? super R,?>[] getChildren()

Provide no children by default.

Returns:

null

getTagModel

default TagModel<? super R> getTagModel()

Obtain a new TagModel on the children or return null if there are no children.

Returns:

a new TagModel on the children or null

matches

default boolean matches(OpenEvent openEvent)

True if this Tag matches the supplied open element arguments.

Delegates to the assigned ElementMatcher.

Parameters:

openEvent - an OpenEvent

Returns:

true if this Tag matches the supplied OpenEvent

isChoice

default boolean isChoice()

True if this Tag's children are choices (otherwise they're a sequence).

Returns:

if this Tag's children are choices (otherwise they're a sequence)

isOptional

default boolean isOptional()

True if this Tag is optional, and can be skipped if encountered unmatched.

Returns:

true if this Tag is optional.

isMultiple

default boolean isMultiple()

True if this Tag is can be repeated.

Returns:

true if this Tag can be repeated.

isStep

default boolean isStep()

True if this Tag steps to another Tag (as implemented by getItem(context, event)).

Returns:

true if this Tag is a step.

isJump

default boolean isJump()

True if this Tag aliases another Tag.

Returns:

true if this Tag is a jump.

getElementMatcher

default EventMatcher getElementMatcher()

The default ElementMatcher matches if this tag is "*" or either of the localName or the qName equals this tag.

Returns:

the default ElementMatcher

getOpener

default Opener<T,R,OpenEvent,?> getOpener()

Override to implement opening behaviour.

Returns:

null

getCloser

default Closer<T,R,String,?> getCloser()

Override to implement closing behaviour.

Returns:

null

getValidator

default java.util.function.BiConsumer<Tag<T,R>,R> getValidator()

Override to implement validation behaviour.

Returns:

null