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

Class GomFilterList

java.lang.Object

java.util.AbstractCollection<E>

java.util.AbstractList<E>

java.util.ArrayList<T>

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

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

All Implemented Interfaces:

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

@NonExtendable
public class GomFilterList
extends AbstractGomList<GomFilterEntry>

GOM representation of a list of filters

Since:

4.2.9

See Also:

• Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
static final String	ENTRY_TAG_ALLOW	The tag for allowed entries
static final String	ENTRY_TAG_HIDE	The tag for hidden entries
static final String	TAG	The tag of this component

Fields inherited from class java.util.AbstractList

modCount

Constructor Summary

Constructors

Constructor	Description
GomFilterList()

Method Summary

Modifier and Type	Method	Description
@NotNull GomFilterList	allow(GomFilterEntry.FilterType filterType)	Allow the given filter type.
boolean	allows(GomFilterEntry.FilterType filterType)	Indicates if the given filter type is allowed
GomFilterEntry	get(int index)
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.
@NotNull GomFilterList	hide(GomFilterEntry.FilterType filterType)	Hide the given filter type.
boolean	hides(GomFilterEntry.FilterType filterType)	Indicates if the given filter type is hidden

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

getGomElementTag, getIncludeConfiguration, hasRepresentation, setGomElementTag, setIncludeConfiguration, verify

Methods inherited from class java.util.ArrayList

add, add, addAll, addAll, clear, clone, contains, ensureCapacity, equals, forEach, 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, 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 tag of this component

Since:

4.2.9

See Also:

• Constant Field Values

ENTRY_TAG_ALLOW

public static final String ENTRY_TAG_ALLOW

The tag for allowed entries

Since:

4.2.9

See Also:

• Constant Field Values

ENTRY_TAG_HIDE

public static final String ENTRY_TAG_HIDE

The tag for hidden entries

Since:

4.2.9

See Also:

• Constant Field Values

Constructor Details

GomFilterList

public GomFilterList()

Method Details

getDefaultTag

protected String getDefaultTag()

Description copied from class: AbstractGomList

Returns the default tag name of the component.

Specified by:

getDefaultTag in class AbstractGomList<GomFilterEntry>

get

public GomFilterEntry get(int index)

Specified by:

get in interface List<GomFilterEntry>

Overrides:

get in class ArrayList<GomFilterEntry>

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<GomFilterEntry>

Overrides:

getGomElementMappings in class AbstractGomList<GomFilterEntry>

Returns:

The list of child tags.

allow

@NotNull
public @NotNull GomFilterList allow(GomFilterEntry.FilterType filterType)

Allow the given filter type. May be used in a builder-style pattern.

Parameters:

filterType - the filter type to add

Returns:

the current instance after adding the filter type

Since:

4.2.9

hide

@NotNull
public @NotNull GomFilterList hide(GomFilterEntry.FilterType filterType)

Hide the given filter type. May be used in a builder-style pattern.

Parameters:

filterType - the filter type to hide

Returns:

the current instance after hiding the filter type

Since:

4.2.9

allows

public boolean allows(@NotNull
 GomFilterEntry.FilterType filterType)

Indicates if the given filter type is allowed

Parameters:

filterType - the filter type to check

Since:

5.0

hides

public boolean hides(@NotNull
 GomFilterEntry.FilterType filterType)

Indicates if the given filter type is hidden

Parameters:

filterType - the filter type to check

Since:

5.0