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>, 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 o, String text, Object cache) Called by TagHandler.endElement to consume text.
static Map<String,String>	getAttributesMap(Attributes attributes) Utility method to convert Attributes to a Map.
default Tag<? super R,?>[]	getChildren() Provide no children by default.
default Closer<R,String,?>	getCloser() Override to implement closing behaviour.
R	getItem(T t) Obtains a member R from a context object T.
default Opener<R,Attributes,?>	getOpener() Override to implement opening behaviour.
Tag<T,R>	getSelf() Enforce implementation of a self member.
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	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	matches(String uri, String localName, String qName, Attributes attributes) True if this Tag matches the supplied open element arguments.
Object	open(Object o, Attributes attributes) 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

getTag

String getTag()

getItem

R getItem(T t)

Obtains a member R from a context object T.

NB: A FlatTag provides itself as the member.

Parameters:

t - a context object

Returns:

a member of the context object

getSelf

Tag<T,R> getSelf()

Enforce implementation of a self member.

Returns:

the instantiation of this Tag.

open

Object open(Object o,
            Attributes attributes)

Called by TagHandler.startElement to consume attributes.

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

getAttributesMap

static Map<String,String> getAttributesMap(Attributes attributes)

Utility method to convert Attributes to a Map.

Parameters:

attributes - XML attributes

Returns:

a map of the attributes

close

void close(Object o,
           String text,
           Object cache)

Called by TagHandler.endElement to consume text.

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(String uri,
                        String localName,
                        String qName,
                        Attributes attributes)

True if this Tag matches the supplied open element arguments.

Default is true if localName equals the tag value or the tag value equals "*".

Parameters:

uri - a namespace uri

localName - a local tag name

qName - a qualified tag name

attributes - SAX attributes

Returns:

true if this Tag matches the supplied open element arguments

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.

getOpener

default Opener<R,Attributes,?> getOpener()

Override to implement opening behaviour.

Returns:

null

getCloser

default Closer<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