Replaceable.java

/*******************************************************************************
 * Copyright 2014 Felipe Takiyama
 * 
 * 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 br.usp.poli.takiyama.prv;

/**
 * Class that represents objects over which {@link Substitution}
 * is applicable.
 */
public interface Replaceable<T> {
	
	/**
	 * Applies the specified substitution to the Replaceable object.
	 * <p>
	 * If the specified substitution does not apply to the object, then 
	 * returns the object unchanged. If the result of applying the 
	 * substitution in this object has an invalid state, this method
	 * should throw an {@link IllegalArgumentException}.
	 * </p>
	 * 
	 * @param s The substitution to apply
	 * @return The object that results from the application of the
	 * specified substitution
	 */
	public T apply(Substitution s); 
}