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

Go to download

Show more of this group Show more artifacts with this name
Show all versions of rewrite-api Show documentation

There is a newer version: 10.0.2.Final

/*
 * Copyright 2013 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 verify or restrict values before they are converted via the {@link Converter} API.
 * 
 * @see {@link Parameter} {@link Transposition} {@link Validator} {@link Converter}
 * @author Lincoln Baxter, III
 */
public interface Constraint extends ParameterConfigurator
{
   /**
    * Return true if this {@link Constraint} is satisfied by the given value; otherwise, return
    * false.
    */
   boolean isSatisfiedBy(Rewrite event, EvaluationContext context, T value);
}