org.protempa.proposition.value.NumericalValue Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of protempa-framework Show documentation

Protempa Framework is the core of Protempa.

There is a newer version: 5.2-Alpha-2

/*
 * #%L
 * Protempa Framework
 * %%
 * Copyright (C) 2012 - 2013 Emory University
 * %%
 * 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.
 * #L%
 */
package org.protempa.proposition.value;

import java.math.BigDecimal;

/**
 * Represents numerical values.
 * 
 * @author Andrew Post
 */
public interface NumericalValue extends OrderedValue {
    
    /**
     * Gets this value as a number.
     * 
     * @return a {@link Number}.
     */
    Number getNumber();

    /**
     * Gets this value as a {@link BigDecimal}.
     * 
     * @return a {@link BigDecimal}.
     */
    BigDecimal getBigDecimal();

    /**
     * Gets this value as a double.
     * 
     * @return a {@link double}.
     */
    double doubleValue();
    
    /**
     * Gets the number value component of this numerical value.
     * 
     * @return a {@link NumberValue}.
     */
    NumberValue getNumberValue();

    @Override
    NumericalValueBuilder asBuilder();
    
}