org.msgpack.value.IntegerValue Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of msgpack-core Show documentation
Core library of the MessagePack for Java
There is a newer version: 0.9.8
//
// MessagePack for Java
//
//    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.msgpack.value;

import org.msgpack.core.MessageFormat;

import java.math.BigInteger;

/**
 * The interface {@code IntegerValue} represents MessagePack's Integer type.
 *
 * MessagePack's Integer type can represent from -2⁶³ to 2⁶⁴-1.
 */
public interface IntegerValue
        extends NumberValue
{
    /**
     * Returns true if the value is in the range of [-2⁷ to 2⁷-1].
     */
    boolean isInByteRange();

    /**
     * Returns true if the value is in the range of [-2¹⁵ to 2¹⁵-1]
     */
    boolean isInShortRange();

    /**
     * Returns true if the value is in the range of [-2³¹ to 2³¹-1]
     */
    boolean isInIntRange();

    /**
     * Returns true if the value is in the range of [-2⁶³ to 2⁶³-1]
     */
    boolean isInLongRange();

    /**
     * Returns the most succinct MessageFormat type to represent this integer value.
     * @return
     */
    MessageFormat mostSuccinctMessageFormat();

    /**
     * Returns the value as a {@code byte}, otherwise throws an exception.
     *
     * @throws MessageIntegerOverflowException If the value does not fit in the range of {@code byte} type.
     */
    byte asByte();

    /**
     * Returns the value as a {@code short}, otherwise throws an exception.
     *
     * @throws MessageIntegerOverflowException If the value does not fit in the range of {@code short} type.
     */
    short asShort();

    /**
     * Returns the value as an {@code int}, otherwise throws an exception.
     *
     * @throws MessageIntegerOverflowException If the value does not fit in the range of {@code int} type.
     */
    int asInt();

    /**
     * Returns the value as a {@code long}, otherwise throws an exception.
     *
     * @throws MessageIntegerOverflowException If the value does not fit in the range of {@code long} type.
     */
    long asLong();

    /**
     * Returns the value as a {@code BigInteger}.
     */
    BigInteger asBigInteger();
}