C++ Client API Reference for Oracle Coherence: coherence/lang/Boolean.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_BOOLEAN_HPP
00008 #define COH_BOOLEAN_HPP
00009 
00010 #include "coherence/lang/compatibility.hpp"
00011 
00012 #include "coherence/lang/cloneable_spec.hpp"
00013 #include "coherence/lang/Primitive.hpp"
00014 #include "coherence/lang/String.hpp"
00015 #include "coherence/lang/TypedHandle.hpp"
00016 
00017 COH_OPEN_NAMESPACE2(coherence,lang)
00018 
00019 
00020 /**
00021 * An immutable boolean value.
00022 *
00023 * @author jh  2008.04.01
00024 */
00025 class COH_EXPORT Boolean
00026     : public cloneable_spec<Boolean,
00027         extends<Primitive<bool> > >
00028     {
00029     friend class factory<Boolean>;
00030 
00031     // ----- constructors ---------------------------------------------------
00032 
00033     private:
00034         /**
00035         * @internal
00036         */
00037         Boolean(bool f);
00038 
00039         /**
00040         * Copy constructor.
00041         */
00042         Boolean(const Boolean& that);
00043 
00044 
00045     // ----- static methods -------------------------------------------------
00046 
00047     public:
00048         /**
00049         * Get an instance of a Boolean that represents true or false.
00050         *
00051         * @param f  the instance of Boolean to return
00052         *
00053         * @return the instance of boolean that represents true or false
00054         *         based on f
00055         */
00056         static Handle valueOf(bool f);
00057 
00058         using super::toString;
00059 
00060         /**
00061          * Return "true" or "false" for a given boolean value.
00062          *
00063          * @param f  the boolean value
00064          *
00065          * @return "true" or "false" based on f
00066          *
00067          * @since 12.2.1.3
00068          */
00069         static String::View toString(bool f);
00070     };
00071 
00072 COH_CLOSE_NAMESPACE2
00073 
00074 #endif // COH_BOOLEAN_HPP