org.jomc.ri.model

Class RuntimeProperties

java.lang.Object

org.jomc.model.ModelObject

org.jomc.model.Properties

org.jomc.ri.model.RuntimeProperties

All Implemented Interfaces:

Cloneable, RuntimeModelObject

@Generated(value="org.jomc.tools.SourceFileProcessor 1.9",
           comments="See http://www.jomc.org/jomc/1.9/jomc-tools-1.9")
public class RuntimeProperties
extends Properties
implements RuntimeModelObject

Runtime Properties.

Identifier:

org.jomc.ri.model.RuntimeProperties

Name:

JOMC ⁑ RI ⁑ RuntimeProperties

Specifications:

org.jomc.ri.model.RuntimeModelObject @ 1.2

Abstract:

No

Final:

No

Stateless:

No

Version:

1.2

Author:

Christian Schulte 1.2

Field Summary

Fields inherited from class org.jomc.model.Properties

property, reference

Fields inherited from class org.jomc.model.ModelObject

authors, createDate, deprecated, documentation, MODEL_PUBLIC_ID, modelVersion

Constructor Summary

Constructors

Constructor and Description
RuntimeProperties() Creates a new RuntimeProperties instance.
RuntimeProperties(Properties properties) Creates a new RuntimeProperties instance by deeply copying a given Properties instance.

Method Summary

Methods

Modifier and Type	Method and Description
void	clear() Clears shared runtime state.
void	gc() Handles shared runtime state.
Property	getProperty(String name) Gets a property for a given name from the list of properties.
PropertyReference	getReference(String name) Gets a property reference for a given name from the list of references.

Methods inherited from class org.jomc.model.Properties

clone, getPropertiesByType, getProperty, getReference

Methods inherited from class org.jomc.model.ModelObject

getAnyElement, getAnyElement, getAnyElements, getAnyElements, getAnyObject, getAnyObjects, getAuthors, getCreateDate, getDocumentation, getModelVersion, isDeprecated, setAuthors, setCreateDate, setDeprecated, setDocumentation, setModelVersion

Methods inherited from class java.lang.Object

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

Constructor Detail

RuntimeProperties

public RuntimeProperties(Properties properties)

Creates a new RuntimeProperties instance by deeply copying a given Properties instance.

Parameters:

properties - The instance to copy.

Throws:

NullPointerException - if properties is null.

RuntimeProperties

@Generated(value="org.jomc.tools.SourceFileProcessor 1.9",
           comments="See http://www.jomc.org/jomc/1.9/jomc-tools-1.9")
public RuntimeProperties()

Creates a new RuntimeProperties instance.

Method Detail

getProperty

public Property getProperty(String name)

Gets a property for a given name from the list of properties.

This method queries an internal cache for a result object to return for the given argument values. If no cached result object is available, this method queries the super-class for a result object to return and caches the outcome of that query for use on successive calls.

Note:
Method clear() must be used to synchronize the state of the internal cache with the state of the instance, should the state of the instance change.

Overrides:

getProperty in class Properties

Parameters:

name - The name of the property to return.

Returns:

The first matching property or null, if no such property is found.

Throws:

NullPointerException - if name is null.

See Also:

Properties.getProperty(), Property.getName(), clear()

getReference

public PropertyReference getReference(String name)

Gets a property reference for a given name from the list of references.

This method queries an internal cache for a result object to return for the given argument values. If no cached result object is available, this method queries the super-class for a result object to return and caches the outcome of that query for use on successive calls.

Note:
Method clear() must be used to synchronize the state of the internal cache with the state of the instance, should the state of the instance change.

Overrides:

getReference in class Properties

Parameters:

name - The name of the property reference to return.

Returns:

The first matching property reference or null, if no such reference is found.

Throws:

NullPointerException - if name is null.

See Also:

Properties.getReference(), PropertyReference.getName(), clear()

gc

public void gc()

Description copied from interface: RuntimeModelObject

Handles shared runtime state.

Specified by:

gc in interface RuntimeModelObject

clear

public void clear()

Description copied from interface: RuntimeModelObject

Clears shared runtime state.

Specified by:

clear in interface RuntimeModelObject