gov.sandia.cognition.text
Class DefaultTextual

java.lang.Object
  extended by gov.sandia.cognition.util.AbstractCloneableSerializable
      extended by gov.sandia.cognition.text.AbstractTextual
          extended by gov.sandia.cognition.text.DefaultTextual
All Implemented Interfaces:
Textual, CloneableSerializable, Serializable, Cloneable

public class DefaultTextual
extends AbstractTextual

A default implementation of the Textual interface that just stores a string value.

Since:
3.1
Author:
Justin Basilico
See Also:
Serialized Form

Field Summary
protected  String text
          The text value.
 
Constructor Summary
DefaultTextual()
          Creates a new DefaultTextual containing the empty string.
DefaultTextual(String text)
          Creates a new DefaultTextual containing the given text.
DefaultTextual(Textual other)
          Creates a new DefaultTextual that takes the string text value from the given Textual object.
 
Method Summary
 DefaultTextual clone()
          This makes public the clone method on the Object class and removes the exception that it throws.
 boolean equals(Object other)
           
 String getText()
          Gets the text value in this object.
 int hashCode()
           
 void setText(String text)
          Sets the text value in this object.
 
Methods inherited from class gov.sandia.cognition.text.AbstractTextual
readText, toString
 
Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, wait
 

Field Detail

text

protected String text
The text value.

Constructor Detail

DefaultTextual

public DefaultTextual()
Creates a new DefaultTextual containing the empty string.


DefaultTextual

public DefaultTextual(String text)
Creates a new DefaultTextual containing the given text.

Parameters:
text - The text to store in the object.

DefaultTextual

public DefaultTextual(Textual other)
Creates a new DefaultTextual that takes the string text value from the given Textual object.

Parameters:
other - The other object to get the text from.
Method Detail

clone

public DefaultTextual clone()
Description copied from class: AbstractCloneableSerializable
This makes public the clone method on the Object class and removes the exception that it throws. Its default behavior is to automatically create a clone of the exact type of object that the clone is called on and to copy all primitives but to keep all references, which means it is a shallow copy. Extensions of this class may want to override this method (but call super.clone() to implement a "smart copy". That is, to target the most common use case for creating a copy of the object. Because of the default behavior being a shallow copy, extending classes only need to handle fields that need to have a deeper copy (or those that need to be reset). Some of the methods in ObjectUtil may be helpful in implementing a custom clone method. Note: The contract of this method is that you must use super.clone() as the basis for your implementation.

Specified by:
clone in interface CloneableSerializable
Overrides:
clone in class AbstractCloneableSerializable
Returns:
A clone of this object.

equals

public boolean equals(Object other)
Overrides:
equals in class Object

hashCode

public int hashCode()
Overrides:
hashCode in class Object

getText

public String getText()
Gets the text value in this object.

Returns:
The text value.

setText

public void setText(String text)
Sets the text value in this object.

Parameters:
text - The text value.