org.simpleframework.xml.filter.MapFilter Maven / Gradle / Ivy
/*
* MapFilter.java May 2006
*
* Copyright (C) 2006, Niall Gallagher
*
* This library is free software; you can redistribute it and/or
* modify it under the terms of the GNU Lesser General Public
* License as published by the Free Software Foundation.
*
* This library is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General
* Public License along with this library; if not, write to the
* Free Software Foundation, Inc., 59 Temple Place, Suite 330,
* Boston, MA 02111-1307 USA
*/
package org.simpleframework.xml.filter;
import java.util.Map;
/**
* The MapFilter object is a filter that can make use
* of user specified mappings for replacement. This filter can be
* given a Map of name value pairs which will be used
* to resolve a value using the specified mappings. If there is
* no match found the filter will delegate to the provided filter.
*
* @author Niall Gallagher
*/
public class MapFilter implements Filter {
/**
* This will resolve the replacement if no mapping is found.
*/
private Filter filter;
/**
* This contains a collection of user specified mappings.
*/
private Map map;
/**
* Constructor for the MapFilter object. This will
* use the specified mappings to resolve replacements. If this
* map does not contain a requested mapping null is resolved.
*
* @param map this contains the user specified mappings
*/
public MapFilter(Map map) {
this(map, null);
}
/**
* Constructor for the MapFilter object. This will
* use the specified mappings to resolve replacements. If this
* map does not contain a requested mapping the provided filter
* is used to resolve the replacement text.
*
* @param map this contains the user specified mappings
* @param filter this is delegated to if the map fails
*/
public MapFilter(Map map, Filter filter) {
this.filter = filter;
this.map = map;
}
/**
* Replaces the text provided with the value resolved from the
* specified Map. If the map fails this will
* delegate to the specified Filter if it is not
* a null object. If no match is found a null is returned.
*
* @param text this is the text value to be replaced
*
* @return this will return the replacement text resolved
*/
public String replace(String text) {
Object value = null;
if(map != null) {
value = map.get(text);
}
if(value != null) {
return value.toString();
}
if(filter != null) {
return filter.replace(text);
}
return null;
}
}