com.amazon.ion.IonNumber Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of ion-java Show documentation

A Java implementation of the Amazon Ion data notation.

There is a newer version: 1.11.9

/*
 * Copyright 2007-2019 Amazon.com, Inc. or its affiliates. All Rights Reserved.
 *
 * Licensed under the Apache License, Version 2.0 (the "License").
 * You may not use this file except in compliance with the License.
 * A copy of the License is located at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * or in the "license" file accompanying this file. This file 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 com.amazon.ion;

import java.math.BigDecimal;

/**
 * Common functionality of Ion {@code int}, {@code decimal}, and {@code float}
 * types.
 * 
 * WARNING: This interface should not be implemented or extended by
 * code outside of this library.
 */
public interface IonNumber
    extends IonValue
{
    /**
     * Gets the value of this Ion number as a {@link BigDecimal}.
     *
     * 
This method will throw an exception for non-null, non-numeric values.
     * It's recommended to call {@link #isNumericValue()} before calling
     * this method.
     *
     * Negative zero is supported by {@link IonDecimal} and {@link IonFloat},
     * but not by {@link BigDecimal}. If you need to distinguish positive and
     * negative zero, you should call {@link IonDecimal#decimalValue()} or
     * {@link IonFloat#doubleValue()} after casting to the appropriate type.
     *
     * @return the {@link BigDecimal} value, or {@code null} if
     * {@code this.isNullValue()}.
     *
     * @throws NumberFormatException if this value is {@code nan},
     * {@code +inf}, or {@code -inf}, because {@link BigDecimal} cannot
     * represent those values.
     */
    public BigDecimal bigDecimalValue();

    /**
     * Determines whether this value is numeric. Returns true if this value
     * is none of {@code null}, {@code nan}, {@code +inf}, and {@code -inf},
     * and false if it is any of them.
     *
     * @return a checked condition whether this value is numeric.
     */
    public boolean isNumericValue();
}