/*
* Copyright 2008-present MongoDB, Inc.
*
* 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.bson;
import org.bson.types.Decimal128;
Base class for the three numeric BSON types. This class mirrors the functionality provided by java.lang.Number
. Since: 3.0
/**
* Base class for the three numeric BSON types. This class mirrors the functionality provided by {@code java.lang.Number}.
*
* @since 3.0
*/
public abstract class BsonNumber extends BsonValue {
Returns the value of the specified number as an int
, which may involve rounding or truncation. Returns: the numeric value represented by this object after conversion to type int
.
/**
* Returns the value of the specified number as an {@code int}, which may involve rounding or truncation.
*
* @return the numeric value represented by this object after conversion to type {@code int}.
*/
public abstract int intValue();
Returns the value of the specified number as an long
, which may involve rounding or truncation. Returns: the numeric value represented by this object after conversion to type long
.
/**
* Returns the value of the specified number as an {@code long}, which may involve rounding or truncation.
*
* @return the numeric value represented by this object after conversion to type {@code long}.
*/
public abstract long longValue();
Returns the value of the specified number as a double
, which may involve rounding. Returns: the numeric value represented by this object after conversion to type double
.
/**
* Returns the value of the specified number as a {@code double}, which may involve rounding.
*
* @return the numeric value represented by this object after conversion to type {@code double}.
*/
public abstract double doubleValue();
Returns the value of the specified number as a Decimal128
, which may involve rounding. Returns: the numeric value represented by this object after conversion to type Decimal128
. Since: 3.4
/**
* Returns the value of the specified number as a {@code Decimal128}, which may involve rounding.
*
* @return the numeric value represented by this object after conversion to type {@code Decimal128}.
* @since 3.4
*/
public abstract Decimal128 decimal128Value();
}