inc/FBaseInteger.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                FBaseInteger.h
  19  * @brief               This is the header file for the %Integer class.
  20  *
  21  * This header file contains the declarations of the %Integer class.
  22  *
  23  * @see   Tizen::Base::Number
  24  */
  25 #ifndef _FBASE_INTEGER_H_
  26 #define _FBASE_INTEGER_H_
  27
  28 #include <FBaseNumber.h>
  29
  30 namespace Tizen { namespace Base
  31 {
  32 /**
  33  *      @class  Integer
  34  *      @brief  This class is the wrapper class for the @c signed @c int built-in type.
  35  *
  36  *      @since 2.0
  37  *
  38  *      The %Integer class represents an integer value ranging from -2147483648 to 2147483647,
  39  *      that is, -(2^31) to +((2^31)-1). This class is useful when passing a 32-bit @c signed
  40  *      integral value to a method that accepts only an instance of Object. Furthermore,
  41  *      this class provides methods for converting %Integer (and @c int) to String, and %String
  42  *      to %Integer (and @c int).
  43  *
  44  * The following example demonstrates how to use the %Integer class.
  45  *
  46  *      @code
  47  *
  48  *      #include <FBase.h>
  49  *
  50  *      using namespace Tizen::Base;
  51  *
  52  *      // This method checks whether the given string object contains a string
  53  *      // representation of the pre-defined minimum 32-bit integral value.
  54  *      result
  55  *      MyClass::Verify(String& string, bool& out)
  56  *      {
  57  *              static const Integer MINIMUM(1230);
  58  *
  59  *              result r = E_SUCCESS;
  60  *
  61  *              int i;
  62  *              r = Integer::Parse(string, i);
  63  *              if (IsFailed(r))
  64  *              {
  65  *                      goto CATCH;
  66  *              }
  67  *
  68  *              out = (MINIMUM.CompareTo(i) == 0) ? true: false;
  69  *
  70  *              return r;
  71  *      CATCH:
  72  *              return r;
  73  *      }
  74  *      @endcode
  75  */
  76 class _OSP_EXPORT_ Integer
  77         : public Number
  78 {
  79 public:
  80         /**
  81          *      Initializes this instance of %Integer with the specified value.
  82          *
  83          *      @since 2.0
  84          *
  85          *  @param[in]  value   The integer value
  86          */
  87         Integer(int value = 0);
  88
  89         /**
  90          *      Copying of objects using this copy constructor is allowed.
  91          *
  92          *      @since 2.0
  93          *
  94          *      @param[in]      value   An instance of %Integer to copy
  95          */
  96         Integer(const Integer& value);
  97
  98         /**
  99          *      This destructor overrides Tizen::Base::Object::~Object().
 100          *
 101          *      @since 2.0
 102          */
 103         virtual ~Integer(void);
 104
 105         /**
 106          *      Copying of objects using this copy assignment operator is allowed.
 107          *
 108          *      @since 2.0
 109          *
 110          *  @param[in]  rhs     An instance of %Integer to copy
 111          */
 112         Integer& operator =(const Integer& rhs);
 113
 114         /**
 115          *      Compares two @c int values.
 116          *
 117          *      @since 2.0
 118          *
 119          *      @return         The 32-bit @c signed integer value
 120          *      @code
 121          *      <  0  if the value of i1 is less than the value of i2
 122          *      == 0  if the value of i1 is equal to the value of i2
 123          *      >  0  if the value of i1 is greater than the value of i2
 124          *      @endcode
 125          *      @param[in]      i1      The first @c int value to compare
 126          *      @param[in]      i2      The second @c int value to compare
 127          */
 128         static int Compare(int i1, int i2);
 129
 130         /**
 131          *      Compares the value of the current instance with the value of the specified instance of %Integer.
 132          *
 133          *      @since 2.0
 134          *
 135          *      @return The 32-bit @c signed integer value
 136          *
 137          *      @code
 138          *      <  0  if the value of the current instance is less than the value of the specified instance
 139          *      == 0  if the value of the current instance is equal to the value of the specified instance
 140          *      >  0  if the value of the current instance is greater than the value of the specified instance
 141          *      @endcode
 142          *      @param[in]      value   An instance of %Integer to compare
 143          */
 144         int CompareTo(const Integer& value) const;
 145
 146         /**
 147          *      Checks whether the value of the specified instance of Object is equal to the value of the current instance of %Integer.
 148          *
 149          *      @since 2.0
 150          *
 151          *      @return         @c true if the value of the specified instance of Object is equal to the value of the current instance of %Integer, @n
 152          *                              else @c false
 153          *      @param[in]      obj An instance of Object to compare
 154          *      @see            Tizen::Base::Object::Equals()
 155          */
 156         virtual bool Equals(const Object& obj) const;
 157
 158         /**
 159          *      Decodes a string into a @c signed @c int.
 160          *
 161          *      @since 2.0
 162          *
 163          *      @return         An error code
 164          *      @param[in]      s                               The string that represents the numeric value
 165          *      @param[out]     ret                             The result of the operation
 166          *      @exception      E_SUCCESS       The method is successful.
 167          *      @exception      E_NUM_FORMAT    The specified string does not contain a number that can be parsed.
 168          *      @remarks        This method accepts decimal, hexadecimal, and octal numbers given by the
 169          *                              following grammar:
 170          *      @code
 171          *      - DecodableString:
 172          *              Sign[opt] DecimalNumeral
 173          *              Sign[opt] 0x HexDigits
 174          *              Sign[opt] 0X HexDigits
 175          *              Sign[opt] # HexDigits
 176          *              Sign[opt] 0 OctalDigits
 177          *      - Sign:
 178          *              '-'
 179          *      @endcode
 180          */
 181         static result Decode(const String& s, int& ret);
 182
 183         /**
 184          *      Gets the hash value of the current instance of %Integer.
 185          *
 186          *      @since 2.0
 187          *
 188          *      @return         The integer value that indicates the hash value of the current instance of %Integer
 189          *      @remarks
 190          *                              - Two equal instances must return the same hash value. @n
 191          *                              For better performance, the used hash function must generate a random distribution for all the inputs. @n
 192          *                              - The default implementation of this method returns the value of the current instance.
 193          */
 194         virtual int GetHashCode(void) const;
 195
 196         /**
 197          *  Gets the hash value of the specified @c int value.
 198          *
 199          *  @since 2.0
 200          *
 201          *  @return      The integer value that indicates the hash value of the specified @c int value
 202          *  @param[in]   val   The @c int value used to get the hash value
 203          */
 204         static int GetHashCode(int val);
 205
 206         /**
 207          *      Parses the @c signed @c int equivalent of the specified string that represents a numeric value.
 208          *
 209          *      @since 2.0
 210          *
 211          *      @return         An error code
 212          *      @param[in]      s                               The string that represents the numeric value
 213          *      @param[out]     ret                             The result of the operation
 214          *      @exception      E_SUCCESS               The method is successful.
 215          *      @exception      E_NUM_FORMAT    The specified string does not contain a number that can be parsed.
 216          *      @remarks
 217          *                              - This method assumes that the string that represents the numeric value that uses the radix @c 10.
 218          *                              - This method guarantees that the original value of the out-parameter is not changed when the method returns an error.
 219          */
 220         static result Parse(const String& s, int& ret);
 221
 222         /**
 223          *      Parses the @c signed @c int equivalent of the specified string that represents a numeric value using the specified radix.
 224          *
 225          *      @since 2.0
 226          *
 227          *      @return         An error code
 228          *      @param[in]      s                               The string that represents the numeric value
 229          *      @param[in]      radix                   The radix of the string that represents the numeric value @n
 230          *                                                              It must either be 2, 8, 10, or 16.
 231          *      @param[out]     ret                             The result of the operation
 232          *      @exception      E_SUCCESS               The method is successful.
 233          *      @exception      E_NUM_FORMAT    The specified string does not contain a number that can be parsed.
 234          *      @exception      E_OUT_OF_RANGE  The specified @c radix is invalid.
 235          *      @remarks        This method guarantees that the original value of the out-parameter is not changed when the method returns an error.
 236          */
 237         static result Parse(const String& s, int radix, int& ret);
 238
 239         /**
 240          *      Gets the @c signed @c char equivalent of the current instance of %Integer.
 241          *
 242          *      @since 2.0
 243          *
 244          *      @return         The @c signed @c char equivalent of the current instance
 245          */
 246         virtual char ToChar(void) const;
 247
 248         /**
 249          *      Gets the @c signed @c short equivalent of the current instance of %Integer.
 250          *
 251          *      @since 2.0
 252          *
 253          *      @return         The @c signed @c short equivalent of the current instance
 254          */
 255         virtual short ToShort(void) const;
 256
 257         /**
 258          *      Gets the @c signed @c int equivalent of the current instance of %Integer.
 259          *
 260          *      @since 2.0
 261          *
 262          *      @return         The @c signed @c int equivalent of the current instance
 263          */
 264         virtual int ToInt(void) const;
 265
 266         /**
 267          *      Gets the @c signed @c long equivalent of the current instance of %Integer.
 268          *
 269          *      @since 2.0
 270          *
 271          *      @return         The @c signed @c long equivalent of the current instance
 272          */
 273         virtual long ToLong(void) const;
 274
 275         /**
 276          *      Gets the @c signed @c long @c long equivalent of the current instance of %Integer.
 277          *
 278          *      @since 2.0
 279          *
 280          *      @return         The @c signed @c long @c long equivalent of the current instance
 281          */
 282         virtual long long ToLongLong(void) const;
 283
 284         /**
 285          *      Gets the @c signed @c float equivalent of the current instance of %Integer.
 286          *
 287          *      @since 2.0
 288          *
 289          *      @return         The @c signed @c float equivalent of the current instance
 290          */
 291         virtual float ToFloat(void) const;
 292
 293         /**
 294          *      Gets the @c signed @c double equivalent of the current instance of %Integer.
 295          *
 296          *      @since 2.0
 297          *
 298          *      @return         The @c signed @c double equivalent of the current instance
 299          */
 300         virtual double ToDouble(void) const;
 301
 302         /**
 303          *      Gets the string that represents the value of the current instance of %Integer.
 304          *
 305          *      @since 2.0
 306          *
 307          *      @return         The string that represents the value of the current instance
 308          */
 309         virtual String ToString(void) const;
 310
 311         /**
 312          *      Gets the string that represents the specified @c signed @c int value.
 313          *
 314          *      @since 2.0
 315          *
 316          *      @return         The string that contains the Unicode representation of the specified @c signed @c int value
 317          *      @param[in]      value   The @c signed @c int value to convert
 318          */
 319         static String ToString(int value);
 320
 321         /**
 322          *      The constant holding the maximum value of type @c int. @n
 323          *  A @c short integer can hold a value of upto 2^31-1.
 324          *
 325          *      @since 2.0
 326          */
 327         static const int VALUE_MAX = (int) 0x7FFFFFFF;
 328
 329         /**
 330          *      The constant holding the minimum value of type @c int. @n
 331          *  A @c short integer can hold a value of upto -2^31.
 332          *
 333          *      @since 2.0
 334          */
 335         static const int VALUE_MIN = (int) 0x80000000;
 336
 337         /**
 338          * The integer value of this instance.
 339          *
 340          * @since 2.0
 341          */
 342         int value;
 343
 344
 345 private:
 346         friend class _IntegerImpl;
 347         class _IntegerImpl* __pIntegerImpl;
 348
 349 }; // Integer
 350
 351 }} //Tizen::Base
 352
 353 #endif //_FBASE_INTEGER_H_