org.apache.commons.collections.functors
Class MapTransformer

java.lang.Object
  org.apache.commons.collections.functors.MapTransformer

All Implemented Interfaces:

java.io.Serializable, Transformer

public final class MapTransformer
extends java.lang.Object
implements Transformer, java.io.Serializable

Transformer implementation that returns the value held in a specified map using the input parameter as a key.

Since:

Commons Collections 3.0

Version:

$Revision: 646777 $ $Date: 2008-04-10 13:33:15 +0100 (Thu, 10 Apr 2008) $

Author:

Stephen Colebourne

See Also:

Serialized Form

Method Summary

static Transformer	getInstance(java.util.Map map) Factory to create the transformer.
java.util.Map	getMap() Gets the map to lookup in.
java.lang.Object	transform(java.lang.Object input) Transforms the input to result by looking it up in a Map.

Methods inherited from class java.lang.Object

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

Method Detail

getInstance

public static Transformer getInstance(java.util.Map map)

Factory to create the transformer.

If the map is null, a transformer that always returns null is returned.

Parameters:

map - the map, not cloned

Returns:

the transformer

transform

public java.lang.Object transform(java.lang.Object input)

Transforms the input to result by looking it up in a Map.

Specified by:

transform in interface Transformer

Parameters:

input - the input object to transform

Returns:

the transformed result

getMap

public java.util.Map getMap()

Gets the map to lookup in.

Returns:

the map

Since:

Commons Collections 3.1