org.jdice.calc.NumConverter Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of jcalc Show documentation

Fluent Java API for easier work with numbers, writing formula and calculations in Java.

The newest version!

/*
 * Copyright 2014 Davor Sauer
 *
 * 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.jdice.calc;

import java.math.BigDecimal;

import org.jdice.calc.internal.CacheExtension;

/**
 * Interface that define methods for conversion of custom Object to BigDecimal 
 * with which JCalc API knows to work.
 * 
 * @author Davor Sauer 
 * @see {@link CacheExtension#setNumConverter(Class, Class)}
 * @param 
 */
public interface NumConverter {

    /**
     * Convert object to BigDecimal
     * @param object
     * @return BigDecimal
     * @throws Exception
     */
    public BigDecimal toNum(T object) throws Exception;
    
    /**
     * Convert Num to custom object
     * @param value
     * @return T
     */
    public T fromNum(Num value);
    
}