ConfigElementLoader (RVPF-Core API Documentation)

Object
- ConfigElementLoader

Direct Known Subclasses:

MetadataElementLoader
```
public abstract class ConfigElementLoader
extends Object
```
Config document element loader.

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`ALIAS_ELEMENT` Alias element.
`static String`	`ALLOW_ATTRIBUTE` Allow attribute.
`static String`	`CACHED_ATTRIBUTE` Cached attribute.
`static String`	`CLASS_DEF_ENTITY` ClassDef entity element.
`static String`	`CLASS_DEF_REFERENCE` ClassDef reference.
`static String`	`CLASS_LIB_ENTITY` ClassLib entity element.
`static String`	`CLASS_LIB_REFERENCE` ClassLib reference.
`static String`	`DECRYPT_ATTRIBUTE` Decrypt attribute.
`static String`	`DECRYPT_KEY_ELEMENT` Decrypt key element.
`static String`	`DEF_ATTRIBUTE` Def attribute.
`static String`	`DENY_ATTRIBUTE` Deny attribute.
`static String`	`ENV_ATTRIBUTE` Env attribute.
`static String`	`EQ_ATTRIBUTE` Eq attribute.
`static String`	`EXTENDS_ATTRIBUTE` Extends attribute.
`static String`	`FROM_ATTRIBUTE` From attribute.
`static String`	`HIDDEN_ATTRIBUTE` Hidden attribute.
`static String`	`IMPLEMENTS_ELEMENT` Implements element.
`static String`	`LOCATION_ATTRIBUTE` Location attribute.
`static String`	`LOCATION_ELEMENT` Location element.
`static String`	`MEMBER_ATTRIBUTE` Member attribute.
`static String`	`MULTIPLE_ATTRIBUTE` Multiple allowed attribute.
`static String`	`OPTIONAL_ATTRIBUTE` Optional attribute.
`static String`	`OVERRIDES_ATTRIBUTE` Overrides attribute.
`static String`	`PACKAGE_ATTRIBUTE` Package attribute.
`static String`	`PROPERTIES_DEF_ENTITY` PropertiesDef entity element.
`static String`	`PROPERTIES_ELEMENT` Properties element.
`static String`	`PROPERTY_ATTRIBUTE` Property attribute.
`static String`	`PROPERTY_DEF_ENTITY` PropertyDef entity element.
`static String`	`PROPERTY_ELEMENT` Property element.
`static String`	`REQUIRED_ATTRIBUTE` Required attribute.
`static String`	`ROLE_ATTRIBUTE` Role attribute.
`static String`	`SECURITY_ATTRIBUTE` Security attribute.
`static String`	`SERVICE_ELEMENT` Service element.
`static String`	`STAMP_ATTRIBUTE` Stamp attribute.
`static String`	`SUPERSEDE_ATTRIBUTE` Supersede attribute.
`static String`	`SYSTEM_ATTRIBUTE` System attribute.
`static String`	`VALIDATED_ATTRIBUTE` Validated attribute.
`static String`	`VALUE_ATTRIBUTE` Value attribute.
`static String`	`VALUE_ELEMENT` Value element.
`static String`	`VERIFY_ATTRIBUTE` Verify attribute.
`static String`	`VERIFY_KEY_ELEMENT` Verify key element.

Constructor Summary

Constructors
Constructor and Description

ConfigElementLoader()

Constructors
Constructor and Description
`ConfigElementLoader()`

Method Summary

All Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method and Description
`protected Config`	`getConfig()` Gets the config.
`protected URL`	`getContextURL()` Gets the URL for the current context.
`protected DocumentLoader`	`getDocumentLoader()` Gets the document loader.
`protected DocumentElement`	`getElement()` Gets the XML element.
`protected Entity`	`getEntity(String key, String prefix)` Gets an entity registered to the owner.
`protected Optional<? extends Entity>`	`getEntity(String key, String prefix, boolean optional)` Gets an entity registered to the owner.
`protected Optional<String>`	`getLang()` Gets the information texts language.
`protected Logger`	`getLogger()` Gets the logger.
`protected abstract void`	`process()` Processes the entry XML informations.
`protected void`	`putEntity(Entity entity)` Registers an entity to the owner XML document.
`protected void`	`putEntity(Entity entity, boolean supersede)` Registers an entity to the owner XML document.
`protected void`	`putEntity(String key, Entity entity)` Registers an entity to the owner XML document.
`protected void`	`removeEntity(String key, String prefix)` Removes an entity.
`protected void`	`updateTexts()` Updates information texts.

