org.ocpsoft.rewrite.param.Converter Maven / Gradle / Ivy

Go to download
/*
 * Copyright 2011 Lincoln Baxter, III
 * 
 * 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 org.ocpsoft.rewrite.param;

import org.ocpsoft.rewrite.context.EvaluationContext;
import org.ocpsoft.rewrite.event.Rewrite;

/**
 * Used to convert {@link Parameter} values before they are verified by the {@link Validator} API.
 * 
 * @see {@link Parameter} {@link Constraint} {@link Transposition} {@link Validator}
 * @author Lincoln Baxter, III
 * 
 */
public interface Converter extends ParameterConfigurator
{
   /**
    * Convert the given {@link Object} into the expected type. Should return null if the object cannot be converted.
    */
   T convert(Rewrite event, EvaluationContext context, Object value);
}