| Classes in this File | Line Coverage | Branch Coverage | Complexity | ||||
| NumericElement |
|
| 1.0;1 |
| 1 | /* | |
| 2 | * #%L | |
| 3 | * NumericElement.java - mongodb-async-driver - Allanbank Consulting, Inc. | |
| 4 | * %% | |
| 5 | * Copyright (C) 2011 - 2014 Allanbank Consulting, Inc. | |
| 6 | * %% | |
| 7 | * Licensed under the Apache License, Version 2.0 (the "License"); | |
| 8 | * you may not use this file except in compliance with the License. | |
| 9 | * You may obtain a copy of the License at | |
| 10 | * | |
| 11 | * http://www.apache.org/licenses/LICENSE-2.0 | |
| 12 | * | |
| 13 | * Unless required by applicable law or agreed to in writing, software | |
| 14 | * distributed under the License is distributed on an "AS IS" BASIS, | |
| 15 | * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | |
| 16 | * See the License for the specific language governing permissions and | |
| 17 | * limitations under the License. | |
| 18 | * #L% | |
| 19 | */ | |
| 20 | ||
| 21 | package com.allanbank.mongodb.bson; | |
| 22 | ||
| 23 | /** | |
| 24 | * NumericElement provides a common interface for all numeric {@link Element}s. | |
| 25 | * | |
| 26 | * @api.yes This interface is part of the driver's API. Public and protected | |
| 27 | * members will be deprecated for at least 1 non-bugfix release | |
| 28 | * (version numbers are <major>.<minor>.<bugfix>) | |
| 29 | * before being removed or modified. | |
| 30 | * @copyright 2012-2013, Allanbank Consulting, Inc., All Rights Reserved | |
| 31 | */ | |
| 32 | public interface NumericElement extends Element { | |
| 33 | ||
| 34 | /** | |
| 35 | * Returns the value cast to a double. | |
| 36 | * <p> | |
| 37 | * <em>Note</em>: There may be a loss of precision using this method if the | |
| 38 | * {@link NumericElement} is not a | |
| 39 | * {@link com.allanbank.mongodb.bson.element.DoubleElement}. </em> | |
| 40 | * | |
| 41 | * @return The numeric value as a double. | |
| 42 | */ | |
| 43 | public double getDoubleValue(); | |
| 44 | ||
| 45 | /** | |
| 46 | * Returns the value cast to an integer. | |
| 47 | * <p> | |
| 48 | * <em>Note</em>: There may be a loss of precision using this method if the | |
| 49 | * {@link NumericElement} is not a | |
| 50 | * {@link com.allanbank.mongodb.bson.element.IntegerElement}. </em> | |
| 51 | * | |
| 52 | * @return The numeric value as a double. | |
| 53 | */ | |
| 54 | public int getIntValue(); | |
| 55 | ||
| 56 | /** | |
| 57 | * Returns the value cast to a long. | |
| 58 | * <p> | |
| 59 | * <em>Note</em>: There may be a loss of precision using this method if the | |
| 60 | * {@link NumericElement} is not a | |
| 61 | * {@link com.allanbank.mongodb.bson.element.LongElement}. </em> | |
| 62 | * | |
| 63 | * @return The numeric value as a double. | |
| 64 | */ | |
| 65 | public long getLongValue(); | |
| 66 | } |