gov.sandia.cognition.data.convert

Class IdentityDataConverter<DataType>

java.lang.Object

gov.sandia.cognition.util.AbstractCloneableSerializable

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

Constructors

Constructor and Description
IdentityDataConverter() Creates a new IdentityDataConverter.

Method Summary

Methods

Modifier and Type	Method and Description
IdentityDataConverter<DataType>	clone()
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()

Specified by:

clone in interface CloneableSerializable

Overrides:

clone in class AbstractCloneableSerializable

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.