C++ Client API Reference for Oracle Coherence: coherence/lang/Octet.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_OCTET_HPP
00008 #define COH_OCTET_HPP
00009 
00010 #include "coherence/lang/compatibility.hpp"
00011 
00012 #include "coherence/lang/Primitive.hpp"
00013 #include "coherence/lang/TypedHandle.hpp"
00014 
00015 COH_OPEN_NAMESPACE2(coherence,lang)
00016 
00017 
00018 /**
00019 * An immutable 8-bit unsigned value.
00020 *
00021 * @author jh  2008.04.01
00022 */
00023 class COH_EXPORT Octet
00024     : public cloneable_spec<Octet,
00025         extends<Primitive<octet_t> >,
00026         implements<Comparable> >
00027     {
00028     friend class factory<Octet>;
00029 
00030     // ----- constructors ---------------------------------------------------
00031 
00032     private:
00033         /**
00034         * Create a new Octet instance.
00035         *
00036         * @param b  the value of the new Octet
00037         *
00038         * @return the new Octet
00039         */
00040         Octet(octet_t b);
00041 
00042         /**
00043         * Copy constructor.
00044         */
00045         Octet(const Octet& that);
00046 
00047 
00048     // ----- Comparable interface -------------------------------------------
00049 
00050     public:
00051         /**
00052         * {@inheritDoc}
00053         */
00054         virtual int32_t compareTo(Object::View v) const;
00055 
00056 
00057     // ----- static methods -------------------------------------------------
00058 
00059     public:
00060         /**
00061         * Factory method to produce Octet objects with an optimization
00062         * that uses cached objects for all relatively-low values.
00063         *
00064         * @param b   an octet_t
00065         *
00066         * @return an Octet whose value is the passed octet_t
00067         */
00068         static Handle valueOf(octet_t b);
00069 
00070 
00071     // ----- constants ------------------------------------------------------
00072 
00073     public:
00074         /**
00075         * A constant for the minimum representable value.
00076         */
00077         static const octet_t min_value = 0x0;
00078 
00079         /**
00080         * A constant for the maximum representable value.
00081         */
00082         static const octet_t max_value = 0xFF;
00083     };
00084 
00085 COH_CLOSE_NAMESPACE2
00086 
00087 #endif // COH_OCTET_HPP