Methods inherited from class Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - ALIAS_ELEMENT
```
public static final String ALIAS_ELEMENT
```
    Alias element.
    
    See Also:
    
    Constant Field Values
  - ALLOW_ATTRIBUTE
```
public static final String ALLOW_ATTRIBUTE
```
    Allow attribute.
    
    See Also:
    
    Constant Field Values
  - CACHED_ATTRIBUTE
```
public static final String CACHED_ATTRIBUTE
```
    Cached attribute.
    
    See Also:
    
    Constant Field Values
  - CLASS_DEF_ENTITY
```
public static final String CLASS_DEF_ENTITY
```
    ClassDef entity element.
    
    See Also:
    
    Constant Field Values
  - CLASS_DEF_REFERENCE
```
public static final String CLASS_DEF_REFERENCE
```
    ClassDef reference.
    
    See Also:
    
    Constant Field Values
  - CLASS_LIB_ENTITY
```
public static final String CLASS_LIB_ENTITY
```
    ClassLib entity element.
    
    See Also:
    
    Constant Field Values
  - CLASS_LIB_REFERENCE
```
public static final String CLASS_LIB_REFERENCE
```
    ClassLib reference.
    
    See Also:
    
    Constant Field Values
  - DECRYPT_ATTRIBUTE
```
public static final String DECRYPT_ATTRIBUTE
```
    Decrypt attribute.
    
    See Also:
    
    Constant Field Values
  - DECRYPT_KEY_ELEMENT
```
public static final String DECRYPT_KEY_ELEMENT
```
    Decrypt key element.
    
    See Also:
    
    Constant Field Values
  - DEF_ATTRIBUTE
```
public static final String DEF_ATTRIBUTE
```
    Def attribute.
    
    See Also:
    
    Constant Field Values
  - DENY_ATTRIBUTE
```
public static final String DENY_ATTRIBUTE
```
    Deny attribute.
    
    See Also:
    
    Constant Field Values
  - ENV_ATTRIBUTE
```
public static final String ENV_ATTRIBUTE
```
    Env attribute.
    
    See Also:
    
    Constant Field Values
  - EQ_ATTRIBUTE
```
public static final String EQ_ATTRIBUTE
```
    Eq attribute.
    
    See Also:
    
    Constant Field Values
  - EXTENDS_ATTRIBUTE
```
public static final String EXTENDS_ATTRIBUTE
```
    Extends attribute.
    
    See Also:
    
    Constant Field Values
  - FROM_ATTRIBUTE
```
public static final String FROM_ATTRIBUTE
```
    From attribute.
    
    See Also:
    
    Constant Field Values
  - HIDDEN_ATTRIBUTE
```
public static final String HIDDEN_ATTRIBUTE
```
    Hidden attribute.
    
    See Also:
    
    Constant Field Values
  - IMPLEMENTS_ELEMENT
```
public static final String IMPLEMENTS_ELEMENT
```
    Implements element.
    
    See Also:
    
    Constant Field Values
  - LOCATION_ATTRIBUTE
```
public static final String LOCATION_ATTRIBUTE
```
    Location attribute.
    
    See Also:
    
    Constant Field Values
  - LOCATION_ELEMENT
```
public static final String LOCATION_ELEMENT
```
    Location element.
    
    See Also:
    
    Constant Field Values
  - MEMBER_ATTRIBUTE
```
public static final String MEMBER_ATTRIBUTE
```
    Member attribute.
    
    See Also:
    
    Constant Field Values
  - MULTIPLE_ATTRIBUTE
```
public static final String MULTIPLE_ATTRIBUTE
```
    Multiple allowed attribute.
    
    See Also:
    
    Constant Field Values
  - OPTIONAL_ATTRIBUTE
```
public static final String OPTIONAL_ATTRIBUTE
```
    Optional attribute.
    
    See Also:
    
    Constant Field Values
  - OVERRIDES_ATTRIBUTE
```
public static final String OVERRIDES_ATTRIBUTE
```
    Overrides attribute.
    
    See Also:
    
    Constant Field Values
  - PACKAGE_ATTRIBUTE
