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  * This header file contains the declarations of the %Short class.
  22  *
  23  * @see                 Number
  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   The @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 to copy
  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 The 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 s1 is less than s2
 125          *      == 0  if s1 is equal to s2
 126          *      >  0  if s1 is greater than s2
 127          *      @endcode
 128          */
 129         static int Compare(short s1, short s2);
 130
 131         /**
 132          *      Compares the value of the current instance of %Short
 133          *      with the value of the specified instance of %Short.
 134          *
 135          *      @since 2.0
 136          *
 137          *      @return         The @c signed 32-bit @c integer value
 138          *      @param[in]      value An instance of %Short to compare
 139          *
 140          *      @code
 141          *      <  0  if the value of the current instance is less than the specified instance
 142          *      == 0  if the value of the current instance is equal to the specified instance
 143          *      >  0  if the value of the current instance is greater than 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   The @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         The integer value that indicates the hash value of the current instance of %Short
 180          *      @remarks
 181          *                              - Two equal instances must return the same hash value. @n
 182          *                              For better performance, the used hash function must generate a random distribution for all the inputs. @n
 183          *                              - The default implementation of this method returns the value of the current instance.
 184          */
 185         virtual int GetHashCode(void) const;
 186
 187         /**
 188         *  Gets the hash value of the specified @c short value.
 189         *
 190         *  @since 2.0
 191         *
 192         *  @return      The integer value that indicates the hash value of the specified @c short value
 193         *  @param[in]   val   The @c short value used to get the hash value
 194         */
 195         static int GetHashCode(short val);
 196
 197         /**
 198          *      Decodes a string into a @c signed @c short.
 199          *
 200          *      @since 2.0
 201          *
 202          *      @return         An error code
 203          *      @param[in]      s                               The numeric value
 204          *      @param[out]     ret                             The result of the operation
 205          *      @exception      E_SUCCESS               The method is successful.
 206          *      @exception      E_NUM_FORMAT    The specified string does not contain a number that can be parsed.
 207          *      @remarks        This method accepts decimal, hexadecimal, and octal numbers given by the
 208          *                              following grammar:
 209          *
 210          *      @code
 211          *      - DecodableString:
 212          *              Sign[opt] DecimalNumeral
 213          *              Sign[opt] 0x HexDigits
 214          *              Sign[opt] 0X HexDigits
 215          *              Sign[opt] # HexDigits
 216          *              Sign[opt] 0 OctalDigits
 217          *      - Sign:
 218          *              '-'
 219          *      @endcode
 220          */
 221         static result Decode(const String& s, short& ret);
 222
 223         /**
 224          *      Parses the specified string that represents a numeric value and
 225          *      returns the value as @c signed @c short.
 226          *
 227          *      @since 2.0
 228          *
 229          *      @return         An error code
 230          *      @param[in]      s                               The string that represents the numeric value
 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          *      @remarks
 235          *                              - This method assumes that the string that represents the numeric value that uses a radix @c 10.
 236          *                              - This method guarantees that the original value of the out-parameter is not changed when the method returns an error.
 237          */
 238         static result Parse(const String& s, short& ret);
 239
 240         /**
 241          *      Parses the specified string that represents a numeric value
 242          *      using the specified radix and returns the value as @c signed @c short.
 243          *
 244          *      @since 2.0
 245          *
 246          *      @return         An error code
 247          *      @param[in]      s                               The string that represents the numeric value
 248          *      @param[in]      radix                   The radix of the string that represents the numeric value @n
 249          *                                                              It must either be 2, 8, 10, or 16.
 250          *      @param[out]     ret                             The result of the operation
 251          *      @exception      E_SUCCESS               The method is successful.
 252          *      @exception      E_NUM_FORMAT    The specified string does not contain a number that can be parsed.
 253          *      @exception      E_OUT_OF_RANGE The specified @c radix is invalid.
 254          *      @remarks        This method guarantees that the original value of the out-parameter is not changed when the method returns an error.
 255          */
 256         static result Parse(const String& s, int radix, short& ret);
 257
 258         /**
 259          *      Gets the @c signed @c char equivalent of the current instance of %Short.
 260          *
 261          *      @since 2.0
 262          *
 263          *      @return The @c signed @c char equivalent of the current instance
 264          */
 265         virtual char ToChar(void) const;
 266
 267         /**
 268          *      Gets the @c signed @c short equivalent of the current instance of %Short.
 269          *
 270          *      @since 2.0
 271          *
 272          *      @return The @c signed @c short equivalent of the current instance
 273          */
 274         virtual short ToShort(void) const;
 275
 276         /**
 277          *      Gets the @c signed @c int equivalent of the current instance of %Short.
 278          *
 279          *      @since 2.0
 280          *
 281          *      @return The @c signed @c int equivalent of the current instance
 282          */
 283         virtual int ToInt(void) const;
 284
 285         /**
 286          *      Gets the @c signed @c long equivalent of the current instance of %Short.
 287          *
 288          *      @since 2.0
 289          *
 290          *      @return The @c signed @c long equivalent of the current instance
 291          */
 292         virtual long ToLong(void) const;
 293
 294         /**
 295          *      Gets the @c signed @c long @c long equivalent of the current instance of %Short.
 296          *
 297          *      @since 2.0
 298          *
 299          *      @return The @c signed @c long @c long equivalent of the current instance
 300          */
 301         virtual long long ToLongLong(void) const;
 302
 303         /**
 304          *      Gets the @c signed @c float equivalent of the current instance of %Short.
 305          *
 306          *      @since 2.0
 307          *
 308          *      @return The @c signed @c float equivalent of the current instance
 309          */
 310         virtual float ToFloat(void) const;
 311
 312         /**
 313          *      Gets the @c signed @c double equivalent of the current instance of %Short.
 314          *
 315          *      @since 2.0
 316          *
 317          *      @return The @c signed @c double equivalent of the current instance
 318          */
 319         virtual double ToDouble(void) const;
 320
 321         /**
 322          * Gets the string that represents the value of the current instance of %Short.
 323          *
 324          *      @since 2.0
 325          *
 326          *  @return             The string that represents the value of the current instance
 327          */
 328         virtual String ToString(void) const;
 329
 330         /**
 331          *      Gets the string that represents the specified @c signed @c short value.
 332          *
 333          *      @since 2.0
 334          *
 335          *      @return                 The string that contains the Unicode representation of the specified @c signed @c short value
 336          *      @param[in]      value   The @c signed @c short value to convert
 337          */
 338         static String ToString(short value);
 339
 340         /**
 341          *      The constant holding the maximum value a @c short can be equal to 2^15-1.
 342          *
 343          *      @since 2.0
 344          */
 345         static const short VALUE_MAX = (short) 0x7FFF;
 346
 347         /**
 348          *      The constant holding the minimum value a @c short can be equal to -2^15.
 349          *
 350          *      @since 2.0
 351          */
 352         static const short VALUE_MIN = (short) 0x8000;
 353
 354         /**
 355          * The @c short value of this instance.
 356          *
 357          * @since 2.0
 358          */
 359         short value;
 360
 361
 362 private:
 363         friend class _ShortImpl;
 364         class _ShortImpl * __pShortImpl;
 365
 366 }; // Short
 367
 368 }} // Tizen::Base
 369
 370 #endif //_FBASE_SHORT_H_