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.
19 * @brief This is the header file for the %Short class.
23 * This header file contains the declarations of the %Short class.
25 #ifndef _FBASE_SHORT_H_
26 #define _FBASE_SHORT_H_
28 #include <FBaseNumber.h>
31 namespace Tizen { namespace Base
35 * @brief This class is the wrapper class for the @c signed @c short built-in type.
39 * The %Short class represents an integer value ranging from -32768 to 32767. The class is useful when passing
40 * a 16-bit @c signed integral value to a method that accepts only an instance of Object. Furthermore,
41 * this class provides methods for converting a %Short (and @c short) to a String, and a %String to %Short
44 * The following example demonstrates how to use the %Short 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 16-bit integral value
55 * MyClass::Verify(String& string, bool& out)
57 * static const Short MINIMUM(1230);
59 * result r = E_SUCCESS;
62 * r = Short::Parse(string, s)
68 * out = (MINIMUM.Compare(s) == 0) ? true: false;
76 class _OSP_EXPORT_ Short
81 * Initializes this instance of %Short with the specified @c value.
85 * @param[in] value A @c short value
87 Short(short value = 0);
90 * This is the copy constructor for the %Short class.
94 * @param[in] value An instance of %Short
96 Short(const Short& value);
99 * This is the destructor for this class.
103 virtual ~Short(void);
106 * Assigns the value of the specified instance to the current instance of %Short.
110 * @param[in] rhs An instance of %Short
112 Short& operator =(const Short& rhs);
115 * Compares the specified @c short values.
119 * @return A 32-bit @c signed @c integer value
120 * @param[in] s1 The first @c short value to compare
121 * @param[in] s2 The second @c short value to compare
124 * < 0 if @c s1 is less than @c s2
125 * == 0 if @c s1 is equal to @c s2
126 * > 0 if @c s1 is greater than @c s2
129 static int Compare(short s1, short s2);
132 * Compares the value of the current instance of the %Short class
133 * with the value of the specified instance of the %Short class.
137 * @return A @c signed 32-bit @c integer value
138 * @param[in] value An instance of the %Short class to compare
141 * < 0 if the value of the current instance is less than that of the specified instance
142 * == 0 if the value of the current instance is equal to that of the specified instance
143 * > 0 if the value of the current instance is greater than that of the specified instance
146 int CompareTo(const Short& value) const;
149 * Checks whether the value of the specified instance of Object is equal to the value of the current instance of %Short.
153 * @return @c true if the value of the specified instance of Object is equal to the value of the current instance of %Short, @n
155 * @param[in] obj An instance of Object to compare
156 * @remarks The method returns @c false if the specified object is not of the
158 * @see Tizen::Base::Object::Equals()
160 virtual bool Equals(const Object& obj) const;
164 * Checks whether the value of the current instance is equal to the specified @c short value.
168 * @return @c true if the value of the current instance is equal to the specified @c short value, @n
170 * @param[in] value A @c short value to compare
172 bool Equals(short value) const;
175 * Gets the hash value of the current instance of %Short.
179 * @return An integer value indicating the hash value of the current instance of %Short
180 * @remarks Two equal instances must return the same hash value. For better performance,
181 * the used hash function must generate a random distribution for all inputs. @n
182 * The default implementation of this method returns the value of the current instance.
184 virtual int GetHashCode(void) const;
187 * Gets the hash value of the specified @c short value.
191 * @return An integer value indicating the hash value of the specified @c short value
192 * @param[in] val A @c short value to get the hash value
194 static int GetHashCode(short val);
197 * Decodes a string into a @c signed @c short.
201 * @return An error code
202 * @param[in] s A numeric value
203 * @param[out] ret The result of the operation
204 * @exception E_SUCCESS The method is successful.
205 * @exception E_NUM_FORMAT The specified string does not contain a number that can be parsed.
206 * @exception E_OUT_OF_RANGE The decoded value is not between VALUE_MIN and VALUE_MAX range. @b Since: @b 3.0
208 * @remarks This method accepts decimal, hexadecimal, and octal numbers given by the
213 * Sign[opt] DecimalNumeral
214 * Sign[opt] 0x HexDigits
215 * Sign[opt] 0X HexDigits
216 * Sign[opt] # HexDigits
217 * Sign[opt] 0 OctalDigits
222 static result Decode(const String& s, short& ret);
225 * Parses the specified string representing a numeric value and
226 * returns the value as @c signed @c short.
230 * @return An error code
231 * @param[in] s A string representing a numeric value
232 * @param[out] ret The result of the operation
233 * @exception E_SUCCESS The method is successful.
234 * @exception E_NUM_FORMAT The specified string does not contain a number that can be parsed.
235 * @exception E_OUT_OF_RANGE The parsed value is not between VALUE_MIN and VALUE_MAX range. @b Since: @b 3.0
238 * - This method assumes that the string representing the numeric value uses a radix 10.
239 * - This method guarantees that the original value of out-parameter is not changed when the method returns error.
241 static result Parse(const String& s, short& ret);
244 * Parses the specified string representing a numeric value
245 * using the specified radix and returns the value as @c signed @c short.
249 * @return An error code
250 * @param[in] s A string representing a numeric value
251 * @param[in] radix The radix of the string representing a numeric value @n
252 * Radix value range is from 2 to 36.
253 * @param[out] ret The result of the operation
254 * @exception E_SUCCESS The method is successful.
255 * @exception E_NUM_FORMAT The specified string does not contain a number that can be parsed.
256 * @exception E_OUT_OF_RANGE The specified @c radix is invalid or
257 * The parsed value is not between VALUE_MIN and VALUE_MAX range. @b Since: @b 3.0
259 * @remarks This method guarantees that the original value of out-parameter is not changed when the method returns error.
261 static result Parse(const String& s, int radix, short& ret);
264 * Gets the @c signed @c char equivalent of the current instance of the %Short class.
268 * @return A @c signed @c char equivalent of the current instance
270 virtual char ToChar(void) const;
273 * Gets the @c signed @c short equivalent of the current instance of the %Short class.
277 * @return A @c signed @c short equivalent of the current instance
279 virtual short ToShort(void) const;
282 * Gets the @c signed @c int equivalent of the current instance of the %Short class.
286 * @return A @c signed @c int equivalent of the current instance
288 virtual int ToInt(void) const;
291 * Gets the @c signed @c long equivalent of the current instance of the %Short class.
295 * @return A @c signed @c long equivalent of the current instance
297 virtual long ToLong(void) const;
300 * Gets the @c signed @c long @c long equivalent of the current instance of the %Short class.
304 * @return A @c signed @c long @c long equivalent of the current instance
306 virtual long long ToLongLong(void) const;
309 * Gets the @c signed @c float equivalent of the current instance of the %Short class.
313 * @return A @c signed @c float equivalent of the current instance
315 virtual float ToFloat(void) const;
318 * Gets the @c signed @c double equivalent of the current instance of the %Short class.
322 * @return A @c signed @c double equivalent of the current instance
324 virtual double ToDouble(void) const;
327 * Gets the string representing the value of the current instance of the %Short class.
331 * @return A string representing the value of the current instance
333 virtual String ToString(void) const;
336 * Gets the string representing the specified @c signed @c short value.
340 * @return A string containing a Unicode representation of the specified @c signed @c short value
341 * @param[in] value A @c signed @c short value to convert
343 static String ToString(short value);
346 * A constant holding the maximum value a @c short will be equal to 2^15-1.
350 static const short VALUE_MAX = (short) 0x7FFF;
353 * A constant holding the minimum value a @c short will be equal to -2^15.
357 static const short VALUE_MIN = (short) 0x8000;
360 * A @c short value of this instance.
368 friend class _ShortImpl;
369 class _ShortImpl * __pShortImpl;
375 #endif //_FBASE_SHORT_H_