org.constretto.ConstrettoConfiguration Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of constretto-api Show documentation
There is a newer version: 3.0.0-BETA4
/*
 * Copyright 2008 the original author or authors.
 *
 * 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.constretto;

import org.constretto.exception.ConstrettoConversionException;
import org.constretto.exception.ConstrettoException;
import org.constretto.exception.ConstrettoExpressionException;

import java.util.Properties;

/**
 * Client interface.
 *
 * @author Kaare Nilsen
 */
public interface ConstrettoConfiguration extends Iterable{

    /**
     * Looks up an expression in the configuration.
     *
     * @param expression   The expression to look up
     * @param defaultValue The value to return of no value found for the expression
     * @param           The target Type
     * @return The converted value for the expression, or the passed default value if expression not found, or conversion error occured.
     * @throws ConstrettoExpressionException If a valid converter is not found for the target Type
     */
     K evaluateTo(String expression, K defaultValue) throws ConstrettoExpressionException;

    /**
     * Looks up an expression in the configuration.
     *
     * @param targetClass the class to convert the value
     * @param expression  the expression to look up
     * @param          the target Type
     * @return The converted value for the expression.
     * @throws ConstrettoExpressionException if the expression is malformed, or a value not found for the expression
     * @throws ConstrettoConversionException If a conversion error occures for the resolved value
     */
     K evaluateTo(Class targetClass, String expression) throws ConstrettoExpressionException, ConstrettoConversionException;

    String evaluateToString(String expression) throws ConstrettoException;

    Boolean evaluateToBoolean(String expression) throws ConstrettoException;

    Double evaluateToDouble(String expression) throws ConstrettoException;

    Long evaluateToLong(String expression) throws ConstrettoException;

    Float evaluateToFloat(String expression) throws ConstrettoException;

    Integer evaluateToInt(String expression) throws ConstrettoException;

    Short evaluateToShort(String expression) throws ConstrettoException;

    Byte evaluateToByte(String expression) throws ConstrettoException;

     T as(Class configurationClass) throws ConstrettoException;

     T on(T objectToConfigure) throws ConstrettoException;

    ConstrettoConfiguration at(String expression) throws ConstrettoException;

    ConstrettoConfiguration from(String expression) throws ConstrettoException;

    boolean hasValue(String expression);
}