Class ConfigurationElement<T extends ConfigurationElement>

java.lang.Object

org.infinispan.commons.configuration.attributes.ConfigurationElement<T>

All Implemented Interfaces:

Matchable<T>, Updatable<T>

Direct Known Subclasses:

AbstractStoreConfiguration, AllowListConfiguration, AsyncStoreConfiguration, AuthenticationConfiguration, AuthorizationConfiguration, BackupConfiguration, BackupForConfiguration, CDIConnectionFactoryConfiguration, ClusteringConfiguration, Configuration, ConnectionPoolConfiguration, ContainerMemoryConfiguration, ContentTypeConfiguration, CorsConfiguration, CorsRuleConfiguration, CounterManagerConfiguration, DataConfiguration, EncodingConfiguration, EncryptionConfiguration, ExpirationConfiguration, GlobalAuthorizationConfiguration, GlobalJmxConfiguration, GlobalMemoryMonitorConfiguration, GlobalMetricsConfiguration, GlobalSecurityConfiguration, GlobalStateConfiguration, GlobalStatePathConfiguration, GlobalStorageConfiguration, GlobalTracingConfiguration, GroupsConfiguration, HashConfiguration, IndexConfiguration, IndexingConfiguration, IndexMergeConfiguration, IndexReaderConfiguration, IndexShardingConfiguration, IndexWriterConfiguration, InvocationBatchingConfiguration, JGroupsConfiguration, KeyStoreConfiguration, L1Configuration, LockingConfiguration, MemcachedAuthenticationConfiguration, MemoryConfiguration, PartitionHandlingConfiguration, PersistenceConfiguration, PrincipalRoleMapperConfiguration, ProtocolServerConfiguration, QueriesJdbcConfiguration, QueryConfiguration, RecoveryConfiguration, RemoteContainerConfiguration, RemoteServerConfiguration, RespAuthenticationConfiguration, RestAuthenticationConfiguration, RocksDBExpirationConfiguration, RolePermissionMapperConfiguration, SaslAuthenticationConfiguration, SaslConfiguration, SchemaJdbcConfiguration, SecurityConfiguration, SecurityConfiguration, SerializationConfiguration, ShutdownConfiguration, SitesConfiguration, SniConfiguration, SslConfiguration, SslConfiguration, SslEngineConfiguration, StackConfiguration, StackFileConfiguration, StateTransferConfiguration, StatisticsConfiguration, TakeOfflineConfiguration, TemporaryGlobalStatePathConfiguration, TextAuthenticationConfiguration, TopologyCacheConfiguration, TracingConfiguration, TransactionConfiguration, TransportConfiguration, TrustStoreConfiguration, UnsafeConfiguration, XSiteStateTransferConfiguration

public abstract class ConfigurationElement<T extends ConfigurationElement>
extends Object
implements Matchable<T>, Updatable<T>

An abstract class which represents a configuration element, with attributes and child elements.

Since:

13.0

Author:

Gustavo Fernandes, Tristan Tarrant

Field Summary

Fields

Modifier and Type	Field	Description
protected final AttributeSet	attributes
static final ConfigurationElement<?>[]	CHILDLESS
protected final ConfigurationElement<?>[]	children
protected final String	element
protected final boolean	repeated

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	ConfigurationElement(Enum<?> element, AttributeSet attributes, ConfigurationElement<?>... children)
protected	ConfigurationElement(String element, boolean repeated, AttributeSet attributes, ConfigurationElement<?>... children)
protected	ConfigurationElement(String element, AttributeSet attributes, ConfigurationElement<?>... children)

Method Summary

