Package de.espirit.firstspirit.access.store.templatestore.gom.lists

Class GomTypeRestrictedTemplates

java.lang.Object

java.util.AbstractCollection<E>

java.util.AbstractList<E>

java.util.ArrayList<T>

de.espirit.firstspirit.access.store.templatestore.gom.AbstractGomList<GomUidEntry>

de.espirit.firstspirit.access.store.templatestore.gom.lists.GomTypeRestrictedTemplates

All Implemented Interfaces:

GomCheckable, GomElement, GomList<GomUidEntry>, GomUidTypeProviding, Serializable, Cloneable, Iterable<GomUidEntry>, Collection<GomUidEntry>, List<GomUidEntry>, RandomAccess

public final class GomTypeRestrictedTemplates
extends AbstractGomList<GomUidEntry>
implements GomCheckable, GomUidTypeProviding

Template restriction definition container for list components.

Since:

5.2.6

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	GomTypeRestrictedTemplates.TemplateType	Types of templates.

Nested classes/interfaces inherited from interface de.espirit.firstspirit.access.store.templatestore.gom.GomCheckable

GomCheckable.Context

Field Summary

Fields

Modifier and Type	Field	Description
static final String	ENTRY_TAG	The single template entry tag.
static final String	TAG	The standard templates tag.

Fields inherited from class java.util.AbstractList

modCount

Constructor Summary

Constructors

Constructor	Description
GomTypeRestrictedTemplates()

Method Summary

Modifier and Type	Method	Description
Set<String>	asNameSet()	Convenience method providing defined templates as set of uids.
protected String	getDefaultTag()	Returns the default tag name of the component.
Map<String,Class<? extends GomElement>>	getGomElementMappings()	Get a list of mappings from tag name to class supported by this list.
GomTypeRestrictedTemplates.TemplateType	getType()	Provides the type of templates allowed.
IDProvider.UidType	getUidType()	The IDProvider.UidType of the references contained.
void	setType(GomTypeRestrictedTemplates.TemplateType type)	Set the type of allowed templates.
String	toString()
void	validate(GomCheckable.Context context)	Validate the element against the given context.
void	verify()	Check if the list is marked as mandatory (not inherited!)

Methods inherited from class de.espirit.firstspirit.access.store.templatestore.gom.AbstractGomList

getGomElementTag, getIncludeConfiguration, hasRepresentation, setGomElementTag, setIncludeConfiguration

Methods inherited from class java.util.ArrayList

add, add, addAll, addAll, clear, clone, contains, ensureCapacity, equals, forEach, get, hashCode, indexOf, isEmpty, iterator, lastIndexOf, listIterator, listIterator, remove, remove, removeAll, removeIf, removeRange, replaceAll, retainAll, set, size, sort, spliterator, subList, toArray, toArray, trimToSize

Methods inherited from class java.util.AbstractCollection

containsAll

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.Collection

parallelStream, removeIf, stream, toArray

Methods inherited from interface java.lang.Iterable

forEach

Methods inherited from interface java.util.List

add, add, addAll, addAll, clear, contains, containsAll, equals, get, hashCode, indexOf, isEmpty, iterator, lastIndexOf, listIterator, listIterator, remove, remove, removeAll, replaceAll, retainAll, set, size, sort, spliterator, subList, toArray, toArray

Field Details

TAG

public static final String TAG

The standard templates tag.

Since:

5.2.6

See Also:

• Constant Field Values

ENTRY_TAG

public static final String ENTRY_TAG

The single template entry tag.

Since:

5.2.6

See Also:

• Constant Field Values

Constructor Details

GomTypeRestrictedTemplates

public GomTypeRestrictedTemplates()

Method Details

getDefaultTag

protected String getDefaultTag()

Returns the default tag name of the component.

Specified by:

getDefaultTag in class AbstractGomList<GomUidEntry>

Since:

5.2.6

getGomElementMappings

public Map<String,Class<? extends GomElement>> getGomElementMappings()

Get a list of mappings from tag name to class supported by this list.

Convention:

The mapping shall only be created on demand and not change at runtime.

Specified by:

getGomElementMappings in interface GomList<GomUidEntry>

Overrides:

getGomElementMappings in class AbstractGomList<GomUidEntry>

Returns:

The list of child tags.

Since:

5.2.6

getType

public GomTypeRestrictedTemplates.TemplateType getType()

Provides the type of templates allowed.

Returns:

The type of templates.

Since:

5.2.6

getUidType

@Nullable
public IDProvider.UidType getUidType()

Description copied from interface: GomUidTypeProviding

The IDProvider.UidType of the references contained.

Specified by:

getUidType in interface GomUidTypeProviding

Returns:

The associated uid type.

setType

public void setType(GomTypeRestrictedTemplates.TemplateType type)

Set the type of allowed templates.

Parameters:

type - The type.

Since:

5.2.6

asNameSet

public Set<String> asNameSet()

Convenience method providing defined templates as set of uids.

Returns:

A set of uids.

Since:

5.2.6

verify

public void verify()
            throws IllegalStateException

Check if the list is marked as mandatory (not inherited!) and not empty

Specified by:

verify in interface GomCheckable

Overrides:

verify in class AbstractGomList<GomUidEntry>

Throws:

IllegalStateException - If the element is not correctly set up.

Since:

5.2.6

validate

public void validate(GomCheckable.Context context)
              throws GomValidationError

Validate the element against the given context.

Specified by:

validate in interface GomCheckable

Parameters:

context - The context to validate for, must not be null.

Throws:

GomValidationError - If the element is not plausible wrt. its context.

Since:

5.2.6

toString

public String toString()

Overrides:

toString in class AbstractCollection<GomUidEntry>

Since:

5.2.6