org.jomc.ri.model

Class RuntimeSpecification

java.lang.Object

org.jomc.model.ModelObject

org.jomc.model.Specification

org.jomc.ri.model.RuntimeSpecification

All Implemented Interfaces:

Cloneable, RuntimeModelObject

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

Runtime Specification.

Identifier:

org.jomc.ri.model.RuntimeSpecification

Name:

JOMC ⁑ RI ⁑ RuntimeSpecification

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

any, classDeclaration, clazz, identifier, multiplicity, properties, scope, vendor, version

Fields inherited from class org.jomc.model.ModelObject

authors, createDate, deprecated, documentation, MODEL_PUBLIC_ID, modelVersion

Constructor Summary

Constructors

Constructor and Description
RuntimeSpecification() Creates a new RuntimeSpecification instance.
RuntimeSpecification(Specification specification) Creates a new RuntimeSpecification instance by deeply copying a given Specification 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 specification for a given class loader.
JavaTypeName	getJavaTypeName() Gets the Java type name of the type referenced by the specification.

Methods inherited from class org.jomc.model.Specification

clone, getAny, getAnyElement, getAnyElement, getAnyElements, getAnyElements, getAnyObject, getAnyObjects, getClazz, getIdentifier, getMultiplicity, getProperties, getScope, getVendor, getVersion, isClassDeclaration, setClassDeclaration, setClazz, setIdentifier, setMultiplicity, setProperties, setScope, 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

RuntimeSpecification

public RuntimeSpecification(Specification specification)

Creates a new RuntimeSpecification instance by deeply copying a given Specification instance.

Parameters:

specification - The instance to copy.

Throws:

NullPointerException - if specification is null.

RuntimeSpecification

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

Creates a new RuntimeSpecification instance.

Method Detail

getJavaClass

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

Gets the Java class of the specification 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 Specification

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 specification or null, if the specification 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:

Specification.getClazz(), RuntimeModelObjects.clear()

getJavaTypeName

public JavaTypeName getJavaTypeName()
                             throws ModelObjectException

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

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 Specification

Returns:

The Java type name of the type referenced by the specification or null, if the specification 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