org.jomc.ri.model
Class RuntimeMessages

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

Runtime Messages.

Identifier:
org.jomc.ri.model.RuntimeMessages
Name:
JOMC RI RuntimeMessages
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.Messages
message, reference
 
Fields inherited from class org.jomc.model.ModelObject
authors, createDate, deprecated, documentation, MODEL_PUBLIC_ID, modelVersion
 
Constructor Summary
RuntimeMessages()
          Creates a new RuntimeMessages instance.
RuntimeMessages(Messages messages)
          Creates a new RuntimeMessages instance by deeply copying a given Messages instance.
 
Method Summary
 void clear()
          Clears shared runtime state.
 void gc()
          Handles shared runtime state.
 Message getMessage(String name)
          Gets a message for a given name from the list of messages.
 MessageReference getReference(String name)
          Gets a message reference for a given name from the list of references.
 
Methods inherited from class org.jomc.model.Messages
clone, getMessage, 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

RuntimeMessages

public RuntimeMessages(Messages messages)
Creates a new RuntimeMessages instance by deeply copying a given Messages instance.

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

RuntimeMessages

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

Method Detail

getMessage

public Message getMessage(String name)
Gets a message for a given name from the list of messages.

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

getReference

public MessageReference getReference(String name)
Gets a message 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 Messages
Parameters:
name - The name of the message reference to return.
Returns:
The first matching message reference or null, if no such reference is found.
Throws:
NullPointerException - if name is null.
See Also:
Messages.getReference(), MessageReference.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


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.