C++ Client API Reference for Oracle Coherence: coherence/lang/Integer16.hpp Source File

00001 /*
00002  * Copyright (c) 2000, 2020, Oracle and/or its affiliates.
00003  *
00004  * Licensed under the Universal Permissive License v 1.0 as shown at
00005  * http://oss.oracle.com/licenses/upl.
00006  */
00007 #ifndef COH_INTEGER16_HPP
00008 #define COH_INTEGER16_HPP
00009 
00010 #include "coherence/lang/compatibility.hpp"
00011 
00012 #include "coherence/lang/Number.hpp"
00013 #include "coherence/lang/Primitive.hpp"
00014 #include "coherence/lang/TypedHandle.hpp"
00015 
00016 COH_OPEN_NAMESPACE2(coherence,lang)
00017 
00018 
00019 /**
00020 * An immutable 16-bit integer value.
00021 *
00022 * @author jh  2008.04.01
00023 */
00024 class COH_EXPORT Integer16
00025     : public cloneable_spec<Integer16,
00026         extends<Primitive<int16_t> >,
00027         implements<Number, Comparable> >
00028     {
00029     friend class factory<Integer16>;
00030 
00031     // ----- constructors ---------------------------------------------------
00032 
00033     private:
00034         /**
00035         * Create a new Integer16 instance.
00036         *
00037         * @param n the value of the new Integer16
00038         */
00039         Integer16(int16_t n);
00040 
00041         /**
00042         * Copy constructor.
00043         */
00044         Integer16(const Integer16& that);
00045 
00046 
00047     // ----- Number interface -----------------------------------------------
00048 
00049     public:
00050         /**
00051         * {@inheritDoc}
00052         */
00053         virtual int16_t getInt16Value() const;
00054 
00055         /**
00056         * {@inheritDoc}
00057         */
00058         virtual int32_t getInt32Value() const;
00059 
00060         /**
00061         * {@inheritDoc}
00062         */
00063         virtual int64_t getInt64Value() const;
00064 
00065         /**
00066         * {@inheritDoc}
00067         */
00068         virtual float32_t getFloat32Value() const;
00069 
00070         /**
00071         * {@inheritDoc}
00072         */
00073         virtual float64_t getFloat64Value() const;
00074 
00075 
00076     // ----- Comparable interface -------------------------------------------
00077 
00078     public:
00079         /**
00080         * {@inheritDoc}
00081         */
00082         virtual int32_t compareTo(Object::View v) const;
00083 
00084 
00085     // ----- static methods -------------------------------------------------
00086 
00087     public:
00088         /**
00089         * Factory method to produce Integer16 objects with an optimization
00090         * that uses cached objects for all relatively-low numbers.
00091         *
00092         * @param n  an int16_t
00093         *
00094         * @return an Integer16 whose value is the passed int16_t
00095         */
00096         static Handle valueOf(int16_t n);
00097 
00098 
00099     // ----- constants ------------------------------------------------------
00100 
00101     public:
00102         /**
00103         * A constant for the minimum representable value.
00104         */
00105         static const int16_t min_value = (int16_t) 0x8000;
00106 
00107         /**
00108         * A constant for the maximum representable value.
00109         */
00110         static const int16_t max_value = 0x7FFF;
00111     };
00112 
00113 COH_CLOSE_NAMESPACE2
00114 
00115 #endif // COH_INTEGER16_HPP