org.rvpf.document.loader

Class ConfigDocumentLoader

Object

DocumentLoader

ConfigDocumentLoader

All Implemented Interfaces:

PropertyChangeListener, EventListener, XMLElement.Factory

Direct Known Subclasses:

MetadataDocumentLoader

public class ConfigDocumentLoader
extends DocumentLoader
implements PropertyChangeListener

Config document.

Field Summary

Fields

Modifier and Type	Field and Description
static String	CONFIG_PROPERTY Property holding the path to the config XML text.
static String	CONFIG_ROOT Root element of config XML text.
static String	DEFAULT_CONFIG Default source of config XML text.
static String[]	DOCTYPE_STRINGS The document type strings.
static String	VALIDATION_DISABLED_PROPERTY Validation control properties.
static String	VALIDATION_ENABLED_PROPERTY

Fields inherited from class DocumentLoader

ID_PATTERN, ID_PREFIX

Method Summary

Modifier and Type	Method and Description
protected DocumentLoader.RootHandler	getRootHandler() Gets a root handler.
protected String	getRootName() Gets the root element name for this document.
protected URL	getURL() Gets the URL for this document.
static Config	loadConfig(String serviceName, Optional<String> from, Optional<ServiceClassLoader> classLoader) Loads the config.
protected boolean	loadFrom(String from, Optional<Reader> reader) Loads this document from the specified location with a supplied reader.
void	propertyChange(PropertyChangeEvent event) Called when a monitored property changes.
protected boolean	read(String xml) Reads the document from an XML string.
protected void	setURL(URL url) Sets the URL for this document.

Methods inherited from class DocumentLoader

addPrefixNames, getEntity, getPrefixName, getThisLogger, handle, newXMLElement, setEntities, setSubstitutionDeferred, setSubstitutionEnabled, setValidating

Methods inherited from class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

CONFIG_PROPERTY

public static final String CONFIG_PROPERTY

Property holding the path to the config XML text.

See Also:

Constant Field Values

CONFIG_ROOT

public static final String CONFIG_ROOT

Root element of config XML text.

See Also:

Constant Field Values

DEFAULT_CONFIG

public static final String DEFAULT_CONFIG

Default source of config XML text.

See Also:

Constant Field Values

DOCTYPE_STRINGS

public static final String[] DOCTYPE_STRINGS

The document type strings.

VALIDATION_DISABLED_PROPERTY

public static final String VALIDATION_DISABLED_PROPERTY

Validation control properties.

See Also:

Constant Field Values

VALIDATION_ENABLED_PROPERTY

public static final String VALIDATION_ENABLED_PROPERTY

See Also:

Constant Field Values

Method Detail

loadConfig

@Nullable
 @CheckReturnValue
public static Config loadConfig(@Nonnull
                                                               String serviceName,
                                                               @Nonnull
                                                               Optional<String> from,
                                                               @Nonnull
                                                               Optional<ServiceClassLoader> classLoader)

Loads the config.

Parameters:

serviceName - The name of the service the config is loaded for.

from - The optional location to load from.

classLoader - An optional class loader.

Returns:

The config (null on failure).

propertyChange

public final void propertyChange(PropertyChangeEvent event)

Called when a monitored property changes.

Specified by:

propertyChange in interface PropertyChangeListener

Parameters:

event - The event describing the change.

getRootHandler

protected DocumentLoader.RootHandler getRootHandler()

Gets a root handler.

Overrides:

getRootHandler in class DocumentLoader

Returns:

A root handler.

getRootName

protected final String getRootName()

Gets the root element name for this document.

Specified by:

getRootName in class DocumentLoader

Returns:

The element's name.

getURL

protected URL getURL()

Gets the URL for this document.

Specified by:

getURL in class DocumentLoader

Returns:

The URL.

loadFrom

protected boolean loadFrom(String from,
                           Optional<Reader> reader)

Loads this document from the specified location with a supplied reader.

Overrides:

loadFrom in class DocumentLoader

Parameters:

from - The location to load from.

reader - The optional reader.

Returns:

True on success.

read

protected boolean read(String xml)

Reads the document from an XML string.

Overrides:

read in class DocumentLoader

Parameters:

xml - The XML string.

Returns:

True on success.

setURL

protected final void setURL(URL url)

Sets the URL for this document.

Specified by:

setURL in class DocumentLoader

Parameters:

url - The URL.