NumericNode.java

package tools.jackson.databind.node;

import java.math.BigDecimal;
import java.math.BigInteger;
import java.util.Optional;
import java.util.OptionalDouble;
import java.util.OptionalInt;
import java.util.OptionalLong;

import tools.jackson.core.JsonParser;

/**
 * Intermediate value node used for numeric nodes.
 */
public abstract class NumericNode
    extends ValueNode
{
    private static final long serialVersionUID = 3L;

    protected NumericNode() { }

    @Override
    public final JsonNodeType getNodeType()
    {
        return JsonNodeType.NUMBER;
    }

    // Overridden for type co-variance
    @Override
    public NumericNode deepCopy() { return this; }

    @Override
    protected final String _valueDesc() {
        return asString();
    }

    // // // Let's re-abstract so sub-classes handle them

    @Override
    public abstract JsonParser.NumberType numberType();

    @Override public abstract Number numberValue();

    @Override public abstract short shortValue();
    @Override public abstract short shortValue(short defaultValue);
    @Override public abstract Optional<Short> shortValueOpt();
    @Override public abstract short asShort();
    @Override public abstract short asShort(short defaultValue);
    @Override public abstract Optional<Short> asShortOpt();

    @Override public abstract int intValue();
    @Override public abstract int intValue(int defaultValue);
    @Override public abstract OptionalInt intValueOpt();
    @Override public abstract int asInt();
    @Override public abstract int asInt(int defaultValue);
    @Override public abstract OptionalInt asIntOpt();

    @Override public abstract long longValue();
    @Override public abstract long longValue(long defaultValue);
    @Override public abstract OptionalLong longValueOpt();
    @Override public abstract long asLong();
    @Override public abstract long asLong(long defaultValue);
    @Override public abstract OptionalLong asLongOpt();

    @Override public abstract BigInteger bigIntegerValue();
    @Override public abstract BigInteger bigIntegerValue(BigInteger defaultValue);
    @Override public abstract Optional<BigInteger> bigIntegerValueOpt();
    @Override public abstract BigInteger asBigInteger();
    @Override public abstract BigInteger asBigInteger(BigInteger defaultValue);
    @Override public abstract Optional<BigInteger> asBigIntegerOpt();

    @Override public abstract float floatValue();
    @Override public abstract float floatValue(float defaultValue);
    @Override public abstract Optional<Float> floatValueOpt();
    @Override public abstract float asFloat();
    @Override public abstract float asFloat(float defaultValue);
    @Override public abstract Optional<Float> asFloatOpt();

    @Override public abstract double doubleValue();
    @Override public abstract double doubleValue(double defaultValue);
    @Override public abstract OptionalDouble doubleValueOpt();
    @Override public abstract double asDouble();
    @Override public abstract double asDouble(double defaultValue);
    @Override public abstract OptionalDouble asDoubleOpt();

    @Override public abstract BigDecimal decimalValue();
    @Override public abstract BigDecimal decimalValue(BigDecimal defaultValue);
    @Override public abstract Optional<BigDecimal> decimalValueOpt();
    @Override public abstract BigDecimal asDecimal();
    @Override public abstract BigDecimal asDecimal(BigDecimal defaultValue);
    @Override public abstract Optional<BigDecimal> asDecimalOpt();

    @Override public abstract boolean canConvertToShort();
    @Override public abstract boolean canConvertToInt();
    @Override public abstract boolean canConvertToLong();

    /*
    /**********************************************************************
    /* General type coercions
    /**********************************************************************
     */

    @Override
    protected abstract String _asString();

    /*
    /**********************************************************************
    /* Extended API, public methods
    /**********************************************************************
     */

    /**
     * Convenience method for checking whether this node is a {@code NumericFPNode}
     * that contains non-zero fractional part (as opposed to only integer part).
     * Always returns false for integral {@link NumericNode}s (that is,
     * {@ode NumericIntNode}s).
     */
    public abstract boolean hasFractionalPart();

    /**
     * Method that can be used to determine whether this numeric value's in
     * part fits within Java 16-bit {@code short} type.
     */
    public abstract boolean inShortRange();

    /**
     * Method that can be used to determine whether this numeric value's in
     * part fits within Java 32-bit{@code int} type.
     */
    public abstract boolean inIntRange();

    /**
     * Method that can be used to determine whether this numeric value's in
     * part fits within Java 64-bit {@code long} type.
     */
    public abstract boolean inLongRange();

    /**
     * Convenience method for checking whether this node is a
     * {@link FloatNode} or {@link DoubleNode} that contains
     * "not-a-number" (NaN) value.
     */
    public abstract boolean isNaN();

    /*
    /**********************************************************************
    /* Extended API, unsafe access methods
    /**********************************************************************
     */

    /**
     * Method for sub-classes to implement; returns the underlying
     * value as a {@code short} without any checks (wrt NaN or value range),
     * so caller must ensure validity prior to calling
     */
    public abstract short _asShortValueUnchecked();

    /**
     * Method for sub-classes to implement; returns the underlying
     * value as a {@code int} without any checks (wrt NaN or value range),
     * so caller must ensure validity prior to calling
     */
    public abstract int _asIntValueUnchecked();

    /**
     * Method for sub-classes to implement; returns the underlying
     * value as a {@code long} without any checks (wrt NaN or value range),
     * so caller must ensure validity prior to calling
     */
    public abstract long _asLongValueUnchecked();
}