inc/FBaseObject.h

   1 //
   2 // Copyright (c) 2012 Samsung Electronics Co., Ltd.
   3 //
   4 // Licensed under the Apache License, Version 2.0 (the License);
   5 // you may not use this file except in compliance with the License.
   6 // You may obtain a copy of the License at
   7 //
   8 //     http://www.apache.org/licenses/LICENSE-2.0
   9 //
  10 // Unless required by applicable law or agreed to in writing, software
  11 // distributed under the License is distributed on an "AS IS" BASIS,
  12 // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  13 // See the License for the specific language governing permissions and
  14 // limitations under the License.
  15 //
  16
  17 /**
  18  * @file                FBaseObject.h
  19  * @brief               This is the header file for the %Object class.
  20  *
  21  * This header file contains the declarations of the %Object class. @n
  22  * This class defines a set of behaviors shared by all Tizen classes.
  23  */
  24 #ifndef _FBASE_OBJECT_H_
  25 #define _FBASE_OBJECT_H_
  26
  27 #include <FBaseTypes.h>
  28 #include <FOspConfig.h>
  29 #include <FOspCompat.h>
  30
  31 namespace Tizen { namespace Base
  32 {
  33 /**
  34  * @class       Object
  35  * @brief       This class is the root class of %Tizen.
  36  *
  37  * @since 2.0
  38  *
  39  * The %Object class defines a set of behaviors and characteristics shared by all the other classes.
  40  *
  41  * The derived classes can override some of these methods, such as the Equals() method, which tests for object equivalence.
  42  */
  43 class _OSP_EXPORT_ Object
  44 {
  45 public:
  46         /**
  47          *      This is the default constructor for this class.
  48          *
  49          *  @since 2.0
  50          */
  51         Object(void);
  52
  53         /**
  54          *      This is the destructor for this class.
  55          *
  56          *  @since 2.0
  57          */
  58         virtual ~Object(void);
  59
  60         /**
  61          *      Checks whether the value of the specified instance is equal to the value of the current instance of %Object.
  62          *
  63          *  @since 2.0
  64          *
  65          *      @return                 @c true if the value of the specified instance of %Object is equal to the value of the current instance of %Object, @n
  66          *                                      else @c false
  67          *      @param[in]      obj     An instance of %Object to compare
  68          *      @remarks        The default implementation of this method returns @c true
  69          *                              if the two instances have the same address. @n
  70          *                              The method can be overridden to support value equality. Furthermore, this method must return the same result as the equality operator.
  71          */
  72         virtual bool Equals(const Object& obj) const;
  73
  74         /**
  75          *      Gets the hash value of the current instance of %Object.
  76          *
  77          *  @since 2.0
  78          *
  79          *      @return         An integer value indicating the hash value of the current instance of %Object
  80          *      @remarks        Two equal instances must return the same hash value. For better performance,
  81          *                              the used hash function must generate a random distribution for all inputs. @n
  82          *                              The default implementation of this method returns the address of the current instance.
  83          */
  84         virtual int GetHashCode(void) const;
  85
  86 protected:
  87         /**
  88          * This is the copy constructor for the %Object class.
  89          *
  90          * @param[in]   obj     An instance of %Object
  91          */
  92         Object(const Object& obj);
  93
  94         /**
  95          * Assigns the value of the specified instance to the current instance of %Object.
  96          *
  97          * @param[in]   rhs     An instance of %Object
  98          */
  99         Object& operator =(const Object& rhs);
 100
 101         //
 102         // This method is for internal use only. Using this method can cause behavioral, security-related,
 103         // and consistency-related issues in the application.
 104         // This method is reserved and may change its name at any time without prior notice.
 105         //
 106         // @since 2.0
 107         //
 108         virtual void Object_Reserved1(void) { }
 109
 110 public:
 111         // This pointer is initalized null. It is used to return null pointer.
 112         //
 113         // @since 3.0
 114         //
 115         static Object* pNullObj;
 116 }; // Object
 117
 118 }} // Tizen::Base
 119
 120 #endif //_FBASE_OBJECT_H_