2 // Open Service Platform
3 // Copyright (c) 2012 Samsung Electronics Co., Ltd.
5 // Licensed under the Apache License, Version 2.0 (the License);
6 // you may not use this file except in compliance with the License.
7 // You may obtain a copy of the License at
9 // http://www.apache.org/licenses/LICENSE-2.0
11 // Unless required by applicable law or agreed to in writing, software
12 // distributed under the License is distributed on an "AS IS" BASIS,
13 // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14 // See the License for the specific language governing permissions and
15 // limitations under the License.
20 * @brief This is the header file for the %Int8 class.
22 * @see Tizen::Base::Number
24 * This header file contains the declarations of the %Int8 class.
26 #ifndef _FBASE_INT8_H_
27 #define _FBASE_INT8_H_
29 #include <FBaseNumber.h>
32 namespace Tizen { namespace Base
36 * @brief This class is the wrapper class for the @c signed @c char built-in type.
40 * The %Int8 class represents an integer value ranging from -128 to 127. The class is useful when passing an 8-bit
41 * signed integral value to a method that accepts only an instance of Object. Furthermore, this class provides
42 * methods for converting %Int8 (and @c char) to String, and %String to %Int8 (and @c char).
44 * The following example demonstrates how to use the %Int8 class.
49 * using namespace Tizen::Base;
51 * // This method checks whether the given string object contains a string
52 * // representation of the pre-defined minimum 8-bit integral value.
54 * MyClass::Verify(String& string, bool& out)
56 * static const Int8 MINIMUM(123);
58 * result r = E_SUCCESS;
61 * r = Int8::Parse(string, ch);
67 * out = (MINIMUM.CompareTo(ch) == 0) ? true: false;
75 class _OSP_EXPORT_ Int8
80 * Initializes this instance of %Int8 with the specified value.
84 * @param[in] value A @c char value
90 * Copying of objects using this copy constructor is allowed.
94 * @param[in] value An instance of %Int8
96 Int8(const Int8& value);
99 * This destructor overrides Tizen::Base::Object::~Object().
106 * Copying of objects using this copy assignment operator is allowed.
110 * @param[in] rhs An instance of %Int8
112 Int8& operator =(const Int8& rhs);
115 * Compares two @c char values.
119 * @return A 32-bit @c signed integer value
121 * < 0 if the value of ch1 is less than the value of ch2
122 * == 0 if the value of ch1 is equal to the value of ch2
123 * > 0 if the value of ch1 is greater than the value of ch2
125 * @param[in] ch1 The first @c char value to compare
126 * @param[in] ch2 The second @c char value to compare
128 static int Compare(char ch1, char ch2);
131 * Compares the value of the current instance with the value of the specified instance of the %Int8 class.
135 * @return A 32-bit @c signed integer value
137 * < 0 if the value of the current instance is less than the value of the specified instance
138 * == 0 if the value of the current instance is equal to the value of the specified instance
139 * > 0 if the value of the current instance is greater than the value of the specified instance
141 * @param[in] value An instance of the %Int8 class to compare
143 int CompareTo(const Int8& value) const;
146 * Checks whether the value of the specified instance of %Int8 is equal to the value of the current instance.
150 * @return @c true if the value of the specified instance is equal to the value of the current instance, @n
152 * @param[in] obj An instance of Object to compare
153 * @see Tizen::Base::Object::Equals()
155 virtual bool Equals(const Object& obj) const;
158 * Gets the hash value of the current instance of %Int8.
162 * @return An integer value indicating the hash value of the current instance of %Int8
163 * @remarks Two equal instances must return the same hash value. For better performance,
164 * the used hash function must generate a random distribution for all inputs. @n
165 * The default implementation of this method returns the value of the current instance.
167 virtual int GetHashCode(void) const;
170 * Gets the hash value of the specified @c char value.
174 * @return An integer value indicating the hash value of the specified @c char value
175 * @param[in] val A @c char value to get the hash value
177 static int GetHashCode(char val);
180 * Decodes a string into a @c signed @c char.
184 * @return An error code
185 * @param[in] s A string representing a numeric value
186 * @param[out] ret The result of the operation
187 * @exception E_SUCCESS The method is successful.
188 * @exception E_NUM_FORMAT The specified string does not contain a number that can be parsed.
189 * @remarks This method accepts decimal, hexadecimal, and octal numbers given by the
193 * Sign[opt] DecimalNumeral
194 * Sign[opt] 0x HexDigits
195 * Sign[opt] 0X HexDigits
196 * Sign[opt] # HexDigits
197 * Sign[opt] 0 OctalDigits
202 static result Decode(const String& s, char& ret);
205 * Parses the @c signed @c char equivalent of the specified string representing a numeric value.
209 * @return An error code
210 * @param[in] s A string representing a numeric value
211 * @param[out] ret The result of the operation
212 * @exception E_SUCCESS The method is successful.
213 * @exception E_NUM_FORMAT The specified string does not contain a byte that can be parsed.
215 * - This method assumes that the string representing the numeric value uses a radix 10.
216 * - This method guarantees that the original value of out-parameter is not changed when the method returns error.
218 static result Parse(const String& s, char& ret);
221 * Parses the specified string representing a numeric value and
222 * returns the value as @c signed @c char (as out parameter).
226 * @return The @c signed @c char equivalent of the specified string representing the numeric value using the specified index
227 * @param[in] s A string representing a numeric value
228 * @param[in] radix The radix of the string representing a 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, char& ret);
239 * Gets the @c signed @c char equivalent of the current instance of %Int8.
243 * @return The @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 %Int8.
252 * @return The @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 %Int8.
261 * @return The @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 %Int8.
270 * @return The @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 %Int8.
279 * @return The @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 %Int8.
288 * @return The @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 %Int8.
297 * @return The @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 %Int8.
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 char value using radix @c 10.
315 * @return A string containing a Unicode representation of the specified @c char value using radix 10
316 * @param[in] value A @c char value
318 static String ToString(char value);
321 * A constant holding the maximum value of type @c char. @n
322 * A @c short character can hold a value of upto 2^7-1.
326 static const char VALUE_MAX = (signed char) 0x7F;
329 * A constant holding the minimum value of type @c char. @n
330 * A @c short character can hold a value of upto -2^7.
334 static const char VALUE_MIN = (signed char) 0x80;
337 * A @c signed @c char value of this instance.
345 friend class _Int8Impl;
346 class _Int8Impl * __pInt8Impl;
352 #endif //_FBASE_INT8_H_