org.apache.commons.collections.functors

Class MapTransformer

Implemented Interfaces:
Serializable, Transformer

public final class MapTransformer
extends Object
implements Transformer, Serializable

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

Version:
$Revision: 1.7 $ $Date: 2004/05/16 11:36:31 $

Author:
Stephen Colebourne

Since:
Commons Collections 3.0

Method Summary

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

Method Details

getInstance

public static Transformer getInstance(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


getMap

public Map getMap()
Gets the map to lookup in.

Returns:
the map

Since:
Commons Collections 3.1


transform

public Object transform(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


Copyright © 2001-2005 Apache Software Foundation. All Rights Reserved.