Implementation of ImmutableString
[platform/framework/native/appfw.git] / inc / FBaseLong.h
index 08cb852..ee3f6a4 100644 (file)
@@ -184,9 +184,13 @@ public:
         *      @return         An error code
         *      @param[in]      s                               A string representing a numeric value
         *      @param[out]     ret                             The result of the operation
-        *      @exception      E_SUCCESS               The method is successful.
+        *      @exception      E_SUCCESS       The method is successful.
         *      @exception      E_NUM_FORMAT    The specified string does not contain a number that can be parsed.
-        *      @remarks        This method accepts decimal, hexadecimal, and octal numbers given by the
+        *      @exception      E_OUT_OF_RANGE  The decoded value is not between VALUE_MIN and VALUE_MAX range.
+        *
+        *      @remarks        
+        *                      - This method guarantees that the original value of out-parameter is not changed when the method returns error.
+        *                      - This method accepts decimal, hexadecimal, and octal numbers given by the
         *                              following grammar:
         *      @code
         *      - DecodableString:
@@ -209,8 +213,10 @@ public:
         *      @return         An error code
         *      @param[in]      s                               A string representing a numeric value
         *      @param[out]     ret                             The result of the operation
-        *      @exception      E_SUCCESS               The method is successful.
+        *      @exception      E_SUCCESS       The method is successful.
         *      @exception      E_NUM_FORMAT    The specified string does not contain a number that can be parsed.
+        *      @exception      E_OUT_OF_RANGE  The parsed value is not between VALUE_MIN and VALUE_MAX range.
+        *
         *      @remarks
         *                              - This method assumes that the string representing the numeric value uses a radix 10.
         *                              - This method guarantees that the original value of out-parameter is not changed when the method returns error.
@@ -225,25 +231,43 @@ public:
         *      @return         An error code
         *      @param[in]      s                       A string representing a numeric value
         *      @param[in]      radix           The radix of the string representing a numeric value @n
-        *                                                      It must be either 2, 8, 10, or 16.
+        *                                      Radix value range is from 2 to 36.
         *      @param[out]     ret                             The result of the operation
         *      @exception      E_SUCCESS               The method is successful.
         *      @exception      E_NUM_FORMAT    The specified string does not contain a number that can be parsed.
-        *      @exception      E_OUT_OF_RANGE  The specified @c radix is invalid.
+        *      @exception      E_OUT_OF_RANGE  The specified @c radix is invalid or
+        *                                      The parsed value is not between VALUE_MIN and VALUE_MAX range.
+        *
         *      @remarks        This method guarantees that the original value of out-parameter is not changed when the method returns error.
         */
        static result Parse(const String& s, int radix, long& ret);
 
        /**
-        *      Gets the @c signed @c char equivalent of the current instance of the %Long class.
+        *      Gets the @c char equivalent of the current instance of the %Long class.
         *
         *      @since 2.0
         *
-        *      @return         The @c signed @c char equivalent of the current instance
+        *      @brief  <i> [Deprecated] </i>
+        *
+        *      @deprecated     This method has portability issue.
+        *                      Return value may not be @c signed @c char since char is treated as unsigned char in ARM architecture. @n
+        *                      Use ToInt8() method to get @c int8_t
+        *
+        *      @return         The @c char equivalent of the current instance
         */
        virtual char ToChar(void) const;
 
        /**
+        *      Gets the @c int8_t equivalent of the current instance of %Long.
+        *
+        *      @since 3.0
+        *
+        *      @return The @c int8_t equivalent of the current instance
+        *
+        */
+       virtual int8_t ToInt8(void) const;
+
+       /**
         *      Gets the @c signed @c short equivalent of the current instance of the %Long class.
         *
         *      @since 2.0
@@ -321,14 +345,14 @@ public:
         *
         *      @since 2.0
         */
-       static const long VALUE_MAX = (long) 0x7FFFFFFF;
+       static const long VALUE_MAX = static_cast< long >(0x7FFFFFFF);
 
        /**
         *      A constant holding the minimum value a @c short can have; -2^31.
         *
         *      @since 2.0
         */
-       static const long VALUE_MIN = (long) 0x80000000;
+       static const long VALUE_MIN = static_cast< long >(0x80000000);
 
        /**
         * A @c long value of this instance.