```
public static final String PACKAGE_ATTRIBUTE
```
    Package attribute.
    
    See Also:
    
    Constant Field Values
  - PROPERTIES_DEF_ENTITY
```
public static final String PROPERTIES_DEF_ENTITY
```
    PropertiesDef entity element.
    
    See Also:
    
    Constant Field Values
  - PROPERTIES_ELEMENT
```
public static final String PROPERTIES_ELEMENT
```
    Properties element.
    
    See Also:
    
    Constant Field Values
  - PROPERTY_ATTRIBUTE
```
public static final String PROPERTY_ATTRIBUTE
```
    Property attribute.
    
    See Also:
    
    Constant Field Values
  - PROPERTY_DEF_ENTITY
```
public static final String PROPERTY_DEF_ENTITY
```
    PropertyDef entity element.
    
    See Also:
    
    Constant Field Values
  - PROPERTY_ELEMENT
```
public static final String PROPERTY_ELEMENT
```
    Property element.
    
    See Also:
    
    Constant Field Values
  - REQUIRED_ATTRIBUTE
```
public static final String REQUIRED_ATTRIBUTE
```
    Required attribute.
    
    See Also:
    
    Constant Field Values
  - ROLE_ATTRIBUTE
```
public static final String ROLE_ATTRIBUTE
```
    Role attribute.
    
    See Also:
    
    Constant Field Values
  - SECURITY_ATTRIBUTE
```
public static final String SECURITY_ATTRIBUTE
```
    Security attribute.
    
    See Also:
    
    Constant Field Values
  - SERVICE_ELEMENT
```
public static final String SERVICE_ELEMENT
```
    Service element.
    
    See Also:
    
    Constant Field Values
  - STAMP_ATTRIBUTE
```
public static final String STAMP_ATTRIBUTE
```
    Stamp attribute.
    
    See Also:
    
    Constant Field Values
  - SUPERSEDE_ATTRIBUTE
```
public static final String SUPERSEDE_ATTRIBUTE
```
    Supersede attribute.
    
    See Also:
    
    Constant Field Values
  - SYSTEM_ATTRIBUTE
```
public static final String SYSTEM_ATTRIBUTE
```
    System attribute.
    
    See Also:
    
    Constant Field Values
  - VALIDATED_ATTRIBUTE
```
public static final String VALIDATED_ATTRIBUTE
```
    Validated attribute.
    
    See Also:
    
    Constant Field Values
  - VALUE_ATTRIBUTE
```
public static final String VALUE_ATTRIBUTE
```
    Value attribute.
    
    See Also:
    
    Constant Field Values
  - VALUE_ELEMENT
```
public static final String VALUE_ELEMENT
```
    Value element.
    
    See Also:
    
    Constant Field Values
  - VERIFY_ATTRIBUTE
```
public static final String VERIFY_ATTRIBUTE
```
    Verify attribute.
    
    See Also:
    
    Constant Field Values
  - VERIFY_KEY_ELEMENT
```
public static final String VERIFY_KEY_ELEMENT
```
    Verify key element.
    
    See Also:
    
    Constant Field Values
- Constructor Detail
  - ConfigElementLoader
```
public ConfigElementLoader()
```
- Method Detail
  - getConfig
```
@Nonnull
 @CheckReturnValue
protected final Config getConfig()
```
    Gets the config.
    
    Returns:
    
    The config.
  - getContextURL
```
@Nonnull
 @CheckReturnValue
protected final URL getContextURL()
```
    Gets the URL for the current context.
    
    Returns:
    
    The URL.
  - getDocumentLoader
```
@Nonnull
 @CheckReturnValue
protected final DocumentLoader getDocumentLoader()
```
    Gets the document loader.
    
    Returns:
    
    The document loader.
  - getElement
```
@Nonnull
 @CheckReturnValue
protected final DocumentElement getElement()
```
    Gets the XML element.
    
    Returns:
    
    The XML element.
  - getEntity
```
@Nonnull
 @CheckReturnValue
protected final Entity getEntity(@Nonnull
                                                               String key,
                                                               @Nonnull
                                                               String prefix)
                                                        throws ValidationException
```
    Gets an entity registered to the owner.
    Produces a warning if the entity is not present.
    
    Parameters:
    
    key - The entity key.
    
    prefix - The prefix associated with the entity class.
    
    Returns:
    
    The entity.
    
    Throws:
    
    ValidationException - When appropriate.
  - getEntity
