org.jomc.ri.model

Class RuntimeMessages

java.lang.Object

org.jomc.model.ModelObject

org.jomc.model.Messages

org.jomc.ri.model.RuntimeMessages

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

Constructors

Constructor and Description
RuntimeMessages() Creates a new RuntimeMessages instance.
RuntimeMessages(Messages messages) Creates a new RuntimeMessages instance by deeply copying a given Messages instance.

Method Summary

Methods

Modifier and Type	Method and Description
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.6",
           comments="See http://www.jomc.org/jomc/1.6/jomc-tools-1.6")
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