Modifier and Type	Method	Description
final AttributeSet	attributes()
protected static ConfigurationElement<?>	child(Attribute<?> attribute)
ConfigurationElement<?>[]	children()
protected static <T> ConfigurationElement<?>[]	children(Collection<T> children)
void	collectMutableAttributes(String prefix, Map<String, Attribute<?>> collector)
final String	elementName()
boolean	equals(Object o)
static Attribute<?>[]	extractAttributes(AttributeSet attributes, AttributeDefinition<?>... definitions)
Attribute<?>	findAttribute(String name)
int	hashCode()
boolean	isModified()
protected static <T extends ConfigurationElement> ConfigurationElement<T>	list(Enum<?> element, List<T> list)
boolean	matches(T other)
boolean	matches(T other, Attribute<?>... ignored)
boolean	matches(T other, ConfigurationElement<?> parent)
String	toString()
void	update(String parentName, T other)	Updates the mutable part of this instance with the values of the other instance
void	update(String parentName, T other, Attribute<?>... ignored)
void	update(String parentName, T other, ConfigurationElement<?> parent)
void	validateUpdate(String parentName, T other)	Verifies that updating the mutable part of this instance with the values of the other instance is possible
void	validateUpdate(String parentName, T other, Attribute<?>... ignored)
void	validateUpdate(String parentName, T other, ConfigurationElement<?> parent)
void	write(ConfigurationWriter writer)	Writes this ConfigurationElement to the writer

Methods inherited from class Object

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

Field Details

CHILDLESS

public static final ConfigurationElement<?>[] CHILDLESS

element

protected final String element

attributes

protected final AttributeSet attributes

children

protected final ConfigurationElement<?>[] children

repeated

protected final boolean repeated

Constructor Details

ConfigurationElement

protected ConfigurationElement(Enum<?> element,
 AttributeSet attributes,
 ConfigurationElement<?>... children)

ConfigurationElement

protected ConfigurationElement(String element,
 AttributeSet attributes,
 ConfigurationElement<?>... children)

ConfigurationElement

protected ConfigurationElement(String element,
 boolean repeated,
 AttributeSet attributes,
 ConfigurationElement<?>... children)

Method Details

elementName

public final String elementName()

attributes

public final AttributeSet attributes()

children

public ConfigurationElement<?>[] children()

findAttribute

public Attribute<?> findAttribute(String name)

collectMutableAttributes

public void collectMutableAttributes(String prefix,
 Map<String, Attribute<?>> collector)

list

protected static <T extends ConfigurationElement>
ConfigurationElement<T> list(Enum<?> element,
 List<T> list)

matches

public boolean matches(T other)

Specified by:

matches in interface Matchable<T extends ConfigurationElement>

matches

public boolean matches(T other,
 ConfigurationElement<?> parent)

matches

public boolean matches(T other,
 Attribute<?>... ignored)

update

public void update(String parentName,
 T other,
 Attribute<?>... ignored)

update

public void update(String parentName,
 T other,
 ConfigurationElement<?> parent)

update

public void update(String parentName,
 T other)

Description copied from interface: Updatable

Updates the mutable part of this instance with the values of the other instance

Specified by:

update in interface Updatable<T extends ConfigurationElement>

Parameters:

other -

validateUpdate

public void validateUpdate(String parentName,
 T other,
 ConfigurationElement<?> parent)

validateUpdate

public void validateUpdate(String parentName,
 T other,
 Attribute<?>... ignored)

validateUpdate

public void validateUpdate(String parentName,
 T other)

Description copied from interface: Updatable

Verifies that updating the mutable part of this instance with the values of the other instance is possible

Specified by:

validateUpdate in interface Updatable<T extends ConfigurationElement>

Parameters:

other -

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object

isModified

public boolean isModified()

write

public void write(ConfigurationWriter writer)

Writes this ConfigurationElement to the writer

Parameters:

writer -

children

protected static <T> ConfigurationElement<?>[] children(Collection<T> children)

child

protected static ConfigurationElement<?> child(Attribute<?> attribute)

extractAttributes

public static Attribute<?>[] extractAttributes(AttributeSet attributes,
 AttributeDefinition<?>... definitions)