```
@Nonnull
 @CheckReturnValue
protected final Optional<? extends Entity> getEntity(@Nonnull
                                                                                   String key,
                                                                                   @Nonnull
                                                                                   String prefix,
                                                                                   boolean optional)
                                                                            throws ValidationException
```
    Gets an entity registered to the owner.
    
    Parameters:
    
    key - The entity name.
    
    prefix - The prefix associated with the entity class.
    
    optional - True if the entity is optional.
    
    Returns:
    
    The entity or empty if the entity is unknown and not optional.
    
    Throws:
    
    ValidationException - When appropriate.
  - getLang
```
@Nonnull
 @CheckReturnValue
protected Optional<String> getLang()
```
    Gets the information texts language.
    
    Returns:
    
    The optional information texts language.
  - getLogger
```
@Nonnull
 @CheckReturnValue
protected final Logger getLogger()
```
    Gets the logger.
    
    Returns:
    
    The logger.
  - process
```
protected abstract void process()
                         throws ValidationException
```
    Processes the entry XML informations.
    
    Throws:
    
    ValidationException - When appropriate.
  - putEntity
```
protected final void putEntity(@Nonnull
                               Entity entity)
```
    Registers an entity to the owner XML document.
    
    Parameters:
    
    entity - The entity to be registered.
  - putEntity
```
protected final void putEntity(@Nonnull
                               Entity entity,
                               boolean supersede)
```
    Registers an entity to the owner XML document.
    
    Parameters:
    
    entity - The entity to be registered.
    
    supersede - Allows supersede by name.
  - putEntity
```
protected final void putEntity(@Nonnull
                               String key,
                               @Nonnull
                               Entity entity)
```
    Registers an entity to the owner XML document.
    
    Parameters:
    
    key - The key for the registration.
    
    entity - The entity to be registered.
  - removeEntity
```
protected final void removeEntity(@Nonnull
                                  String key,
                                  @Nonnull
                                  String prefix)
```
    Removes an entity.
    
    Parameters:
    
    key - The entity definition key.
    
    prefix - The key prefix for the entity.
  - updateTexts
```
protected void updateTexts()
```
    Updates information texts.

Class ConfigElementLoader

Field Summary

Constructor Summary

Method Summary

Methods inherited from class Object

Field Detail

ALIAS_ELEMENT

ALLOW_ATTRIBUTE

CACHED_ATTRIBUTE

CLASS_DEF_ENTITY

CLASS_DEF_REFERENCE

CLASS_LIB_ENTITY

CLASS_LIB_REFERENCE

DECRYPT_ATTRIBUTE

DECRYPT_KEY_ELEMENT

DEF_ATTRIBUTE

DENY_ATTRIBUTE

ENV_ATTRIBUTE

EQ_ATTRIBUTE

EXTENDS_ATTRIBUTE

FROM_ATTRIBUTE

HIDDEN_ATTRIBUTE

IMPLEMENTS_ELEMENT

LOCATION_ATTRIBUTE

LOCATION_ELEMENT

MEMBER_ATTRIBUTE

MULTIPLE_ATTRIBUTE

OPTIONAL_ATTRIBUTE

OVERRIDES_ATTRIBUTE

PACKAGE_ATTRIBUTE

PROPERTIES_DEF_ENTITY

PROPERTIES_ELEMENT

PROPERTY_ATTRIBUTE

PROPERTY_DEF_ENTITY

PROPERTY_ELEMENT

REQUIRED_ATTRIBUTE

ROLE_ATTRIBUTE

SECURITY_ATTRIBUTE

SERVICE_ELEMENT

STAMP_ATTRIBUTE

SUPERSEDE_ATTRIBUTE

SYSTEM_ATTRIBUTE

VALIDATED_ATTRIBUTE

VALUE_ATTRIBUTE

VALUE_ELEMENT

VERIFY_ATTRIBUTE

VERIFY_KEY_ELEMENT

Constructor Detail

ConfigElementLoader

Method Detail

getConfig

getContextURL

getDocumentLoader

getElement

getEntity

getEntity

getLang

getLogger

process

putEntity

putEntity

putEntity

removeEntity

updateTexts