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 * This header file contains the declarations of the %Integer class.
23 * @see Tizen::Base::Number
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 The 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 to copy
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 to copy
112 Integer& operator =(const Integer& rhs);
115 * Compares two @c int values.
119 * @return The 32-bit @c signed integer value
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
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 %Integer.
135 * @return The 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 %Integer 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 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
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 The integer value that indicates the hash value of the current instance of %Integer
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.
194 virtual int GetHashCode(void) const;
197 * Gets the hash value of the specified @c int value.
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
204 static int GetHashCode(int val);
207 * Parses the @c signed @c int equivalent of the specified string that represents a numeric value.
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.
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.
220 static result Parse(const String& s, int& ret);
223 * Parses the @c signed @c int equivalent of the specified string that represents a numeric value using the specified radix.
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.
237 static result Parse(const String& s, int radix, int& ret);
240 * Gets the @c signed @c char equivalent of the current instance of %Integer.
244 * @return The @c signed @c char equivalent of the current instance
246 virtual char ToChar(void) const;
249 * Gets the @c signed @c short equivalent of the current instance of %Integer.
253 * @return The @c signed @c short equivalent of the current instance
255 virtual short ToShort(void) const;
258 * Gets the @c signed @c int equivalent of the current instance of %Integer.
262 * @return The @c signed @c int equivalent of the current instance
264 virtual int ToInt(void) const;
267 * Gets the @c signed @c long equivalent of the current instance of %Integer.
271 * @return The @c signed @c long equivalent of the current instance
273 virtual long ToLong(void) const;
276 * Gets the @c signed @c long @c long equivalent of the current instance of %Integer.
280 * @return The @c signed @c long @c long equivalent of the current instance
282 virtual long long ToLongLong(void) const;
285 * Gets the @c signed @c float equivalent of the current instance of %Integer.
289 * @return The @c signed @c float equivalent of the current instance
291 virtual float ToFloat(void) const;
294 * Gets the @c signed @c double equivalent of the current instance of %Integer.
298 * @return The @c signed @c double equivalent of the current instance
300 virtual double ToDouble(void) const;
303 * Gets the string that represents the value of the current instance of %Integer.
307 * @return The string that represents the value of the current instance
309 virtual String ToString(void) const;
312 * Gets the string that represents the specified @c signed @c int value.
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
319 static String ToString(int value);
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.
327 static const int VALUE_MAX = (int) 0x7FFFFFFF;
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.
335 static const int VALUE_MIN = (int) 0x80000000;
338 * The integer value of this instance.
346 friend class _IntegerImpl;
347 class _IntegerImpl* __pIntegerImpl;
353 #endif //_FBASE_INTEGER_H_