org.jomc.ri.model
Class RuntimeArguments

Package class diagram package RuntimeArguments
java.lang.Object
  extended by org.jomc.model.ModelObject
      extended by org.jomc.model.Arguments
          extended by org.jomc.ri.model.RuntimeArguments
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 RuntimeArguments
extends Arguments
implements RuntimeModelObject

Runtime Arguments.

Identifier:
org.jomc.ri.model.RuntimeArguments
Name:
JOMC RI RuntimeArguments
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.Arguments
argument
 
Fields inherited from class org.jomc.model.ModelObject
authors, createDate, deprecated, documentation, MODEL_PUBLIC_ID, modelVersion
 
Constructor Summary
RuntimeArguments()
          Creates a new RuntimeArguments instance.
RuntimeArguments(Arguments arguments)
          Creates a new RuntimeArguments instance by deeply copying a given Arguments instance.
 
Method Summary
 void clear()
          Clears shared runtime state.
 void gc()
          Handles shared runtime state.
 Argument getArgument(int index)
          Gets an argument for a given index from the list of arguments.
 Argument getArgument(String name)
          Gets an argument for a given name from the list of arguments.
 
Methods inherited from class org.jomc.model.Arguments
clone, getArgument
 
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

RuntimeArguments

public RuntimeArguments(Arguments arguments)
Creates a new RuntimeArguments instance by deeply copying a given Arguments instance.

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

RuntimeArguments

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

Method Detail

getArgument

public Argument getArgument(String name)
Gets an argument for a given name from the list of arguments.

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

getArgument

public Argument getArgument(int index)
Gets an argument for a given index from the list of arguments.

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:
getArgument in class Arguments
Parameters:
index - The index of the argument to return.
Returns:
The first matching argument or null, if no such argument is found.
Throws:
IndexOutOfBoundsException - if index is negative, greater or equal to the size of the list of arguments.
See Also:
Arguments.getArgument(), Argument.getIndex(), 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.