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