org.jomc.ri.model
Class RuntimeImplementations

Package class diagram package RuntimeImplementations
java.lang.Object
  extended by org.jomc.model.ModelObject
      extended by org.jomc.model.Implementations
          extended by org.jomc.ri.model.RuntimeImplementations
All Implemented Interfaces:
Cloneable, RuntimeModelObject

@Generated(value="org.jomc.tools.SourceFileProcessor 1.2.2",
           comments="See http://jomc.sourceforge.net/jomc/1.2/jomc-tools-1.2.2")
public class RuntimeImplementations
extends Implementations
implements RuntimeModelObject

Runtime Implementations.

Identifier:
org.jomc.ri.model.RuntimeImplementations
Name:
JOMC RI RuntimeImplementations
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.Implementations
implementation, reference
 
Fields inherited from class org.jomc.model.ModelObject
authors, createDate, deprecated, documentation, MODEL_PUBLIC_ID, modelVersion
 
Constructor Summary
RuntimeImplementations()
          Creates a new RuntimeImplementations instance.
RuntimeImplementations(Implementations implementations)
          Creates a new RuntimeImplementations instance by deeply copying a given Implementations instance.
 
Method Summary
 void clear()
          Clears shared runtime state.
 void gc()
          Handles shared runtime state.
 Implementation getImplementation(Class<?> implementation)
          Gets an implementation for a given class from the list of implementations.
 Implementation getImplementation(String implementation)
          Gets an implementation for a given identifier from the list of implementations.
 Implementation getImplementationByName(String name)
          Gets an implementation for a given name from the list of implementations.
 ImplementationReference getReference(String implementation)
          Gets an implementation reference for a given identifier from the list of references.
 
Methods inherited from class org.jomc.model.Implementations
clone, getImplementation, 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

RuntimeImplementations

public RuntimeImplementations(Implementations implementations)
Creates a new RuntimeImplementations instance by deeply copying a given Implementations instance.

Parameters:
implementations - The instance to copy.
Throws:
NullPointerException - if implementations is null.

RuntimeImplementations

@Generated(value="org.jomc.tools.SourceFileProcessor 1.2.2",
           comments="See http://jomc.sourceforge.net/jomc/1.2/jomc-tools-1.2.2")
public RuntimeImplementations()
Creates a new RuntimeImplementations instance.

Method Detail

getImplementation

public Implementation getImplementation(String implementation)
Gets an implementation for a given identifier from the list of implementations.

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:
getImplementation in class Implementations
Parameters:
implementation - The identifier of the implementation to return.
Returns:
The first matching implementation or null, if no such implementation is found.
Throws:
NullPointerException - if implementation is null.
See Also:
Implementations.getImplementation(), Implementation.getIdentifier(), clear()

getImplementation

public Implementation getImplementation(Class<?> implementation)
Gets an implementation for a given class from the list of implementations.

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:
getImplementation in class Implementations
Parameters:
implementation - The class of the implementation to return.
Returns:
The first matching implementation or null, if no such implementation is found.
Throws:
NullPointerException - if implementation is null.
See Also:
Implementations.getImplementation(), Implementation.isClassDeclaration(), Implementation.getClazz(), clear()

getImplementationByName

public Implementation getImplementationByName(String name)
Gets an implementation for a given name from the list of implementations.

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:
getImplementationByName in class Implementations
Parameters:
name - The name of the implementation to return.
Returns:
The first matching implementation or null, if no such implementation is found.
Throws:
NullPointerException - if name is null.
See Also:
Implementations.getImplementation(), Implementation.getName(), clear()

getReference

public ImplementationReference getReference(String implementation)
Gets an implementation reference for a given identifier 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 Implementations
Parameters:
implementation - The identifier of the reference to return.
Returns:
The first matching implementation reference or null, if no such reference is found.
Throws:
NullPointerException - if implementation is null.
See Also:
Implementations.getReference(), ImplementationReference.getIdentifier(), 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


Copyright © 2005-2012 The JOMC Project. All Rights Reserved.Get JOMC at SourceForge.net. Fast, secure and Free Open Source software downloads
Please note that this documentation is maintained by non-native english speaking authors. As such, you may encounter phrases or wordings which seem imprecise or may even have a totally different meaning to native english speaking readers than what the individual author was trying to express. If you are a native english speaking reader and find any such phrases or wordings we kindly ask you to send an email to the corresponding author and help us improve this documentation in order to avoid misunderstandings. You will find the authors' email addresses at the top of each class. Please accept our apologies for any inconvenience caused.