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

Class AbstractGomList<T extends GomElement>

java.lang.Object

java.util.AbstractCollection<E>

java.util.AbstractList<E>

java.util.ArrayList<T>

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

All Implemented Interfaces:

GomElement, GomList<T>, Serializable, Cloneable, Iterable<T>, Collection<T>, List<T>, RandomAccess

Direct Known Subclasses:

AbstractGomProjectList, DefaultGomEntryList, DefaultGomLangInfos, GomActivityEntries, GomButton.GomDropTypes, GomButton.GomParams, GomContentReferenceList, GomFilterList, GomFormatReferenceList, GomIncludeContent, GomLabelExpressions, GomLinkEditorList, GomMediaStoreFolderList, GomQuery, GomScriptButtons, GomSiteOrMediaStoreFolderList, GomStoreFolderList, GomTableViews, GomTemplateReferenceList, GomTypeRestrictedTemplates, GomVariableList

public abstract class AbstractGomList<T extends GomElement>
extends ArrayList<T>
implements GomList<T>

Abstract implementation of a GOM list.

Since:

5.2.210803

See Also:

• Serialized Form

Field Summary

Fields inherited from class java.util.AbstractList

modCount

Constructor Summary

Constructors

Constructor	Description
AbstractGomList()	Constructs an abstract gom list.

Method Summary

Modifier and Type	Method	Description
protected abstract 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.
String	getGomElementTag()	Get the tag name, the instance was produced for.
GomIncludeConfiguration	getIncludeConfiguration()	Get the configuration, if this is an included element.
boolean	hasRepresentation()	Indicates, that the element has a representation to be displayed in a form. A representation usually corresponds to a registered editor component.
void	setGomElementTag(@NotNull String name)	Sets the tag name, the instance gets produced for.
void	setIncludeConfiguration(GomIncludeConfiguration includeConfiguration)	Set the configuration for an included element.
void	verify()	Check if the list is marked as mandatory (not inherited!)

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, toString

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

Constructor Details

AbstractGomList

public AbstractGomList()

Constructs an abstract gom list.

Since:

5.2.210803

Method Details

hasRepresentation

public boolean hasRepresentation()

Indicates, that the element has a representation to be displayed in a form.
A representation usually corresponds to a registered editor component.

Specified by:

hasRepresentation in interface GomElement

Returns:

true, if a representation is available.

Since:

5.2.210803

getDefaultTag

protected abstract String getDefaultTag()

Returns the default tag name of the component.

Since:

5.2.210803

getGomElementTag

public String getGomElementTag()

Description copied from interface: GomElement

Get the tag name, the instance was produced for.

Specified by:

getGomElementTag in interface GomElement

Returns:

The name of the tag.

setGomElementTag

public void setGomElementTag(@NotNull
 @NotNull String name)

Description copied from interface: GomElement

Sets the tag name, the instance gets produced for.

Specified by:

setGomElementTag in interface GomElement

Parameters:

name - The name of the tag.

getIncludeConfiguration

public GomIncludeConfiguration getIncludeConfiguration()

Description copied from interface: GomElement

Get the configuration, if this is an included element.

Specified by:

getIncludeConfiguration in interface GomElement

Returns:

The configuration for including the element.

setIncludeConfiguration

public void setIncludeConfiguration(GomIncludeConfiguration includeConfiguration)

Description copied from interface: GomElement

Set the configuration for an included element.

Specified by:

setIncludeConfiguration in interface GomElement

Parameters:

includeConfiguration - The configuration to set.

getGomElementMappings

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

Description copied from interface: GomList

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<T extends GomElement>

Returns:

The list of child tags.

verify

public void verify()
            throws IllegalStateException

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

Throws:

IllegalStateException

Since:

5.2.210803