2 // Copyright (c) 2012 Samsung Electronics Co., Ltd.
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
8 // http://www.apache.org/licenses/LICENSE-2.0
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.
18 * @file FBaseInteger.h
19 * @brief This is the header file for the %Integer class.
21 * @see Number() class()
23 * This header file contains the declarations of the %Integer class.
25 #ifndef _FBASE_INTEGER_H_
26 #define _FBASE_INTEGER_H_
28 #include <FBaseNumber.h>
30 namespace Tizen { namespace Base
34 * @brief This class is the wrapper class for the @c signed @c int built-in type.
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).
44 * The following example demonstrates how to use the %Integer class.
50 * using namespace Tizen::Base;
52 * // This method checks whether the given string object contains a string
53 * // representation of the pre-defined minimum 32-bit integral value.
55 * MyClass::Verify(String& string, bool& out)
57 * static const Integer MINIMUM(1230);
59 * result r = E_SUCCESS;
62 * r = Integer::Parse(string, i);
68 * out = (MINIMUM.CompareTo(i) == 0) ? true: false;
76 class _OSP_EXPORT_ Integer
81 * Initializes this instance of %Integer with the specified value.
85 * @param[in] value An integer value
87 Integer(int value = 0);
90 * Copying of objects using this copy constructor is allowed.
94 * @param[in] value An instance of %Integer
96 Integer(const Integer& value);
99 * This destructor overrides Tizen::Base::Object::~Object().
103 virtual ~Integer(void);
106 * Copying of objects using this copy assignment operator is allowed.
110 * @param[in] rhs An instance of %Integer
112 Integer& operator =(const Integer& rhs);
115 * Compares two @c int values.
119 * @return A 32-bit @c signed integer value
121 * < 0 if the value of @c i1 is less than the value of @c i2
122 * == 0 if the value of @c i1 is equal to the value of @c i2
123 * > 0 if the value of @c i1 is greater than the value of @c i2
125 * @param[in] i1 The first @c int value to compare
126 * @param[in] i2 The second @c int value to compare
128 static int Compare(int i1, int i2);
131 * Compares the value of the current instance with the value of the specified instance of the %Integer class.
135 * @return A 32-bit @c signed integer value
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
142 * @param[in] value An instance of the %Integer class to compare
144 int CompareTo(const Integer& value) const;
147 * Checks whether the value of the specified instance of Object is equal to the value of the current instance of %Integer.
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
153 * @param[in] obj An instance of Object to compare
154 * @see Tizen::Base::Object::Equals()
156 virtual bool Equals(const Object& obj) const;
159 * Decodes a string into a @c signed @c int.
163 * @return An error code
164 * @param[in] s A string representing 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
172 * Sign[opt] DecimalNumeral
173 * Sign[opt] 0x HexDigits
174 * Sign[opt] 0X HexDigits
175 * Sign[opt] # HexDigits
176 * Sign[opt] 0 OctalDigits
181 static result Decode(const String& s, int& ret);
184 * Gets the hash value of the current instance of %Integer.
188 * @return An integer value indicating the hash value of the current instance of %Integer
189 * @remarks Two equal instances must return the same hash value. For better performance,
190 * the used hash function must generate a random distribution for all inputs. @n
191 * The default implementation of this method returns the value of the current instance.
193 virtual int GetHashCode(void) const;
196 * Gets the hash value of the specified @c int value.
200 * @return An integer value indicating the hash value of the specified @c int value
201 * @param[in] val A @c int value to get the hash value
203 static int GetHashCode(int val);
206 * Parses the @c signed @c int equivalent of the specified string representing a numeric value.
210 * @return An error code
211 * @param[in] s A string representing a numeric value
212 * @param[out] ret The result of the operation
213 * @exception E_SUCCESS The method is successful.
214 * @exception E_NUM_FORMAT The specified string does not contain a number that can be parsed.
216 * - This method assumes that the string representing the numeric value uses a radix 10.
217 * - This method guarantees that the original value of out-parameter is not changed when the method returns error.
219 static result Parse(const String& s, int& ret);
222 * Parses the @c signed @c int equivalent of the specified string representing a numeric value using the specified radix.
226 * @return An error code
227 * @param[in] s A string representing a numeric value
228 * @param[in] radix The radix of the string representing the numeric value @n
229 * It must either be 2, 8, 10, or 16.
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 * @exception E_OUT_OF_RANGE The specified @c radix is invalid.
234 * @remarks This method guarantees that the original value of out-parameter is not changed when the method returns error.
236 static result Parse(const String& s, int radix, int& ret);
239 * Gets the @c signed @c char equivalent of the current instance of the %Integer class.
243 * @return A @c signed @c char equivalent of the current instance
245 virtual char ToChar(void) const;
248 * Gets the @c signed @c short equivalent of the current instance of the %Integer class.
252 * @return A @c signed @c short equivalent of the current instance
254 virtual short ToShort(void) const;
257 * Gets the @c signed @c int equivalent of the current instance of the %Integer class.
261 * @return A @c signed @c int equivalent of the current instance
263 virtual int ToInt(void) const;
266 * Gets the @c signed @c long equivalent of the current instance of the %Integer class.
270 * @return A @c signed @c long equivalent of the current instance
272 virtual long ToLong(void) const;
275 * Gets the @c signed @c long @c long equivalent of the current instance of the %Integer class.
279 * @return A @c signed @c long @c long equivalent of the current instance
281 virtual long long ToLongLong(void) const;
284 * Gets the @c signed @c float equivalent of the current instance of the %Integer class.
288 * @return A @c signed @c float equivalent of the current instance
290 virtual float ToFloat(void) const;
293 * Gets the @c signed @c double equivalent of the current instance of the %Integer class.
297 * @return A @c signed @c double equivalent of the current instance
299 virtual double ToDouble(void) const;
302 * Gets the string representing the value of the current instance of the %Integer class.
306 * @return A string representing the value of the current instance
308 virtual String ToString(void) const;
311 * Gets the string representing the specified @c signed @c int value.
315 * @return A string containing a Unicode representation of the specified @c signed @c int value
316 * @param[in] value A @c signed @c int value to convert
318 static String ToString(int value);
321 * A constant holding the maximum value of type @c int. @n
322 * A @c short integer can hold a value of upto 2^31-1.
326 static const int VALUE_MAX = (int) 0x7FFFFFFF;
329 * A constant holding the minimum value of type @c int. @n
330 * A @c short integer can hold a value of upto -2^31.
334 static const int VALUE_MIN = (int) 0x80000000;
337 * An integer value of this instance.
345 friend class _IntegerImpl;
346 class _IntegerImpl* __pIntegerImpl;
352 #endif //_FBASE_INTEGER_H_