gov.sandia.cognition.data.convert
Class IdentityDataConverter<DataType>

java.lang.Object
  extended by gov.sandia.cognition.util.AbstractCloneableSerializable
      extended by gov.sandia.cognition.data.convert.IdentityDataConverter<DataType>
Type Parameters:
DataType - The data type that is allowed.
All Implemented Interfaces:
DataConverter<DataType,DataType>, ReversibleDataConverter<DataType,DataType>, Evaluator<DataType,DataType>, ReversibleEvaluator<DataType,DataType,DataConverter<? super DataType,? extends DataType>>, CloneableSerializable, Serializable, Cloneable

public class IdentityDataConverter<DataType>
extends AbstractCloneableSerializable
implements ReversibleDataConverter<DataType,DataType>

A pass-through converter that just returns the given value.

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

Constructor Summary
IdentityDataConverter()
          Creates a new IdentityDataConverter.
 
Method Summary
 IdentityDataConverter<DataType> clone()
          This makes public the clone method on the Object class and removes the exception that it throws.
static
<DataType> IdentityDataConverter<DataType>
create()
          Convenience method to create a new IdentityDataConverter.
 DataType evaluate(DataType input)
          Returns the given input.
 IdentityDataConverter<DataType> reverse()
          The reverse converter is this converter, since it is an identity converter.
 
Methods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

IdentityDataConverter

public IdentityDataConverter()
Creates a new IdentityDataConverter.

Method Detail

clone

public IdentityDataConverter<DataType> 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.

evaluate

public DataType evaluate(DataType input)
Returns the given input.

Specified by:
evaluate in interface Evaluator<DataType,DataType>
Parameters:
input - The input value.
Returns:
The input value.

reverse

public IdentityDataConverter<DataType> reverse()
The reverse converter is this converter, since it is an identity converter.

Specified by:
reverse in interface ReversibleDataConverter<DataType,DataType>
Specified by:
reverse in interface ReversibleEvaluator<DataType,DataType,DataConverter<? super DataType,? extends DataType>>
Returns:
The reverse converter is this converter.

create

public static <DataType> IdentityDataConverter<DataType> create()
Convenience method to create a new IdentityDataConverter.

Type Parameters:
DataType - The data type that is allowed.
Returns:
A new identity data converter.