Transposition.java

/*
 * Copyright 2013 <a href="mailto:lincolnbaxter@gmail.com">Lincoln Baxter, III</a>
 *
 * 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 modify {@link Parameter} values after they have been verified by the {@link Constraint} API. (Cannot be used
 * to change the type of the value, for that, see {@link org.ocpsoft.rewrite.param.Converter})
 * 
 * @see {@link Parameter} {@link Constraint} {@link Validator} {@link Converter}
 * @author <a href="mailto:lincolnbaxter@gmail.com">Lincoln Baxter, III</a>
 */
public interface Transposition<S> extends ParameterConfigurator
{
   /**
    * Perform an operation on the given value.
    */
   S transpose(Rewrite event, EvaluationContext context, S value);
}