net.sf.dozer.util.mapping.converters.ConfigurableCustomConverter Maven / Gradle / Ivy

Go to download
/*
 * Copyright 2005-2007 the original author or authors.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package net.sf.dozer.util.mapping.converters;

/**
 * Public custom converter interface.
 * 
 * In the Dozer mapping file(s), you can add some XML to tell Dozer to use a custom converter for certain class A and
 * class B types. When a custom converter is specified for a class A and class B combination, Dozer will invoke the
 * custom converter to perform the data mapping instead of the standard mapping logic.
 * 
 * This interface also gives you the opportunity to send a configuration parameter to it
 * 
 * http://dozer.sourceforge.net/documentation/customconverter.html
 * 
 * 
 * @author johnsen.knut-erik
 * 
 */
public interface ConfigurableCustomConverter extends CustomConverterBase {

  Object convert(Object existingDestinationFieldValue, Object sourceFieldValue, Class destinationClass, Class sourceClass, String param);
  
}