uk.co.agena.minerva.util.model
Class NameDescription

java.lang.Object
  extended by uk.co.agena.minerva.util.model.NameDescription
All Implemented Interfaces:
java.lang.Cloneable

public class NameDescription
extends java.lang.Object
implements java.lang.Cloneable

The NameDescription class is used to encapsulate name and description information for objects in Minerva. This class is used wherever a simple String name attribute is deemed insufficient. The NameDescription consists of a short description and a long description.


Constructor Summary
NameDescription()
          Default constructor.
NameDescription(java.lang.String shortDescription, java.lang.String longDescription)
          Constructs a NameDescription with the specified short and long descriptions.
 
Method Summary
 java.lang.Object clone()
          Makes a copy of this NameDescription object.
 java.lang.String getLongDescription()
          Returns the long description of the NameDescription object.
 java.lang.String getShortDescription()
          Returns the short description of the NameDescription object.
 void setLongDescription(java.lang.String longDescription)
          Sets the long description of the NameDescription object.
 void setShortDescription(java.lang.String shortDescription)
          Sets the short description of the NameDescription object.
 java.lang.String toString()
          Creates a String representation of the NameDescription.
 
Methods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

NameDescription

public NameDescription()
Default constructor.


NameDescription

public NameDescription(java.lang.String shortDescription,
                       java.lang.String longDescription)
Constructs a NameDescription with the specified short and long descriptions.

Parameters:
shortDescription - the short description of the object
longDescription - the long description of the object
Method Detail

getShortDescription

public java.lang.String getShortDescription()
Returns the short description of the NameDescription object.

Returns:
the short description

setShortDescription

public void setShortDescription(java.lang.String shortDescription)
Sets the short description of the NameDescription object.

Parameters:
shortDescription - the new short description

getLongDescription

public java.lang.String getLongDescription()
Returns the long description of the NameDescription object.

Returns:
the long description

setLongDescription

public void setLongDescription(java.lang.String longDescription)
Sets the long description of the NameDescription object.

Parameters:
longDescription - the new long description

toString

public java.lang.String toString()
Creates a String representation of the NameDescription. This representation consists of the short and long description separated by a colon e.g. "Arsenal : A great football team".

Overrides:
toString in class java.lang.Object

clone

public java.lang.Object clone()
Makes a copy of this NameDescription object.

Overrides:
clone in class java.lang.Object
Returns:
a copy of this NameDescription object


Copyright © 2006 Agena Ltd. All Rights Reserved.