2 // Copyright (c) 2013 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 FBaseInteger8.h
19 * @brief This is the header file for the %Integer8 class.
21 * @see Tizen::Base::Number
23 * This header file contains the declarations of the %Integer8 class.
25 #ifndef _FBASE_INTEGER8_H_
26 #define _FBASE_INTEGER8_H_
29 #include <FBaseNumber.h>
31 namespace Tizen { namespace Base
35 * @brief This class is the wrapper class for the @c 8-bits integral built-in type @c int8_t.
39 * The %Integer8 class represents an integer value ranging from -128 to 127. The class is useful when passing an 8-bit
40 * signed integral value to a method that accepts only an instance of Object. Furthermore, this class provides
41 * methods for converting %Integer8 (and @c char) to String, and %String to %Integer8 (and @c char).
43 * The following example demonstrates how to use the %Integer8 class.
48 * using namespace Tizen::Base;
50 * // This method checks whether the given string object contains a string
51 * // representation of the pre-defined minimum 8-bit integral value.
53 * MyClass::Verify(String& string, bool& out)
55 * static const Integer8 i1(123);
58 * result r = Integer8::Parse(string, int8Val);
59 * static const Integer8 i2(int8Val);
62 * out = (i1.CompareTo(i2) == 0) ? true: false;
69 class _OSP_EXPORT_ Integer8
74 * This is the default constructor for this class. Initializes the value to 0.
82 * Initializes this instance of %Integer8 with the specified value.
86 * @param[in] value A @c signed 8-bits integral @c int8_t value
88 explicit Integer8(int8_t value);
92 * Copying of objects using this copy constructor is allowed.
96 * @param[in] value An instance of %Integer8
98 Integer8(const Integer8& value);
101 * This destructor overrides Tizen::Base::Object::~Object().
105 virtual ~Integer8(void);
108 * Copying of objects using this copy assignment operator is allowed.
112 * @param[in] rhs An instance of %Integer8
114 Integer8& operator =(const Integer8& rhs);
117 * Compares two @c signed 8-bits integral @c int8_t values.
121 * @return A 32-bit @c signed integr value
123 * < 0 if the value of i81 is less than the value of i82
124 * == 0 if the value of i81 is equal to the value of i82
125 * > 0 if the value of i81 is greater than the value of i82
127 * @param[in] i81 The first @c signed 8-bits integral @c int8_t value to compare
128 * @param[in] i82 The second @c signed 8-bits integral @c int8_t value to compare
130 static int Compare(int8_t i81, int8_t i82);
133 * Compares the value of the current instance with the value of the specified instance of the %Integer8 class.
137 * @return A 32-bit @c signed integer value
139 * < 0 if the value of the current instance is less than the value of the specified instance
140 * == 0 if the value of the current instance is equal to the value of the specified instance
141 * > 0 if the value of the current instance is greater than the value of the specified instance
143 * @param[in] value An instance of the %Integer8 class to compare
145 int CompareTo(const Integer8& value) const;
148 * Checks whether the value of the specified instance of %Integer8 is equal to the value of the current instance.
152 * @return @c true if the value of the specified instance is equal to the value of the current instance, @n
154 * @param[in] obj An instance of Object to compare
155 * @see Tizen::Base::Object::Equals()
157 virtual bool Equals(const Object& obj) const;
160 * Gets the hash value of the current instance of %Integer8.
164 * @return An integer value indicating the hash value of the current instance of %Integer8
165 * @remarks Two equal instances must return the same hash value. For better performance,
166 * the used hash function must generate a random distribution for all inputs. @n
167 * The default implementation of this method returns the value of the current instance.
169 virtual int GetHashCode(void) const;
172 * Gets the hash value of the specified @c signed 8-bits integral @c int8_t value.
176 * @return An integer value indicating the hash value of the specified @c signed 8-bits integral @c int8_t value
177 * @param[in] val A @c signed 8-bits integral @c int8_t value to get the hash value
179 static int GetHashCode(int8_t val);
182 * Decodes a string into a @c signed 8-bits integral @c int8_t value.
186 * @return An error code
187 * @param[in] s A string representing a numeric value
188 * @param[out] ret The result of the operation
189 * @exception E_SUCCESS The method is successful.
190 * @exception E_NUM_FORMAT The specified string does not contain a number that can be parsed.
191 * @remarks This method accepts decimal, hexadecimal, and octal numbers given by the
195 * Sign[opt] DecimalNumeral
196 * Sign[opt] 0x HexDigits
197 * Sign[opt] 0X HexDigits
198 * Sign[opt] # HexDigits
199 * Sign[opt] 0 OctalDigits
204 static result Decode(const String& s, int8_t& ret);
207 * Parses the specified string representing a @c signed 8-bits integral @c int8_t value and
208 * returns the value as @c signed 8-bits integral @c int8_t (as out parameter).
211 * @return An error code
212 * @param[in] s A string representing a numeric value
213 * @param[out] ret The @c signed 8-bits integral @c int8_t equivalent of the specified string representing the numeric value using the decimal radix.
214 * @exception E_SUCCESS The method is successful.
215 * @exception E_NUM_FORMAT The specified string does not contain a byte that can be parsed.
217 * - This method assumes that the string representing the @c signed 8-bits integral value uses a radix 10.
218 * - This method guarantees that the original value of out-parameter is not changed when the method returns error.
220 static result Parse(const String& s, int8_t& ret);
223 * Parses the specified string representing a @c signed 8-bits integral @c int8_t value and
224 * returns the value as @c signed 8-bits integral @c int8_t (as out parameter).
228 * @return An error code
229 * @param[in] s A string representing a @c signed 8-bits integral value
230 * @param[in] radix The radix of the string representing a numeric value. Radix value range is from 2 to 36.
231 * @param[out] ret The @c signed 8-bits integral @c int8_t equivalent of the specified string representing the numeric value using the specified radix
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 out-parameter is not changed when the method returns error.
237 static result Parse(const String& s, int radix, int8_t& ret);
240 * Gets the @c signed @c char equivalent of the current instance of %Integer8.
244 * @return The @c signed @c char equivalent of the current instance
245 * @remarks 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
248 virtual char ToChar(void) const;
251 * Gets the @c signed @c short equivalent of the current instance of %Integer8.
255 * @return The @c signed @c short equivalent of the current instance
257 virtual short ToShort(void) const;
260 * Gets the @c signed @c int equivalent of the current instance of %Integer8.
264 * @return The @c signed @c int equivalent of the current instance
266 virtual int ToInt(void) const;
269 * Gets the @c signed @c long equivalent of the current instance of %Integer8.
273 * @return The @c signed @c long equivalent of the current instance
275 virtual long ToLong(void) const;
278 * Gets the @c signed @c long @c long equivalent of the current instance of %Integer8.
282 * @return The @c signed @c long @c long equivalent of the current instance
284 virtual long long ToLongLong(void) const;
287 * Gets the @c signed @c float equivalent of the current instance of %Integer8.
291 * @return The @c signed @c float equivalent of the current instance
293 virtual float ToFloat(void) const;
296 * Gets the @c signed @c double equivalent of the current instance of %Integer8.
300 * @return The @c signed @c double equivalent of the current instance
302 virtual double ToDouble(void) const;
305 * Gets the string representing the value of the current instance of %Integer8 using radix @c 10.
309 * @return A string representing the value of the current instance using radix 10
311 virtual String ToString(void) const;
314 * Gets the string representing the specified @c signed 8-bits integral @c int8_t value using radix @c 10.
318 * @return A string containing a Unicode representation of the specified @c signed 8-bits integral @c int8_t value using radix 10
319 * @param[in] value A @c signed 8-bits integral @c int8_t value
321 static String ToString(int8_t value);
324 * A constant holding the maximum value of type @c signed 8-bits integral value. @n
325 * A @c signed 8-bits integral can hold a maximum value of upto 2^7-1.
329 static const int8_t VALUE_MAX = static_cast<int8_t> (0x7F);
332 * A constant holding the minimum value of type @c signed 8-bits integral value. @n
333 * A @c signed 8-bits integral can hold a minimum value of upto -2^7.
337 static const int8_t VALUE_MIN = static_cast<int8_t> (0x80);
340 * A @c signed @c signed 8-bits integral value of this instance.
348 friend class _Integer8Impl;
349 class _Integer8Impl* __pInteger8Impl;
355 #endif //_FBASE_INTEGER8_H_