net.stickycode.coercion.Coercion Maven / Gradle / Ivy
/**
* Copyright (c) 2010 RedEngine Ltd, http://www.redengine.co.nz. All rights reserved.
*
* This program is licensed to you under the Apache License Version 2.0,
* and you may not use this file except in compliance with the Apache License Version 2.0.
* You may obtain a copy of the Apache License Version 2.0 at http://www.apache.org/licenses/LICENSE-2.0.
*
* Unless required by applicable law or agreed to in writing,
* software distributed under the Apache License Version 2.0 is distributed on an
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the Apache License Version 2.0 for the specific language governing permissions and limitations there under.
*/
package net.stickycode.coercion;
/**
* Contract for a converter of strings to a define type.
*
* @param The type that can be converted to
*/
public interface Coercion {
/**
* Coerce the given string value into the type represented by this coercion.
*
* @param value The string value to convert. WILL NOT be null.
* @return A non null string value
* @throws A subtype of {@link AbstractFailedToCoerceValueException} if the value was not valid
*/
T coerce(CoercionTarget type, String value)
throws AbstractFailedToCoerceValueException;
/**
* Return true if this coercion is applicable for the given target type
*/
boolean isApplicableTo(CoercionTarget type);
}