C++ Client API Reference for Oracle Coherence: coherence/lang/Character16.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_CHARACTER16_HPP
00008 #define COH_CHARACTER16_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 16-bit Unicode character value.
00020 *
00021 * @author jh  2008.04.01
00022 */
00023 class COH_EXPORT Character16
00024     : public cloneable_spec<Character16,
00025         extends<Primitive<wchar16_t> >,
00026         implements<Comparable> >
00027     {
00028     friend class factory<Character16>;
00029 
00030     // ----- constructors ---------------------------------------------------
00031 
00032     private:
00033         /**
00034         * Create a new Character16 instance.
00035         *
00036         * @param ch  the value of the new Character16
00037         */
00038         Character16(wchar16_t ch);
00039 
00040         /**
00041         * Copy constructor.
00042         */
00043         Character16(const Character16&);
00044 
00045 
00046     // ----- Character16 interface ------------------------------------------
00047 
00048     public:
00049         /**
00050         * @return true if this is an ASCII (ISO-8859-1) Character16
00051         */
00052         virtual bool isASCII() const;
00053 
00054 
00055     // ----- Comparable interface -------------------------------------------
00056 
00057     public:
00058         /**
00059         * {@inheritDoc}
00060         */
00061         virtual int32_t compareTo(Object::View v) const;
00062 
00063 
00064     // ----- static methods -------------------------------------------------
00065 
00066     public:
00067         /**
00068         * Factory method to produce Character16 objects with an optimization
00069         * that uses cached objects for all relatively-low values.
00070         *
00071         * @param ch  a wchar16_t
00072         *
00073         * @return a Character16 whose value is the passed wchar16_t
00074         */
00075         static Handle valueOf(wchar16_t ch);
00076 
00077 
00078 
00079     // ----- constants ------------------------------------------------------
00080 
00081     public:
00082         /**
00083         * A constant for the minimum representable value.
00084         */
00085         static const wchar16_t min_value = 0x0;
00086 
00087         /**
00088         * A constant for the maximum representable value.
00089         */
00090         static const wchar16_t max_value = 0xFFFF;
00091     };
00092 
00093 COH_CLOSE_NAMESPACE2
00094 
00095 #endif // COH_CHARACTER16_HPP