org.jomc.ri.model

Class RuntimeImplementation

java.lang.Object

org.jomc.model.ModelObject

org.jomc.model.Implementation

org.jomc.ri.model.RuntimeImplementation

All Implemented Interfaces:

Cloneable, RuntimeModelObject

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

Runtime Implementation.

Identifier:

org.jomc.ri.model.RuntimeImplementation

Name:

JOMC ⁑ RI ⁑ RuntimeImplementation

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.Implementation

_abstract, _final, any, classDeclaration, clazz, dependencies, identifier, implementations, location, messages, name, properties, specifications, stateless, vendor, version

Fields inherited from class org.jomc.model.ModelObject

authors, createDate, deprecated, documentation, MODEL_PUBLIC_ID, modelVersion

Constructor Summary

Constructors

Constructor and Description
RuntimeImplementation() Creates a new RuntimeImplementation instance.
RuntimeImplementation(Implementation implementation) Creates a new RuntimeImplementation instance by deeply copying a given Implementation instance.

Method Summary

Methods

Modifier and Type	Method and Description
void	clear() Clears shared runtime state.
void	gc() Handles shared runtime state.
Class<?>	getJavaClass(ClassLoader classLoader) Gets the Java class of the implementation for a given class loader.
JavaTypeName	getJavaTypeName() Gets the Java type name of the type referenced by the implementation.
URI	getLocationUri() Gets the location URI used for locating instances of this implementation.

Methods inherited from class org.jomc.model.Implementation

clone, getAny, getAnyElement, getAnyElement, getAnyElements, getAnyElements, getAnyObject, getAnyObjects, getClazz, getDependencies, getIdentifier, getImplementations, getLocation, getMessages, getName, getProperties, getSpecifications, getVendor, getVersion, isAbstract, isClassDeclaration, isFinal, isStateless, setAbstract, setClassDeclaration, setClazz, setDependencies, setFinal, setIdentifier, setImplementations, setLocation, setMessages, setName, setProperties, setSpecifications, setStateless, setVendor, setVersion

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

RuntimeImplementation

public RuntimeImplementation(Implementation implementation)

Creates a new RuntimeImplementation instance by deeply copying a given Implementation instance.

Parameters:

implementation - The instance to copy.

Throws:

NullPointerException - if implementation is null.

RuntimeImplementation

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

Creates a new RuntimeImplementation instance.

Method Detail

getLocationUri

public URI getLocationUri()
                   throws ModelObjectException

Gets the location URI used for locating instances of this implementation.

This method queries an internal cache for a result object to return. 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:

getLocationUri in class Implementation

Returns:

The location URI used for locating instances of this implementation or null, if instances of this implementation do not need to be located.

Throws:

ModelObjectException - if parsing the location to an URI object fails.

See Also:

Implementation.getLocation(), clear()

getJavaClass

public Class<?> getJavaClass(ClassLoader classLoader)
                      throws ModelObjectException,
                             ClassNotFoundException

Gets the Java class of the implementation for a given class loader.

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 RuntimeModelObjects.clear() must be used to synchronize the state of the internal cache with the state of the class loader, should the state of the class loader change.

Overrides:

getJavaClass in class Implementation

Parameters:

classLoader - The class loader to get the Java class from or null, to get the Java class from the platform's bootstrap class loader.

Returns:

The Java class of the implementation or null, if the implementation does not declare a class.

Throws:

ClassNotFoundException - if the Java class is not found.

ModelObjectException - if parsing the name of the referenced type fails.

See Also:

Implementation.getClazz(), RuntimeModelObjects.clear()

getJavaTypeName

public JavaTypeName getJavaTypeName()
                             throws ModelObjectException

Gets the Java type name of the type referenced by the implementation.

This method queries an internal cache for a result object to return. 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:

getJavaTypeName in class Implementation

Returns:

The Java type name of the type referenced by the implementation or null, if the implementation does not reference a type.

Throws:

ModelObjectException - if compiling the name of the referenced type to a JavaTypeName fails.

Since:

1.4

See Also:

getJavaTypeName(), 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