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 FBaseLongLong.h
19 * @brief This is the header file for the %LongLong class.
21 * This header file contains the declarations of the %LongLong class.
23 * @see Tizen::Base::Number
25 #ifndef _FBASE_LONG_LONG_H_
26 #define _FBASE_LONG_LONG_H_
28 #include <FBaseNumber.h>
30 namespace Tizen { namespace Base
34 * @brief This class is the wrapper class for the @c signed @c long @c long built-in type.
38 * The %LongLong class represents an integer value ranging from @c -9223372036854775808 to @c 9223372036854775807,
39 * that is, @c -(2^63) to @c +((2^63)-1). The class is useful when passing a 64-bit @c signed
40 * integral value to a method that accepts only an instance of Object. Furthermore,
41 * this class provides methods for converting %LongLong (and @c long @c long) to String, and %String
42 * to %LongLong (and @c long @c long).
44 * The following example demonstrates how to use the %LongLong 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 64-bit integral value
55 * MyClass::Verify(String& string, bool& out)
57 * static const LongLong MINIMUM(123456789);
58 * result r = E_SUCCESS;
61 * r = LongLong::Parse(string, l);
67 * out = (MINIMUM.CompareTo(l) == 0) ? true: false;
75 class _OSP_EXPORT_ LongLong
80 * Initializes this instance of %LongLong with the specified value.
84 * @param[in] value The @c long @c long value
86 LongLong(long long value = 0);
89 * Copying of objects using this copy constructor is allowed.
93 * @param[in] value An instance of %LongLong to copy
95 LongLong(const LongLong& value);
98 * This destructor overrides Tizen::Base::Object::~Object().
102 virtual ~LongLong(void);
105 * Copying of objects using this copy assignment operator is allowed.
109 * @param[in] rhs An instance of %LongLong to copy
111 LongLong& operator =(const LongLong& rhs);
114 * Compares two @c long @c long values.
118 * @return The 32-bit @c signed integer value
120 * < 0 if the value of l1 is less than the value of l2
121 * == 0 if the value of l1 is equal to the value of l2
122 * > 0 if the value of l1 is greater than the value of l2
124 * @param[in] l1 The first @c long @c long value to compare
125 * @param[in] l2 The second @c long @c long value to compare
127 static int Compare(long long l1, long long l2);
130 * Compares the value of the current instance with the value of the specified instance of %LongLong.
134 * @return The 32-bit @c signed integer value
136 * < 0 if the value of the current instance is less than the value of the specified instance
137 * == 0 if the value of the current instance is equal to the value of the specified instance
138 * > 0 if the value of the current instance is greater than the value of the specified instance
140 * @param[in] value An instance of %LongLong to compare
142 int CompareTo(const LongLong& value) const;
145 * Checks whether the value of the specified instance of Object is equal to the value of the current instance of %LongLong.
149 * @return @c true if the value of the specified instance of Object is equal to the value of the current instance of %LongLong, @n
151 * @param[in] obj An instance of Object to compare
152 * @see Tizen::Base::Object::Equals()
154 virtual bool Equals(const Object& obj) const;
157 * Gets the hash value of the current instance of %LongLong.
161 * @return The integer value that indicates the hash value of the current instance of %LongLong
163 * - Two equal instances must return the same hash value. @n
164 * For better performance, the used hash function must generate a random distribution for all the 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 long @c long value.
174 * @return The integer value that indicates the hash value of the specified @c long @c long value
175 * @param[in] val The @c long @c long value used to get the hash value
177 static int GetHashCode(long long val);
180 * Gets the @c signed @c char equivalent of the current instance of %LongLong.
184 * @return The @c signed @c char equivalent of the current instance
186 virtual char ToChar(void) const;
189 * Gets the @c signed @c short equivalent of the current instance of %LongLong.
193 * @return The @c signed @c short equivalent of the current instance
195 virtual short ToShort(void) const;
198 * Gets the @c signed @c int equivalent of the current instance of %LongLong.
202 * @return The @c signed @c int equivalent of the current instance
204 virtual int ToInt(void) const;
207 * Gets the @c signed @c long equivalent of the current instance of %LongLong.
211 * @return The @c signed @c long equivalent of the current instance
213 virtual long ToLong(void) const;
216 * Gets the @c signed @c float equivalent of the current instance of %LongLong.
220 * @return The @c signed @c float equivalent of the current instance
222 virtual float ToFloat(void) const;
225 * Gets the @c signed @c double equivalent of the current instance of %LongLong.
229 * @return The @c signed @c double equivalent of the current instance
231 virtual double ToDouble(void) const;
234 * Gets the @c signed @c long @c long equivalent of the current instance of %LongLong.
238 * @return The @c signed @c long @c long equivalent of the current instance
240 virtual long long ToLongLong(void) const;
243 * Gets the string that represents the value of the current instance of %LongLong.
247 * @return The string that represents the value of the current instance
249 virtual String ToString(void) const;
252 * Gets the string that represents the specified @c signed @c long @c long value.
256 * @return The string that contains the Unicode representation of the specified @c signed @c long @c long value
257 * @param[in] value The @c signed @c long @c long value to convert
259 static String ToString(long long value);
262 * Parses the specified string that represents a numeric value and
263 * returns the value as a @c signed @c long @c long (as out parameter).
267 * @return An error code
268 * @param[in] s The string that represents the numeric value
269 * @param[out] ret The result of the operation
270 * @exception E_SUCCESS The method is successful.
271 * @exception E_NUM_FORMAT The specified string does not contain a number that can be parsed.
273 * - This method assumes that the string that represents the numeric value uses a radix @c 10.
274 * - This method guarantees that the original value of the out-parameter is not changed when the method returns an error.
276 static result Parse(const String& s, long long& ret);
279 * Parses the specified string that represents a numeric value using the specified radix and
280 * returns the value as a @c signed @c long @c long (as out parameter).
284 * @return An error code
285 * @param[in] s The string that represents the numeric value
286 * @param[in] radix The radix of the string that represents a numeric value @n
287 * It must be either 2, 8, 10 or 16.
288 * @param[out] ret The result of the operation
289 * @exception E_SUCCESS The method is successful.
290 * @exception E_NUM_FORMAT The specified string does not contain a number that can be parsed.
291 * @exception E_OUT_OF_RANGE The specified @c radix is invalid.
292 * @remarks This method guarantees that the original value of the out-parameter is not changed when the method returns an error.
294 static result Parse(const String& s, int radix, long long& ret);
297 * The constant holding the maximum value a @c long @c long can have; @c 2^63-1.
301 static const long long VALUE_MAX = (long long) 0x7FFFFFFFFFFFFFFFLL;
304 * The constant holding the minimum value a @c long @c long can have; @c -2^63.
308 static const long long VALUE_MIN = (long long) 0x8000000000000000LL;
311 * The @c long @c long value of this instance.
319 friend class _LongLongImpl;
320 class _LongLongImpl* __pLongLongImpl;
326 #endif //_FBASE_LONG_LONG_H_