gov.sandia.cognition.util

Class AbstractNamed

java.lang.Object

gov.sandia.cognition.util.AbstractCloneableSerializable

gov.sandia.cognition.util.AbstractNamed

All Implemented Interfaces:

CloneableSerializable, Named, java.io.Serializable, java.lang.Cloneable

Direct Known Subclasses:

AbstractBayesianParameter, AbstractDocument, AbstractField, DefaultDistributionParameter, DefaultNamedValue

@CodeReview(reviewer="Kevin R. Dixon",
            date="2007-11-25",
            changesNeeded=false,
            comments="Looks fine")
public abstract class AbstractNamed
extends AbstractCloneableSerializable
implements Named

The AbstractNamed class implements the Named interface in a standard way by having a name field inside the object. It is provided for convenience for implementers not having to keep track of this field. It also overrides the toString method to return the name.

Since:

2.0

Author:

Justin Basilico

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected java.lang.String	name The name of the object.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractNamed() Creates a new instance of AbstractNamed.
protected	AbstractNamed(java.lang.String name) Creates a new instance of AbstractNamed with the given name.

Method Summary

Modifier and Type	Method and Description
AbstractNamed	clone() This makes public the clone method on the Object class and removes the exception that it throws.
java.lang.String	getName() Gets the name of the Object that it is called on.
void	setName(java.lang.String name) Sets the name of this Object.
java.lang.String	toString() The standard implementation of toString returns the name of the Named Object.

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

name

protected java.lang.String name

The name of the object.

Constructor Detail

AbstractNamed

protected AbstractNamed()

Creates a new instance of AbstractNamed. The default name is null.

AbstractNamed

protected AbstractNamed(java.lang.String name)

Creates a new instance of AbstractNamed with the given name.

Parameters:

name - The name.

Method Detail

clone

public AbstractNamed 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.

toString

public java.lang.String toString()

The standard implementation of toString returns the name of the Named Object.

Overrides:

toString in class java.lang.Object

Returns:

The name of the Object.

getName

public java.lang.String getName()

Description copied from interface: Named

Gets the name of the Object that it is called on.

Specified by:

getName in interface Named

Returns:

The name of the Object.

setName

public void setName(java.lang.String name)

Sets the name of this Object.

Parameters:

name - The new name for the Object.