//
/**
- * @file FBase.h
- * @brief This is the header file for the %Base namespace.
+ * @file FBase.h
+ * @brief This is the header file for the %Base namespace.
*
* This header file contains the declarations and descriptions of the %Base namespace.
*/
* @since 2.0
*
* @remarks @b Header @b %file: @b \#include @b <FBase.h> @n
- * @b Library : @b osp-appfw
+ * @b Library: @b osp-appfw
*
* The %Base namespace contains classes and interfaces around which the entire %Tizen platform is built.
* The main features of the namespace include basic data types, collections, runtime libraries, and various utilities.
*
* For more information on the %Base namespace features, see <a href="../org.tizen.native.appprogramming/html/guide/base/base_namespace.htm">Base Guide</a>.
*
- * The following diagram illustrates the relationships between the classes belonging to the %Base namespace.
- * @image html base_namespace_classdiagram.png
+ * The following diagram illustrates the relationships between the classes belonging to the %Base namespace.
+ * @image html base_namespace_classdiagram.png
*
*
*
*
* @since 2.0
*
- * The %Boolean class wraps a bool type value. This enables passing a bool value to a method that only accepts an instance of the Object class.
+ * The %Boolean class wraps a boolean type value. This enables passing a boolean value to a method that only accepts an instance of the Object class.
* It provides methods to convert %Boolean instances to String and %String instances to %Boolean.
*
* The following example demonstrates how to use the %Boolean class.
{
public:
/**
- * Initializes this instance of the %Boolean class with the specified @c value.
+ * Initializes this instance of %Boolean with the specified @c value.
*
* @since 2.0
*
- * @param[in] value The input @c bool value to initialize the %Boolean instance
+ * @param[in] value The @c bool value used to initialize %Boolean
*/
Boolean(bool value);
*
* @since 2.0
*
- * @param[in] value An instance of the %Boolean class
+ * @param[in] value An instance of %Boolean
*/
Boolean(const Boolean& value);
/**
* Initializes this instance of %Boolean with the specified input string. @n
- * If the input is "true" (ignoring case), the object is initialized to @c true,
- * else @c false.
+ * If the input is "true" (ignoring cases), the object is initialized to @c true,
+ * otherwise to @c false.
*
* @since 2.0
*
*
* @since 2.0
*
- * @return @c true if the values of the objects are equal, @n
- * else @c false.
+ * @return @c true if the values of the objects are equal, @n
+ * else @c false
* @param[in] rhs An instance of %Boolean to compare with the current instance
*/
bool operator ==(const Boolean& rhs) const;
*
* @since 2.0
*
- * @return @c true if the values of the objects are not equal, @n
+ * @return @c true if the values of the objects are not equal, @n
* else @c false
* @param[in] rhs An instance of %Boolean to compare with the current instance
*/
Boolean& operator =(const Boolean& rhs);
/**
- * Converts an instance of the Object class to an instance of %Boolean and then
- * compares it with the calling %Boolean instance.
+ * Compares the specified Object instance with the current %Boolean instance.
*
* @since 2.0
*
- * @return @c true if the value of @c obj matches the value of the calling %Boolean instance, @n
+ * @return @c true if @c obj matches the current %Boolean instance, @n
* else @c false
- * @param[in] obj A reference to the Object instance to compare with the calling %Boolean instance
+ * @param[in] obj A reference to the Object instance to compare with the current %Boolean instance
* @see Tizen::Base::Object::Equals()
*/
virtual bool Equals(const Object& obj) const;
*
* @since 2.0
*
- * @return The hash value of the current instance
- * @remarks The two Tizen::Base::Object::Equals() instances must return the same hash value. For better performance, @n
- * the used hash function must generate a random distribution for all inputs.
+ * @return The hash value of the current instance
+ * @remarks The two Tizen::Base::Object::Equals() instances must return the same hash value. @n
+ * For better performance, the used hash function must generate a random distribution for all the inputs.
*/
virtual int GetHashCode(void) const;
/**
- * Converts a bool value to an instance of %Boolean and then
- * compares it with the calling %Boolean instance.
+ * Converts a @c bool value to an instance of %Boolean and then
+ * compares it with the current %Boolean instance.
*
* @since 2.0
*
- * @return @c true if the parameter matches the calling %Boolean instance, @n
+ * @return @c true if @c value matches the current %Boolean instance, @n
* else @c false
* @param[in] value The @c bool value to compare to this instance
*/
bool Equals(bool value) const;
/**
- * Returns the value of the calling object as @c bool.
+ * Returns the value of the current object as @c bool.
*
* @since 2.0
*
- * @return The value of the %Boolean instance as bool
+ * @return The value of the %Boolean instance as @c bool
*/
bool ToBool(void) const;
* @since 2.0
*
* @return @c true if the value of the specified string is "true", @n
- * else @c false
+ * else @c false
* @param[in] s An instance of String
- * @remarks This method is case sensitive. @n
- * It only accepts lowercase strings.
+ * @remarks This method is case sensitive and accepts only lowercase strings.
*
* @code
* bool b1 = Boolean::Parse(trueString); // trueString is L"true"
* @since 2.0
*
* @return @c true if the value of the specified string is "true", @n
- * else @c false
+ * else @c false
* @param[in] s An instance of String
* @param[in] caseSensitive Set to @c true to perform a
* case sensitive comparison of string @c s
- * @remarks If @c caseSensitive is @c true, L"True" returns @c false, else @c true.
+ * @remarks If @c caseSensitive is @c true, L"True" returns @c false, else it returns @c true.
*
* @code
* bool b1 = Boolean::Parse(L"True", false ); // Returns @c true
static bool Parse(const String& s, bool caseSensitive);
/**
- * Converts the value of the calling instance from @c bool to String.
+ * Converts the value of the current instance from @c bool to String.
*
* @since 2.0
*
- * @return @c true if this instance is @c true, @n
+ * @return @c true if this instance is @c true, @n
* else @c false
*/
String ToString(void) const;
*
* @since 2.0
*
- * @return @c true if the parameter is @c true, @n
+ * @return @c true if the parameter is @c true, @n
* else @c false
- * @param[in] value A @c bool value to convert to String
+ * @param[in] value The @c bool value to convert to String
*/
static String ToString(bool value);
* @file FBaseBuffer.h
* @brief This is the header file for the %Buffer class.
*
- * This header file contains the declarations of the %Buffer classes.
+ * This header file contains the declarations of the %Buffer class.
*/
#ifndef _FBASE_BUFFER_H_
#define _FBASE_BUFFER_H_
*
* The %Buffer class represents a linear finite sequence of elements of the same type.
* It is a means of defining an aggregation of the same type of objects, similar to an array.
- * @n
+ *
* For more information on the class features, see <a href="../org.tizen.native.appprogramming/html/guide/base/buffer.htm">Buffer</a>.
*
* @see Tizen::Base::BufferBase
public:
/**
- * This is the default constructor for this class.
- *
- * @since 2.0
+ * This is the default constructor for this class. @n
+ * After creating an instance of the %Buffer class, one of the Construct() methods must be called explicitly to initialize this instance.
*
- * @remarks After creating an instance of the %Buffer class, one of the Construct() methods must be called explicitly to initialize this instance.
- * @see Construct()
+ * @since 2.0
*/
Buffer(void)
{
*
* @param[in] buffer The other %Buffer instance
* @exception E_SUCCESS The method is successful.
- * @exception E_INVALID_ARG The specified input parameter is invalid, or
- * the source buffer is not constructed.
+ * @exception E_INVALID_ARG Either of the following conditions has occured:
+ * - The specified input parameter is invalid.
+ * - The source buffer has not been constructed.
* @see Buffer()
*/
result Construct(const Buffer< Type >& buffer)
* @since 2.0
*
* @return An error code
- * @param[in] pBuffer The buffer which is shared
+ * @param[in] pBuffer The shared buffer
* @param[in] index The starting index of the buffer from where the first @c byte value is read
- * @param[in] length The number of bytes to read from the given buffer @n This is a limit of this instance.
+ * @param[in] length The number of bytes to read from the given buffer @n
+ * This is the limit of this instance.
* @param[in] capacity The capacity of this instance
* @exception E_SUCCESS The method is successful.
- * @exception E_INVALID_ARG A specified input parameter is invalid, or
- * the @c pBuffer is @c null.
- * @exception E_OUT_OF_RANGE The specified @c index is outside the bounds of the data structure, or
- * the @c index is larger than the @c length.
+ * @exception E_INVALID_ARG Either of the following conditions has occured:
+ * - A specified input parameter is invalid.
+ * - The specified @c pBuffer is @c null.
+ * @exception E_OUT_OF_RANGE Either of the following conditions has occured:
+ * - The specified @c index is outside the bounds of the data structure.
+ * - The specified @c index is larger than the specified @c length.
*/
result Construct(const Type* pBuffer, int index, int length, int capacity)
{
}
/**
- * This subscript operator returns the reference to the element indicated by the given @c index.
+ * Returns a reference to the element indicated by the given @c index.
*
* @since 2.0
*
* @return A reference to the indexed element
* @param[in] index The index of the element @n
- * It must be less than the limit.
+ * It must be less than the limit.
*/
Type& operator [](int index) const
{
}
/**
- * Overloaded equality operator to compare two %Buffer instances.
+ * Checks whether two %Buffer instances are equal.
*
* @since 2.0
*
- * @return @c true if the buffers being compared are equal, @n
+ * @return @c true if the two %Buffer instances are equal, @n
* else @c false
- * @param[in] buffer The buffer to compare with the current instance of %Buffer
- * @remarks This method returns @c true only if the two buffers have the same number of remaining elements @n
- * and the two sequences of remaining elements are equal (considered independently of their starting positions).
+ * @param[in] buffer The buffer to compare with the current instance of %Buffer
+ * @remarks This method returns @c true only if the two buffers have the same number of remaining elements @n
+ * and the sequences of the remaining elements are equal (considered independent of their starting positions).
* @see Equals()
*/
bool operator ==(const Buffer< Type >& buffer) const
}
/**
- * Checks whether the two %Buffer instances are not equal.
+ * Checks whether two %Buffer instances are not equal.
*
* @since 2.0
*
- * @return @c true if the buffers are not equal, @n
+ * @return @c true if the two %Buffer instances are not equal, @n
* else @c false
- * @param[in] buffer The buffer to compare with the current instance of %Buffer
- * @remarks This method returns @c false only if the two buffers being compared have the same @n
- * number of remaining elements and the two sequences of remaining elements are equal @n
- * (considered independently of their starting positions).
+ * @param[in] buffer The buffer to compare with the current instance of %Buffer
+ * @remarks This method returns @c false only if the two buffers have the same @n
+ * number of remaining elements and the sequences of the remaining elements are equal @n
+ * (considered independent of their starting positions).
* @see Equals()
*/
bool operator !=(const Buffer< Type >& buffer) const
/**
* Copies the remaining elements of the input %Buffer instance into the current
* %Buffer instance. @n
- * It returns E_OVERFLOW if the remaining part of the current instance is smaller
+ * It returns @c E_OVERFLOW if the remaining part of the current instance is smaller
* than the remaining part of the input instance.
*
* @since 2.0
*
* @return An error code
- * @param[in] buffer The source buffer from which bytes are read @n
- * It must not be the current instance of %Buffer.
+ * @param[in] buffer The source buffer from which bytes are read @n
+ * It must not be the current instance of %Buffer.
* @exception E_SUCCESS The method is successful.
- * @exception E_INVALID_ARG The specified input parameter is invalid, or
- * the source buffer is same as destination buffer,
+ * @exception E_INVALID_ARG Either of the following conditions has occured:
+ * - The specified input parameter is invalid.
+ * - The source buffer is same as destination buffer,
* that is, the current instance of %Buffer.
- * @exception E_OVERFLOW The operation (arithmetic/casting/conversion) has caused an overflow. @n
- * The number of remaining bytes of the current buffer is less than
- * the number of remaining bytes of the given buffer.
+ * @exception E_OVERFLOW Either of the following conditions has occured:
+ * - The operation (arithmetic/casting/conversion) has caused an overflow.
+ * - The number of remaining bytes in the current buffer is less than
+ * the number of remaining bytes in the given buffer.
* @remarks After the copy operation, the current (destination) buffer's position and the given
* (source) buffer's position are incremented by the number of elements copied (the number
* of remaining elements of the given buffer). @n
* If the remaining part of the current instance is not less than the remaining part of the input instance,
- * the effect of this method and the ReadFrom() method is the same. But when the remaining part of the
- * current instance is less, ReadFrom() method copies the number of remaining elements of the current
- * instance while this method returns E_OVERFLOW and does not transfer.
- * @see ReadFrom()
+ * the effect of this method and the ReadFrom() method is the same. @n
+ * But when the remaining part of the current instance is less, the ReadFrom() method copies the number of remaining
+ * elements of the current instance while this method returns @c E_OVERFLOW and does not transfer.
*
* The following example demonstrates how to use the %CopyFrom() method.
*
}
/**
- * Reads the value from the current position in the buffer, and then increments the position. @n
- * Provides a way for relative indexing and reading.
+ * Reads the value of the current position in the buffer, and then increments the position. @n
+ * Provides a way to perform relative indexing and reading.
*
* @since 2.0
*
* @return An error code
- * @param[out] value The value at the current position
+ * @param[out] value The value at the current position
* @exception E_SUCCESS The method is successful.
- * @exception E_UNDERFLOW The operation (arithmetic/casting/conversion) has caused an underflow. @n
- * The current position is greater than the limit.
+ * @exception E_UNDERFLOW Either of the following conditions has occured:
+ * - The operation (arithmetic/casting/conversion) has caused an underflow.
+ * - The current position is greater than the limit.
* @see Set()
*/
result Get(Type& value)
/**
* Reads the value at the given @c index. @n
- * Provides a way for absolute indexing and reading.
+ * Provides a way to preform absolute indexing and reading.
*
* @since 2.0
*
* @return An error code
- * @param[in] index The index into the buffer from where the value is read
- * @param[out] value The value at the given index
- * @exception E_SUCCESS The method is successful.
- * @exception E_OUT_OF_RANGE The specified @c index is outside the bounds of the data structure. @n
- * The @c index is greater than the limit or less than @c 0.
+ * @param[in] index The buffer index from where the value is read
+ * @param[out] value The value at the given index
+ * @exception E_SUCCESS The method is successful.
+ * @exception E_OUT_OF_RANGE Either of the following conditions has occured:
+ * - The specified @c index is outside the bounds of the data structure.
+ * - The specified @c index is greater than the limit.
+ * - The specified @c index is less than @c 0.
* @see Set()
*/
result Get(int index, Type& value) const
/**
- * Copies the specified range of values from the calling buffer to the specified destination array as per the given @c index of the array.
+ * Copies the specified range of values from the calling buffer to the specified @c index of the destination array.
*
* @since 2.0
*
* @return An error code
- * @param[out] pArray A pointer to the array into which values are written
- * @param[in] index The starting index in the array of the first value to write
- * @param[in] length The number of values from the buffer to write to the array
+ * @param[out] pArray A pointer to the array into which the values are written
+ * @param[in] index The starting index in the array where the first value is written
+ * @param[in] length The number of values to write from the buffer to the array
* @exception E_SUCCESS The method is successful.
- * @exception E_INVALID_ARG A specified input parameter is invalid, or
- * the @c pArray is @c null.
- * @exception E_OUT_OF_RANGE The specified index is outside the bounds of the data structure, or
- * the @c index or length is less than @c 0.
- * @exception E_UNDERFLOW The operation (arithmetic/casting/conversion) has caused an underflow. @n
- * The remaining elements of this buffer are smaller than @c length.
- * @remarks After the copy operation, the position is incremented by @c length.
+ * @exception E_INVALID_ARG Either of the following conditions has occured:
+ * - A specified input parameter is invalid.
+ * - The specified @c pArray is @c null.
+ * @exception E_OUT_OF_RANGE Either of the following conditions has occured:
+ * - The specified @c index is outside the bounds of the data structure.
+ * - The specified @c index or @c length is less than @c 0.
+ * @exception E_UNDERFLOW Either of the following conditions has occured:
+ * - The operation (arithmetic/casting/conversion) has caused an underflow.
+ * - The remaining elements of this buffer are smaller than the specified @c length.
+ * @remarks After the copy operation, the position is incremented by @c length.
* @see SetArray()
*/
result GetArray(Type* pArray, int index, int length)
/**
* Transfers bytes from the input buffer into the calling buffer. @n
- * If the empty space in the calling buffer is larger than the remaining values from the input buffer,
- * all the remaining elements from the input are copied to the destination. @n
+ * If the empty space in the calling buffer is larger than the remaining values of the input buffer,
+ * then all the remaining elements from the input are copied to the destination. @n
* Otherwise, the number of bytes copied equals the number of elements remaining in the calling buffer.
*
* @since 2.0
*
* @return An error code
- * @param[in] buffer The source buffer from where the bytes are read @n
- * It must not be this buffer.
+ * @param[in] buffer The source buffer from where the bytes are read @n
+ * It must not be this buffer.
* @exception E_SUCCESS The method is successful.
- * @exception E_INVALID_ARG The specified input parameter is invalid. @n
- * The given buffer is same as the current buffer instance.
+ * @exception E_INVALID_ARG Either of the following conditions has occured:
+ * - The specified input parameter is invalid.
+ * - The given buffer is same as the current buffer instance.
* @remarks After the copy operation, the current (destination) buffer's position and the given
- * (source) buffer's position are incremented by the number of elements copied (the smaller value
+ * (source) buffer's position are incremented by the number of elements copied (the smaller value
* between the number of elements remaining in the calling buffer and the source buffer). @n
- * If there are more elements remaining in the calling buffer than elements remaining in the input instance,
- * this method is equivalent to CopyFrom() method. If there are less remaining elements in the
- * calling buffer, the %CopyFrom() method returns @c E_OVERFLOW and does not transfer
- * while this method copies the number of remaining elements of the current instance.
- * @see CopyFrom()
+ * If there are more elements remaining in the calling buffer than the elements remaining in the input instance,
+ * then this method is equivalent to the CopyFrom() method. @n
+ * If there are less elements remaining in the calling buffer, then the %CopyFrom() method
+ * returns @c E_OVERFLOW and does not transfer, while this method copies the number of remaining elements
+ * of the current instance.
*
* The following example demonstrates how to use the %ReadFrom() method.
*
/**
* Writes the specified @c value into the current buffer instance at the current position,
* and then increments the position. @n
- * Provides a way for relative indexing and writing.
+ * Provides a way to perform relative indexing and writing.
*
* @since 2.0
*
* @return An error code
- * @param[in] value The value to write to the calling %Buffer
+ * @param[in] value The value to write into the calling %Buffer
* @exception E_SUCCESS The method is successful.
- * @exception E_OVERFLOW The operation (arithmetic/casting/conversion) has caused an overflow. @n
- * The current position is not smaller than the limit.
+ * @exception E_OVERFLOW Either of the following conditions has occured:
+ * - The operation (arithmetic/casting/conversion) has caused an overflow.
+ * - The current position is not smaller than the limit.
* @see Get()
*/
result Set(Type value)
}
/**
- * Writes the specified @c value into the current instance of buffer at the given @c index. @n
- * Provides a way for absolute indexing and writing.
+ * Writes the specified @c value into the current instance of the buffer at the given @c index. @n
+ * Provides a way to perform absolute indexing and writing.
*
* @since 2.0
*
* @return An error code
- * @param[in] index The index at which the value is written
- * @param[in] value The value to write
+ * @param[in] index The index at which the value is written
+ * @param[in] value The value to write
* @exception E_SUCCESS The method is successful.
- * @exception E_OUT_OF_RANGE The specified index is outside the bounds of the data structure, or
- * the @c index is not smaller than the limit or less than @c 0.
+ * @exception E_OUT_OF_RANGE Either of the following conditions has occured:
+ * - The specified index is outside the bounds of the data structure.
+ * - The specified @c index is not smaller than the limit.
+ * - The specified @c index is less than @c 0.
* @see Get()
*/
result Set(int index, Type value)
* @since 2.0
*
* @return An error code
- * @param[in] pArray A pointer to the array from where the values are read
- * @param[in] index The starting index of the array
- * @param[in] length The number of values read from the given array
+ * @param[in] pArray A pointer to the array from where the values are read
+ * @param[in] index The starting index of the array
+ * @param[in] length The number of values read from the given array
* @exception E_SUCCESS The method is successful.
- * @exception E_INVALID_ARG A specified input parameter is invalid, or
- * the @c pArray is @c null.
- * @exception E_OUT_OF_RANGE The specified index is outside the bounds of the data structure, or
- * the @c index or length is less than @c 0.
- * @exception E_OVERFLOW The operation (arithmetic/casting/conversion) has caused an overflow. @n
- * The remainder of this buffer is smaller than @c length.
- * @remarks This method copies @c length number of values from the source array,
- * starting from the given @c index in the array, into the calling
- * buffer, starting at the current position.
+ * @exception E_INVALID_ARG Either of the following conditions has occured:
+ * - A specified input parameter is invalid.
+ * - The specified @c pArray is @c null.
+ * @exception E_OUT_OF_RANGE Either of the following conditions has occured:
+ * - The specified @c index is outside the bounds of the data structure.
+ * - The specified @c index or @c length is less than @c 0.
+ * @exception E_OVERFLOW Either of the following conditions has occured:
+ * - The operation (arithmetic/casting/conversion) has caused an overflow.
+ * - The remainder of this buffer is smaller than the specified @c length.
+ * @remarks This method copies @c length number of values starting from the given @c index of the source array,
+ * into the calling buffer, starting from the current position. @n
* After the copy operation, the position is incremented by @c length.
* @see GetArray()
*/
/**
* Creates a new %Buffer instance. @n
* Its content is a shared portion of
- * the calling %Buffer instance that starts from the current position of calling %Buffer instance.
+ * the calling %Buffer instance that starts from the current position of the calling %Buffer instance.
*
* @since 2.0
*
- * @return A pointer to the new buffer
- * @remarks The content of the new buffer starts at the current position of this instance of %Buffer.
+ * @return A pointer to the new %Buffer instance
+ * @remarks The content of the new buffer starts at the current position of this %Buffer instance. @n
* The new buffer's position is @c 0, its capacity and limit is
* the number of bytes remaining in the current instance of %Buffer,
* and it is marked as undefined.
}
/**
- * Compares the Object instance with the calling %Buffer instance for equivalence.
+ * Compares the Object instance with the current %Buffer instance for equality.
*
* @since 2.0
*
- * @return @c true if the input equals the calling %Buffer instance, @n
+ * @return @c true if the input equals the current %Buffer instance, @n
* else @c false
- * @param[in] obj The object to compare with the calling %Buffer
- * @remarks This method returns @c true if and only if the specified object is also an instance of %Buffer class,
+ * @param[in] obj The object to compare with the current %Buffer instance
+ * @remarks This method returns @c true if and only if the specified object is also an instance of %Buffer,
* the two buffers have the same number of remaining elements, and the two sequences of
- * remaining elements are equal (considered independently of their starting positions).
+ * remaining elements are equal (considered independent of their starting positions).
* @see Tizen::Base::BufferBase::GetHashCode()
*/
virtual bool Equals(const Tizen::Base::Object& obj) const
*
* @since 2.0
*
- * @return The hash value of the current instance
+ * @return The hash value of the current instance
* @remarks The hash code of a buffer depends only upon its remaining elements.
*/
virtual int GetHashCode(void) const
void Clear(void);
/**
- * Copies the elements between the current position and limit (that are also known as remaining
+ * Copies the elements between the current position and the limit (that are also known as the remaining
* elements), to the beginning of the calling %BufferBase instance.
*
* @since 2.0
*
* @remarks After copying, the position is set to the number of elements copied rather than to @c 0,
* so that an invocation of this method can be followed immediately by an invocation
- * of another relative set method. The limit is set to the capacity, and the mark is discarded.
+ * of another relative set method. @n
+ * The limit is set to the capacity, and the mark is discarded.
*/
void Compact(void);
*
* @since 2.0
*
- * @param[in] to The value to set the buffer position @n
+ * @param[in] to The value of the buffer position to set @n
* The parameter may contain @c POSITION_TO_ZERO or @c POSITION_TO_MARK.
- * @remarks If @c to is POSITION_TO_ZERO (or unspecified), the position is set to @c 0 after setting a limit to
+ * @remarks If @c to is @c POSITION_TO_ZERO (or unspecified), the position is set to @c 0 after setting a limit to
* the current position, and the mark is discarded.
- * Otherwise, if @c to is POSITION_TO_MARK, the position is set to the mark and
- * the mark is not discarded. If the mark is undefined, the position is set to @c 0.
+ * Otherwise, if @c to is @c POSITION_TO_MARK, the position is set to the mark and
+ * the mark is not discarded. @n
+ * If the mark is undefined, the position is set to @c 0.
*
* The following example demonstrates how to use the %Flip() method.
*
* @since 2.0
*
* @return The hash value of the calling object
- * @remarks The hash code of a buffer depends only upon its remaining elements.
+ * @remarks The hash code of a buffer depends only upon its remaining elements.
* @see Tizen::Base::Object::Equals()
*/
virtual int GetHashCode(void) const;
*
* @return An error code
* @exception E_SUCCESS The method is successful.
- * @exception E_INVALID_OPERATION The current state of the instance prohibits the execution of the specified operation. @n
- * The mark has not been set.
+ * @exception E_INVALID_OPERATION Either of the following conditions has occurred:
+ * - The current state of the instance prohibits the execution of the specified operation.
+ * - The mark has not been set.
* @remarks Invoking this method neither changes nor discards the mark's value.
*/
result Reset(void);
/**
* Shifts the limit of the current instance of %BufferBase. @n
- * The new limit is the current limit plus the given amount.
+ * The new limit is the current limit plus the given @c amount.
*
* @since 2.0
*
* @return An error code
- * @param[in] amount The quantity of shift needed
+ * @param[in] amount The quantity of the shift needed
* @exception E_SUCCESS The method is successful.
- * @exception E_OUT_OF_RANGE The value of an argument is outside the valid range defined by the method. @n
- * The @c amount is larger than the capacity or smaller than @c 0 starting from the current limit.
- * @remarks If the position is larger than the new limit, it is set to the new limit.
- * If the mark is defined and larger than the new limit, it is discarded.
+ * @exception E_OUT_OF_RANGE Either of the following conditions has occurred:
+ * - The value of the argument is outside the valid range defined by the method.
+ * - The @c amount is larger than the capacity starting from the current limit.
+ * - The @c amount is smaller than @c 0.
+ * @remarks
+ * - If the position is larger than the new limit, it is set to the new limit.
+ * - If the mark is defined and is larger than the new limit, it is discarded.
* @see SetLimit()
*/
result ShiftLimit(int amount);
*
* @since 2.0
*
- * @return The capacity of the calling object
+ * @return The capacity of the calling %BufferBase instance
*/
int GetCapacity(void) const;
*
* @since 2.0
*
- * @return The limit of the calling object
+ * @return The limit of the calling %BufferBase instance
* @see SetLimit()
*/
int GetLimit(void) const;
* @since 2.0
*
* @return An error code
- * @param[in] limit The new limit
+ * @param[in] limit The limit of the calling %BufferBase instance
* @exception E_SUCCESS The method is successful.
- * @exception E_OUT_OF_RANGE The value of an argument is outside the valid range defined by the method. @n
- * The @c limit is larger than the capacity or less than @c 0.
- * @remarks If the position is larger than the new limit, it is set to the new limit.
- * If the mark is defined and larger than the new limit, it is discarded.
+ * @exception E_OUT_OF_RANGE Either of the following conditions has occurred:
+ * - The value of the argument is outside the valid range defined by the method.
+ * - The specified @c limit is larger than the capacity.
+ * - The specified @c limit is less than @c 0.
+ * @remarks
+ * - If the position is larger than the new limit, it is set to the new limit.
+ * - If the mark is defined and is larger than the new limit, it is discarded.
* @see GetLimit()
*/
result SetLimit(int limit);
/**
* Sets the mark of the current instance of %BufferBase at the current position. @n
- * If this method is called after InvalidateMark(), the mark is set to @c -1.
+ * If this method is called after the InvalidateMark() method , the mark is set to @c -1.
*
- * @since 2.0
+ * @since 2.0
*
* @see GetMark()
*/
* @since 2.0
*
* @return An error code
- * @param[in] position The new position
+ * @param[in] position The position of the calling %BufferBase instance
* @exception E_SUCCESS The method is successful.
- * @exception E_OUT_OF_RANGE The value of an argument is outside the valid range defined by the method. @n
- * The @c position is larger than the current limit or less than @c 0.
- * @remarks If the mark is defined and larger than the new position then it is discarded.
+ * @exception E_OUT_OF_RANGE Either of the following conditions has occurred:
+ * - The value of the argument is outside the valid range defined by the method.
+ * - The specified @c position is larger than the current limit.
+ * - The specified @c position is less than @c 0.
+ * @remarks If the mark is defined and is larger than the new position then it is discarded.
* @see GetPosition()
*/
result SetPosition(int position);
/**
* Returns @c true if there is at least one element between the current position and
- * the limit of the current instance of %BufferBase. Otherwise, it returns @c false.
+ * the limit of the current %BufferBase instance. Otherwise, it returns @c false.
*
* @since 2.0
*
- * @return @c true if there is at least one element between the current position and the limit of the current instance of %BufferBase, @n
+ * @return @c true if there is at least one element between the current position and the limit of the current %BufferBase instance, @n
* else @c false
* @see GetRemaining()
*/
bool HasRemaining(void) const;
/**
- * Expands the capacity and the limit of the internal buffer with the specified capacity.
+ * Expands the capacity and the limit of the internal buffer with the specified @c newCapacity.
*
* @since 2.0
*
* @return An error code
* @param[in] newCapacity The new capacity of this instance
* @exception E_SUCCESS The method is successful.
- * @exception E_INVALID_ARG The specified @c capacity is less than the current capacity.
+ * @exception E_INVALID_ARG The specified @c newCapacity is less than the current capacity.
* @remarks After calling this method, the address of the internal buffer may be either the same or a new location.
*/
result ExpandCapacity(int newCapacity);
virtual ~_BufferData(void);
//
- // Gets the pointer to the byte array.
+ // Gets a pointer to the byte array.
//
// @since 2.0
// @return Pointer to the @c byte array
*
* @since 2.0
*
- * The %ByteBuffer class provides a means of encapsulating a sequence of bytes in memory. It defines
+ * The %ByteBuffer class provides a means of encapsulating a sequence of bytes in the memory. It defines
* methods to read and write all primitive built-in types (except @c bool), to and from a sequence of
* bytes. These methods read the size of primitive type bytes from a @c byte sequence and
* convert it to the actual primitive type.
public:
/**
- * The object is not fully constructed after this constructor is called.
+ * The object is not fully constructed after this constructor is called. @n
* For full construction, the Construct() method must be called right after calling this constructor.
*
* @since 2.0
*
- * @remarks After creating an instance of the %ByteBuffer class, one of the Construct() methods must be called explicitly to initialize this instance.
- * @see Construct()
+ * @remarks After creating an instance of %ByteBuffer, one of the Construct() methods must be called explicitly to initialize this instance.
*/
ByteBuffer(void);
virtual ~ByteBuffer(void);
/**
- * Initializes this instance of %ByteBuffer which is a view of the specified buffer. @n
- * This is the copy constructor for the %ByteBuffer class.
+ * Initializes this instance of %ByteBuffer which is a view of the specified @c buffer. @n
+ * This is the copy constructor of the %ByteBuffer class.
*
* @since 2.0
*
- * @param[in] buffer The %ByteBuffer instance used to initialize new object
+ * @param[in] buffer The %ByteBuffer instance used to initialize the new object
* @exception E_SUCCESS The method is successful.
- * @exception E_INVALID_ARG A specified input parameter is invalid, or
- * the source buffer is not constructed.
+ * @exception E_INVALID_ARG Either of the following conditions has occurred:
+ * - A specified input parameter is invalid.
+ * - The source buffer has not been constructed.
* @see ByteBuffer()
*/
result Construct(const ByteBuffer& buffer);
* @return An error code
* @param[in] capacity The number of elements
* @exception E_SUCCESS The method is successful.
- * @exception E_INVALID_ARG A specified input parameter is invalid, or
- * the specified @c capacity is negative.
+ * @exception E_INVALID_ARG Either of the following conditions has occurred:
+ * - A specified input parameter is invalid.
+ * - The specified @c capacity is negative.
* @see ByteBuffer()
*/
result Construct(int capacity);
* @since 2.0
*
* @return An error code
- * @param[in] pBuffer The buffer which is shared
+ * @param[in] pBuffer The shared buffer
* @param[in] index The starting index of the buffer from where the first @c byte value is read
- * @param[in] length The number of bytes to read from the given buffer @n This is a limit of this instance.
+ * @param[in] length The number of bytes to read from the given buffer @n
+ * This is the limit of this instance.
* @param[in] capacity The capacity of this instance
* @exception E_SUCCESS The method is successful.
- * @exception E_INVALID_ARG A specified input parameter is invalid, or
- * the @c pBuffer is @c null.
- * @exception E_OUT_OF_RANGE The specified index is outside the bounds of the data structure, or
- * the @c index is larger than the @c length.
+ * @exception E_INVALID_ARG Either of the following conditions has occurred:
+ * - A specified input parameter is invalid.
+ * - The specified @c pBuffer is @c null.
+ * @exception E_OUT_OF_RANGE Either of the following conditions has occurred:
+ * - The specified @c index is outside the bounds of the data structure.
+ * - The specified @c index is larger than or equal to the specfied @c capacity.
*/
result Construct(const byte* pBuffer, int index, int length, int capacity);
/**
- * Gets the reference to the byte value at the specified index.
+ * Gets a reference to the @c byte value at the specified @c index.
*
- * @since 2.0
+ * @since 2.0
*
* @return A reference to the @c byte value
* @param[in] index The index of the @c byte value in the calling %ByteBuffer instance @n
byte& operator [](int index);
/**
- * Gets the byte value at the specified index of const object.
+ * Gets the @c byte value at the specified @c index of the constant object.
*
* @since 2.0
*
- * @return A value to the @c byte value
+ * @return The @c byte value at the specified @c index
* @param[in] index The index of the @c byte value in the calling %ByteBuffer instance @n
* It must be less than the limit.
*/
byte operator [](int index) const;
/**
- * Compares the two %ByteBuffer instances.
+ * Compares two %ByteBuffer instances.
*
* @since 2.0
*
* @return @c true if the input buffer is equal to the calling %ByteBuffer instance, @n
* else @c false
* @param[in] buffer The %ByteBuffer instance to compare with the current instance
- * @remarks This method returns @c true only if the two buffers have the same number of
- * remaining elements, and the two sequences of remaining elements are equal
- * (considered independently, irrespective of their starting positions).
+ * @remarks This method returns @c true if the two buffers have the same number of
+ * remaining elements, and the sequences of the remaining elements are equal
+ * (considered independently, irrespective of their starting positions).
* @see Equals()
*/
bool operator ==(const ByteBuffer& buffer) const;
/**
- * Checks whether the current instance and the specified instance of %ByteBuffer are not equal.
+ * Checks whether the current instance and the specfied %ByteBuffer instance are not equal.
*
* @since 2.0
*
- * @return @c true if the two objects are not the same, @n
+ * @return @c true if the current instance and the specified %ByteBuffer instance are not equal, @n
* else @c false
- * @param[in] buffer The buffer to compare with the current instance
- * @remarks This method returns @c false only if the two buffers being compared have the same
- * number of remaining elements, and the two sequences of remaining elements are equal
- * (considered independently, irrespective of their starting positions).
+ * @param[in] buffer The %ByteBuffer instance to compare with the current instance
+ * @remarks This method returns @c false if the two buffers have the same
+ * number of remaining elements, and the sequences of the remaining elements are equal
+ * (considered independently, irrespective of their starting positions).
* @see Equals()
*/
bool operator !=(const ByteBuffer& buffer) const;
*
* @since 2.0
*
- * @return DoubleBuffer A pointer to the current position of the calling object
- * @remarks The content of the view buffer starts at the current position of the calling buffer.
- * The new buffer's position is zero, the mark is undefined, and the capacity and limit
- * are equal to the remaining part of this buffer divided by the size of @c double.
- * Any change to the byte buffer content is visible in the @c double buffer view, and vice versa.
+ * @return DoubleBuffer A pointer to the current position of the calling object
+ * @remarks
+ * - The content of the view buffer starts at the current position of the calling buffer.
+ * - The new buffer's position is zero, the mark is undefined, and the capacity and limit
+ * are equal to the remaining part of the calling buffer divided by the size of the @c double value.
+ * - Any change to the byte buffer content is visible in the @c double buffer view, and vice versa.
*/
DoubleBuffer* AsDoubleBufferN(void) const;
*
* @since 2.0
*
- * @return FloatBuffer A pointer to the current position of the calling buffer
- * @remarks The content of the view buffer starts at the current position of the calling buffer.
- * The new buffer's position is zero, the mark is undefined, and the capacity and limit
- * are equal to the remaining part of the calling buffer divided by the size of @c float.
- * Any change to the byte buffer content is visible in the @c float buffer view, and vice versa.
+ * @return FloatBuffer A pointer to the current position of the calling buffer
+ * @remarks
+ * - The content of the view buffer starts at the current position of the calling buffer.
+ * - The new buffer's position is zero, the mark is undefined, and the capacity and limit
+ * are equal to the remaining part of the calling buffer divided by the size of the @c float value.
+ * - Any change to the byte buffer content is visible in the @c float buffer view, and vice versa.
*/
FloatBuffer* AsFloatBufferN(void) const;
*
* @since 2.0
*
- * @return IntBuffer A pointer to the current position of the calling buffer
- * @remarks The content of the view buffer starts at the current position of the calling buffer.
- * The new buffer's position is zero, the mark is undefined, and the capacity and limit
- * are equal to the remaining part of calling buffer divided by the size of @c int.
- * Any change to the byte buffer content is visible in the Int buffer view, and vice versa.
+ * @return IntBuffer A pointer to the current position of the calling buffer
+ * @remarks
+ * - The content of the view buffer starts at the current position of the calling buffer.
+ * - The new buffer's position is zero, the mark is undefined, and the capacity and limit
+ * are equal to the remaining part of the calling buffer divided by the size of the @c int value.
+ * - Any change to the byte buffer content is visible in the @c int buffer view, and vice versa.
*/
IntBuffer* AsIntBufferN(void) const;
*
* @since 2.0
*
- * @return LongBuffer A pointer to the current position of the calling buffer
- * @remarks The content of the view buffer starts at the current position of this buffer.
- * The new buffer's position is zero, the mark is undefined, and the capacity and limit
- * are equal to the remaining part of calling buffer divided by the size of @c long.
- * Any change to the byte buffer content is visible in the @c long buffer view, and vice versa.
+ * @return LongBuffer A pointer to the current position of the calling buffer
+ * @remarks
+ * - The content of the view buffer starts at the current position of the calling buffer.
+ * - The new buffer's position is zero, the mark is undefined, and the capacity and limit
+ * are equal to the remaining part of the calling buffer divided by the size of the @c long value.
+ * - Any change to the byte buffer content is visible in the @c long buffer view, and vice versa.
*/
LongBuffer* AsLongBufferN(void) const;
*
* @since 2.0
*
- * @return LongLongBuffer A pointer to the current position of the calling buffer
- * @remarks The content of the view buffer starts at the current position of this buffer.
- * The new buffer's position is zero, the mark is undefined, and the capacity and limit
- * are equal to the remaining part of calling buffer divided by the size of @c long.
- * Any change to the byte buffer content is visible in the @c long @c long buffer view, and vice versa.
+ * @return LongLongBuffer A pointer to the current position of the calling buffer
+ * @remarks
+ * - The content of the view buffer starts at the current position of the calling buffer.
+ * - The new buffer's position is zero, the mark is undefined, and the capacity and limit
+ * are equal to the remaining part of the calling buffer divided by the size of the @c long @c long value.
+ * - Any change to the byte buffer content is visible in the @c long @c long buffer view, and vice versa.
*/
LongLongBuffer* AsLongLongBufferN(void) const;
* @if OSPDEPREC
* Creates a new @c mchar buffer view of the underlying content of the byte buffer.
*
- * @brief <i> [Deprecated] </i>
- * @deprecated This method is deprecated as @c mchar type is changed to @c wchar_t type.
- * Instead of using this method, use the AsWcharBufferN() method.
+ * @brief <i> [Deprecated] </i>
+ * @deprecated This method is deprecated as @c mchar type is changed to @c wchar_t type.
+ * Instead of using this method, use the AsWcharBufferN() method.
* @since 2.0
*
- * @return McharBuffer A pointer to the current position of the calling buffer
- * @remarks The content of the view buffer starts at the current position of this buffer.
- * The new buffer's position is zero, the mark is undefined, and the capacity and limit
- * are equal to the remaining part of the calling buffer divided by the size of @c long.
- * Any change to the byte buffer content is visible in the @c mchar buffer view, and vice versa.
+ * @return McharBuffer A pointer to the current position of the calling buffer
+ * @remarks
+ * - The content of the view buffer starts at the current position of the calling buffer.
+ * - The new buffer's position is zero, the mark is undefined, and the capacity and limit
+ * are equal to the remaining part of the calling buffer divided by the size of the @c mchar value.
+ * - Any change to the byte buffer content is visible in the @c mchar buffer view, and vice versa.
* @endif
*/
McharBuffer* AsMcharBufferN(void) const;
/**
- * Creates a new wchar Buffer view of the underlying content of the byte buffer.
+ * Creates a new @c wchar buffer view of the underlying content of the byte buffer.
*
* @since 2.0
*
- * @return WcharBuffer pointer to the current position of the calling buffer
- * @remarks The content of the view buffer start at the current position of this buffer. @n
- * The new buffer's position is zero, the mark is undefined, and the capacity and limit
- * are equal to the remaining part of the calling buffer divided by the size of @c long. @n
- * Any changes to the calling buffer's content (that is, the content of %ByteBuffer instance) @n
- * are visible in the WcharBuffer view, and vice versa.
+ * @return WcharBuffer A pointer to the current position of the calling buffer
+ * @remarks
+ * - The content of the view buffer start at the current position of the calling buffer.
+ * - The new buffer's position is zero, the mark is undefined, and the capacity and limit
+ * are equal to the remaining part of the calling buffer divided by the size of the @c wchar value.
+ * - Any change to the byte buffer content is visible in the @c wchar buffer view, and vice versa.
*/
WcharBuffer* AsWcharBufferN(void) const;
*
* @since 2.0
*
- * @return ShortBuffer pointer to the current position of the calling buffer
- * @remarks The content of the view buffer starts at the current position of this buffer.
- * The new buffer's position is zero, the mark is undefined, and the capacity and limit
- * are equal to the remaining part of calling buffer divided by the size of @c long.
- * Any change to the byte buffer content is visible in the @c short buffer view, and vice versa.
+ * @return ShortBuffer A pointer to the current position of the calling buffer
+ * @remarks
+ * - The content of the view buffer starts at the current position of the calling buffer.
+ * - The new buffer's position is zero, the mark is undefined, and the capacity and limit
+ * are equal to the remaining part of the calling buffer divided by the size of the @c short value.
+ * - Any change to the byte buffer content is visible in the @c short buffer view, and vice versa.
*/
ShortBuffer* AsShortBufferN(void) const;
/**
* Copies the remaining bytes of the input %ByteBuffer instance into the calling %ByteBuffer object. @n
- * It returns E_OVERFLOW if the remaining bytes in the current instance are less
+ * It returns @c E_OVERFLOW if the remaining bytes in the current instance are less
* than the remaining bytes in the input instance.
*
* @since 2.0
*
* @return An error code
- * @param[in] buffer The source buffer from which bytes are read @n
- * It must not be the calling object.
+ * @param[in] buffer The source buffer from which bytes are read @n
+ * It must not be the calling object.
* @exception E_SUCCESS The method is successful.
- * @exception E_INVALID_ARG A specified input parameter is invalid. @n
- * The source buffer is same as destination buffer,
- * that is, the current instance of the buffer.
- * @exception E_OVERFLOW The operation (arithmetic/casting/conversion) has caused an overflow. @n
- * The number of remaining bytes of the current buffer is smaller than
- * the number of remaining bytes of the input buffer.
- * @remarks After the copy operation, the current (destination) buffer's position and the given
+ * @exception E_INVALID_ARG Either of the following conditions has occurred:
+ * - A specified input parameter is invalid.
+ * - The source buffer is same as the destination buffer,
+ * that is, the current instance of the buffer.
+ * @exception E_OVERFLOW Either of the following conditions has occurred:
+ * - The operation (arithmetic/casting/conversion) has caused an overflow.
+ * - The number of remaining bytes in the current buffer is smaller than
+ * the number of remaining bytes in the input buffer.
+ * @remarks
+ * - After the copy operation, the current (destination) buffer's position and the given
* (source) buffer's positions are incremented by the number of bytes copied (the number of
- * remaining bytes of the given buffer). @n
- * If the remaining part of the current instance is greater than or equal to the remaining part of the input instance,
- * the effect of this method and the ReadFrom(%ByteBuffer) method is the same. But when the remaining part of the
- * current instance is less, the ReadFrom() method copies the number of remaining elements of the current
- * instance while this method returns E_OVERFLOW and does not copy.
- * @see ReadFrom()
+ * remaining bytes in the given buffer).
+ * - If the remaining part of the current instance is greater than or equal to the remaining part of the input instance,
+ * the effect of this method and the ReadFrom() method is the same. @n
+ * If the remaining part of the current instance is less, the %ReadFrom() method
+ * copies the number of remaining elements of the current instance while this method returns @c E_OVERFLOW and does not copy.
*
* The following example demonstrates how to use the %CopyFrom() method.
*
* @since 2.0
*
* @return An error code
- * @param[out] pArray A pointer to the destination array into which the bytes are written
- * @param[in] index The starting index in the array of the first byte to write
- * @param[in] length The number of bytes to write to the given array
+ * @param[out] pArray A pointer to the destination array into which the bytes are written
+ * @param[in] index The starting index of the array where the first byte is written
+ * @param[in] length The number of bytes to write into the given array
* @exception E_SUCCESS The method is successful.
- * @exception E_INVALID_ARG A specified input parameter is invalid, or
- * the @c pArray is @c null.
- * @exception E_OUT_OF_RANGE A specified input parameter is invalid. @n
- * The @c index or @c length is less than @c 0.
- * @exception E_UNDERFLOW The operation (arithmetic/casting/conversion) has caused an underflow, or
- * the remaining bytes of this buffer are smaller than @c length.
- * @remarks This method copies @c length bytes from the current instance of %ByteBuffer to the given array,
- * starting at the current position and at the given index in the array.
+ * @exception E_INVALID_ARG Either of the following conditions has occurred:
+ * - A specified input parameter is invalid.
+ * - The specified @c pArray is @c null.
+ * @exception E_OUT_OF_RANGE Either of the following conditions has occurred:
+ * - A specified input parameter is invalid.
+ * - The specified @c index or the specified @c length is less than @c 0.
+ * @exception E_UNDERFLOW Either of the following conditions has occurred:
+ * - The operation (arithmetic/casting/conversion) has caused an underflow.
+ * - The remaining bytes of this buffer are smaller than the specified @c length.
+ * @remarks This method copies @c length bytes from the current instance of %ByteBuffer into the given array,
+ * starting from the current position and the given index in the array. @n
* After the copy operation, the position is incremented by @c length bytes.
* @see SetArray()
*/
/**
* Gets the @c byte value from the buffer at the current position, and then increments the position. @n
- * Provides a way for relative indexing and reading.
+ * It provides a way to perform relative indexing and reading.
*
* @since 2.0
*
* @return An error code
* @param[out] value The @c byte value at the current position in the %ByteBuffer instance
* @exception E_SUCCESS The method is successful.
- * @exception E_UNDERFLOW The operation (arithmetic/casting/conversion) has caused an underflow, or
- * the current position is not smaller than the limit.
+ * @exception E_UNDERFLOW Either of the following conditions has occurred:
+ * - The operation (arithmetic/casting/conversion) has caused an underflow.
+ * - The current position is not smaller than the limit.
* @see SetByte()
*/
result GetByte(byte& value);
/**
* Gets the @c byte value at the given index. @n
- * Provides a way for absolute indexing and reading.
+ * It provides a way to perform absolute indexing and reading.
*
* @since 2.0
*
* @return An error code
- * @param[in] index The index of the current %ByteBuffer instance, from which the byte is read
- * @param[out] value The @c byte value at the given @c index
+ * @param[in] index The index of the current %ByteBuffer instance, from which the byte is read
+ * @param[out] value The @c byte value at the given @c index
* @exception E_SUCCESS The method is successful.
- * @exception E_OUT_OF_RANGE The specified index is outside the bounds of the data structure, or
- * the @c index is not smaller than the limit or less than @c 0.
+ * @exception E_OUT_OF_RANGE Either of the following conditions has occurred:
+ * - The specified @c index is outside the bounds of the data structure.
+ * - The specified @c index is not smaller than the limit.
+ * - The specified @c index is less than @c 0.
* @see SetByte()
*/
result GetByte(int index, byte& value) const;
/**
- * Gets the size of @c double number of bytes from the buffer at the current position, converts
+ * Gets the size of the @c double number of bytes from the buffer at the current position, converts
* it to the corresponding @c double equivalent, and then increments the position. @n
- * Provides a way for relative indexing and reading.
+ * It provides a way to perform relative indexing and reading.
*
* @since 2.0
*
* @return An error code
* @param[out] value The @c double value at the current position in the %ByteBuffer instance
* @exception E_SUCCESS The method is successful.
- * @exception E_UNDERFLOW The operation (arithmetic/casting/conversion) has caused an underflow, or
- * the remaining bytes of this buffer are smaller than the size of @c double.
- * @remarks This method reads the next size of @c double number of bytes at the current position,
- * composing it into a @c double value, and then increments the position by the size of @c double.
+ * @exception E_UNDERFLOW Either of the following conditions has occurred:
+ * - The operation (arithmetic/casting/conversion) has caused an underflow.
+ * - The remaining bytes in this buffer are smaller than the size of the @c double value.
+ * @remarks This method reads the next size of the @c double number of bytes at the current position,
+ * converts it into a @c double value, and then increments the position by the size of the @c double value.
* @see SetDouble()
*/
result GetDouble(double& value);
/**
- * Gets the size of @c double number of bytes at the given index and converts it to the equivalent @c double value. @n
- * Provides a way for absolute indexing and reading.
+ * Gets the size of the @c double number of bytes at the given index and converts it to the equivalent @c double value. @n
+ * It provides a way to perform absolute indexing and reading.
*
* @since 2.0
*
* @return An error code
- * @param[in] index The index of the current %ByteBuffer instance, from which the bytes are read
- * @param[out] value The @c double value at the given index
+ * @param[in] index The index of the current %ByteBuffer instance, from which the bytes are read
+ * @param[out] value The @c double value at the given @c index
* @exception E_SUCCESS The method is successful.
- * @exception E_OUT_OF_RANGE The specified @c index is outside the bounds of the data structure, or
- * the @c index is larger than the limit minus size of @c double or less than @c 0.
- * @remarks This method reads size of @c double number of bytes at the given index,
- * composing them into a @c double value.
+ * @exception E_OUT_OF_RANGE Either of the following conditions has occurred:
+ * - The specified @c index is outside the bounds of the data structure.
+ * - The specified @c index is larger than the limit minus the size of the @c double value.
+ * - The specified @c index is less than @c 0.
+ * @remarks This method reads the size of the @c double number of bytes at the given @c index
+ * and converts it into a @c double value.
* @see SetDouble()
*/
result GetDouble(int index, double& value) const;
/**
- * Gets the size of @c float number of bytes from the buffer at the current position, converts
+ * Gets the size of the @c float number of bytes from the buffer at the current position, converts
* it to the corresponding @c float equivalent, and then increments the position. @n
- * Provides a way for relative indexing and reading.
+ * It provides a way to perform relative indexing and reading.
*
* @since 2.0
*
* @return An error code
* @param[out] value The @c float value at the current position in the %ByteBuffer instance
* @exception E_SUCCESS The method is successful.
- * @exception E_UNDERFLOW The operation (arithmetic/casting/conversion) has caused an underflow, or
- * the remaining bytes of this buffer are smaller than the size of @c float.
- * @remarks This method reads the next size of @c float number of bytes at the current position,
- * composing it into a @c float value, and then increments the position by the size of @c float.
+ * @exception E_UNDERFLOW Either of the following conditions has occurred:
+ * - The operation (arithmetic/casting/conversion) has caused an underflow.
+ * - The remaining bytes of this buffer are smaller than the size of the @c float value.
+ * @remarks This method reads the next size of the @c float number of bytes at the current position,
+ * converts it into a @c float value, and then increments the position by the size of the @c float value.
* @see SetFloat()
*/
result GetFloat(float& value);
/**
- * Gets the size of @c float number of bytes at the given index and converts it to equivalent @c float value. @n
- * Provides a way for absolute indexing and reading.
+ * Gets the size of the @c float number of bytes at the given index and converts it to an equivalent @c float value. @n
+ * It provides a way to perform absolute indexing and reading.
*
* @since 2.0
*
* @return An error code
- * @param[in] index The index of the current %ByteBuffer instance, from which the bytes are read
- * @param[out] value The @c float value at the given index
+ * @param[in] index The index of the current %ByteBuffer instance, from which the bytes are read
+ * @param[out] value The @c float value at the given @c index
* @exception E_SUCCESS The method is successful.
- * @exception E_OUT_OF_RANGE The specified index is outside the bounds of the data structure, or
- * the @c index is larger than the limit minus size of @c float or less than @c 0.
- * @remarks This method reads the size of @c float number of bytes at the given index,
- * composing it into a @c float value.
+ * @exception E_OUT_OF_RANGE Either of the following conditions has occurred:
+ * - The specified @c index is outside the bounds of the data structure.
+ * - The specified @c index is larger than the limit minus the size of the @c float value.
+ * - The specified @c index is less than @c 0.
+ * @remarks This method reads the size of the @c float number of bytes at the given @c index
+ * and converts it into a @c float value.
* @see SetFloat()
*/
result GetFloat(int index, float& value) const;
/**
- * Gets the size of @c int number of bytes from the buffer at the current position, converts
+ * Gets the size of the @c int number of bytes from the buffer at the current position, converts
* it to the corresponding @c int equivalent, and then increments the position. @n
- * Provides a way for relative indexing and reading.
+ * It provides a way to perform relative indexing and reading.
*
* @since 2.0
*
* @return An error code
* @param[out] value The @c int value at the current position in the %ByteBuffer instance
* @exception E_SUCCESS The method is successful.
- * @exception E_UNDERFLOW The operation (arithmetic/casting/conversion) has caused an underflow, or
- * the remaining bytes of this buffer are smaller than the size of @c int.
- * @remarks This method reads the next size of @c int number of bytes at the current position,
- * composing them into an @c int value, and then increments the position by the size of @c int.
+ * @exception E_UNDERFLOW Either of the following conditions has occurred:
+ * - The operation (arithmetic/casting/conversion) has caused an underflow.
+ * - The remaining bytes of this buffer are smaller than the size of the @c int value.
+ * @remarks This method reads the next size of the @c int number of bytes at the current position,
+ * converts them into an @c int value, and then increments the position by the size of the @c int value.
* @see SetInt()
*/
result GetInt(int& value);
/**
- * Gets the size of @c int number of bytes at the given index and converts it to the equivalent @c int value. @n
- * Provides a way for absolute indexing and reading.
+ * Gets the size of the @c int number of bytes at the given @c index and converts it to the equivalent @c int value. @n
+ * It provides a way to perform absolute indexing and reading.
*
* @since 2.0
*
* @return An error code
- * @param[in] index The index of the current %ByteBuffer instance, from which the bytes are read
- * @param[out] value The @c int value at the given index
+ * @param[in] index The index of the current %ByteBuffer instance, from which the bytes are read
+ * @param[out] value The @c int value at the given @c index
* @exception E_SUCCESS The method is successful.
- * @exception E_OUT_OF_RANGE The specified index is outside the bounds of the data structure, or
- * the @c index is larger than the limit minus size of @c int or negative.
- * @remarks This method reads the size of @c int number of bytes at the given index,
- * composing it into an @c int value.
+ * @exception E_OUT_OF_RANGE Either of the following conditions has occurred:
+ * - The specified @c index is outside the bounds of the data structure.
+ * - The specified @c index is larger than the limit minus the size of the @c int.
+ * - The specified @c index is negative.
+ * @remarks This method reads the size of the @c int number of bytes at the given @c index
+ * and converts it into an @c int value.
* @see SetInt()
*/
result GetInt(int index, int& value) const;
/**
- * Gets the size of @c long number of bytes from the buffer at the current position, converts
+ * Gets the size of the @c long number of bytes from the buffer at the current position, converts
* it to the corresponding @c long equivalent, and then increments the position. @n
- * Provides a way for relative indexing and reading.
+ * It provides a way to perform relative indexing and reading.
*
* @since 2.0
*
* @return An error code
* @param[out] value The @c long value at the current position in the %ByteBuffer instance
* @exception E_SUCCESS The method is successful.
- * @exception E_UNDERFLOW The operation (arithmetic/casting/conversion) has caused an underflow, or
- * the remaining bytes of this buffer are smaller than the size of @c long.
- * @remarks This method reads the next size of @c long number of bytes at the current position,
- * composing it into a @c long value, and then increments the position by the size of @c long.
+ * @exception E_UNDERFLOW Either of the following conditions has occurred:
+ * - The operation (arithmetic/casting/conversion) has caused an underflow.
+ * - The remaining bytes of this buffer are smaller than the size of the @c long value.
+ * @remarks This method reads the next size of the @c long number of bytes at the current position,
+ * converts it into a @c long value, and then increments the position by the size of the @c long value.
* @see SetLong()
*/
result GetLong(long& value);
/**
- * Gets the size of @c long number of bytes at the given index and converts it to equivalent @c long value. @n
- * Provides a way for absolute indexing and reading.
+ * Gets the size of the @c long number of bytes at the given @c index and converts it to the equivalent @c long value. @n
+ * It provides a way to perform absolute indexing and reading.
*
* @since 2.0
*
* @return An error code
- * @param[in] index The index of the current %ByteBuffer instance, from which the bytes are read
- * @param[out] value The @c long value at the given index
+ * @param[in] index The index of the current %ByteBuffer instance, from which the bytes are read
+ * @param[out] value The @c long value at the given @c index
* @exception E_SUCCESS The method is successful.
- * @exception E_OUT_OF_RANGE The specified @c index is outside the bounds of the data structure, or
- * the @c index is larger than the limit minus size of @c long or less than @c 0.
- * @remarks This method reads the size of @c long number of bytes at the given index,
- * composing it into a @c long value.
+ * @exception E_OUT_OF_RANGE Either of the following conditions has occurred:
+ * - The specified @c index is outside the bounds of the data structure.
+ * - The specified @c index is larger than the limit minus the size of the @c long value.
+ * - The specified @c index is less than @c 0.
+ * @remarks This method reads the size of the @c long number of bytes at the given @c index
+ * and converts it into a @c long value.
* @see SetLong()
*/
result GetLong(int index, long& value) const;
/**
- * Gets the size of @c long @c long number of bytes from the buffer at the current position, converts
+ * Gets the size of the @c long @c long number of bytes from the buffer at the current position, converts
* it to the corresponding @c long @c long equivalent, and then increments the position. @n
- * Provides a way for relative indexing and reading.
+ * It provides a way to perform relative indexing and reading.
*
* @since 2.0
*
* @return An error code
* @param[out] value The @c long @c long value at the current position in the %ByteBuffer instance
* @exception E_SUCCESS The method is successful.
- * @exception E_UNDERFLOW The operation (arithmetic/casting/conversion) has caused an underflow, or
- * the remaining bytes of this buffer are smaller than the size of @c long @c long.
- * @remarks This method reads the next size of @c long @c long number of bytes at the current position,
- * composing it into a @c long @c long value, and then increments the position by the size of @c long @c long.
+ * @exception E_UNDERFLOW Either of the following conditions has occurred:
+ * - The operation (arithmetic/casting/conversion) has caused an underflow.
+ * - The remaining bytes of this buffer are smaller than the size of the @c long @c long value.
+ * @remarks This method reads the next size of the @c long @c long number of bytes at the current position,
+ * converts it into a @c long @c long value, and then increments the position by the size of the @c long @c long value.
* @see SetLongLong()
*/
result GetLongLong(long long& value);
/**
- * Gets the size of @c long @c long number of bytes at the given index and converts it to the equivalent @c long @c long value. @n
- * Provides a way for absolute indexing and reading.
+ * Gets the size of the @c long @c long number of bytes at the given @c index and converts it to the equivalent @c long @c long value. @n
+ * It provides a way to perform absolute indexing and reading.
*
* @since 2.0
*
* @return An error code
- * @param[in] index The index of the current %ByteBuffer instance, from which the bytes are read
- * @param[out] value The @c long @c long value at the given index
+ * @param[in] index The index of the current %ByteBuffer instance, from which the bytes are read
+ * @param[out] value The @c long @c long value at the given @c index
* @exception E_SUCCESS The method is successful.
- * @exception E_OUT_OF_RANGE The specified index is outside the bounds of the data structure, or
- * the @c index is larger than the limit minus size of @c long @c long or less than @c 0.
- * @remarks This method reads the size of @c long @c long number of bytes at the given index,
- * composing it into a @c long @c long value.
+ * @exception E_OUT_OF_RANGE Either of the following conditions has occurred:
+ * - The specified @c index is outside the bounds of the data structure.
+ * - The specified @c index is larger than the limit minus the size of the @c long @c long value.
+ * - The specified @c index is less than @c 0.
+ * @remarks This method reads the size of the @c long @c long number of bytes at the given @c index
+ * and converts it into a @c long @c long value.
* @see SetLongLong()
*/
result GetLongLong(int index, long long& value) const;
/**
* @if OSPDEPREC
- * Gets the size of @c wchar_t number of bytes from the buffer at the current position, converts
+ * Gets the size of the @c wchar_t number of bytes from the buffer at the current position, converts
* it to the corresponding @c wchar_t equivalent, and then increments the position. @n
- * Provides a way for relative indexing and reading.
+ * It provides a way to perform relative indexing and reading.
*
- * @brief <i> [Deprecated] </i>
- * @deprecated This method is deprecated as @c mchar type is changed to @c wchar_t type.
- * Instead of using this method, use the GetWchar(wchar_t& value) method.
+ * @brief <i> [Deprecated] </i>
+ * @deprecated This method is deprecated as @c mchar type is changed to @c wchar_t type.
+ * Instead of using this method, use the GetWchar(wchar_t& value) method.
* @since 2.0
*
* @return An error code
* @param[out] value The @c wchar_t value at the current position in the %ByteBuffer instance
* @exception E_SUCCESS The method is successful.
- * @exception E_UNDERFLOW The operation (arithmetic/casting/conversion) has caused an underflow, or
- * the remaining bytes of this buffer are smaller than the size of @c wchar_t.
- * @remarks This method reads the next size of @c wchar_t number of bytes at the current position,
- * composing it into a @c wchar_t value, and then increments the position by the size of @c wchar_t.
+ * @exception E_UNDERFLOW Either of the following conditions has occurred:
+ * - The operation (arithmetic/casting/conversion) has caused an underflow.
+ * - The remaining bytes of this buffer are smaller than the size of the @c wchar_t value.
+ * @remarks This method reads the next size of the @c wchar_t number of bytes at the current position,
+ * converts it into a @c wchar_t value, and then increments the position by the size of the @c wchar_t value.
* @see SetMchar()
* @endif
*/
result GetMchar(wchar_t& value);
/**
- * Gets the size of @c wchar_t number of bytes from the buffer at the current position, converts
+ * Gets the size of the @c wchar_t number of bytes from the buffer at the current position, converts
* it to the corresponding @c wchar_t equivalent, and then increments the position. @n
- * Provides a way for relative indexing and reading.
+ * It provides a way to perform relative indexing and reading.
*
* @since 2.0
*
* @return An error code
* @param[out] value The @c wchar_t value at the current position in the %ByteBuffer instance
* @exception E_SUCCESS The method is successful.
- * @exception E_UNDERFLOW The operation (arithmetic/casting/conversion) has caused an underflow, or
- * the remaining bytes of this buffer are smaller than the size of @c wchar_t.
- * @remarks This method reads the next size of @c wchar_t number of bytes at the current position,
- * composing it into a @c wchar_t value, and then increments the position by the size of @c wchar_t.
+ * @exception E_UNDERFLOW Either of the following conditions has occurred:
+ * - The operation (arithmetic/casting/conversion) has caused an underflow.
+ * - The remaining bytes of this buffer are smaller than the size of the @c wchar_t value.
+ * @remarks This method reads the next size of the @c wchar_t number of bytes at the current position,
+ * converts it into a @c wchar_t value, and then increments the position by the size of the @c wchar_t value.
* @see SetWchar()
*/
result GetWchar(wchar_t& value);
/**
* @if OSPDEPREC
- * Provides a way for absolute indexing and reading. @n
- * It reads the size of @c wchar_t number of bytes at the given index and converts it to equivalent @c wchar_t value.
+ * Provides a way to perform absolute indexing and reading. @n
+ * It reads the size of the @c wchar_t number of bytes at the given @c index and converts it to the equivalent @c wchar_t value.
*
- * @brief <i> [Deprecated] </i>
+ * @brief <i> [Deprecated] </i>
* @deprecated This method is deprecated as @c mchar type is changed to @c wchar_t type.
- * Instead of using this method, use the GetWchar(int index, wchar_t& value) method.
+ * Instead of using this method, use the GetWchar(int index, wchar_t& value) method.
* @since 2.0
*
* @return An error code
- * @param[in] index The index of the current %ByteBuffer instance, from which the bytes are read
- * @param[out] value The @c wchar_t value at the given index
+ * @param[in] index The index of the current %ByteBuffer instance, from which the bytes are read
+ * @param[out] value The @c wchar_t value at the given @c index
* @exception E_SUCCESS The method is successful.
- * @exception E_OUT_OF_RANGE The specified index is outside the bounds of the data structure, or
- * the @c index is larger than the limit minus size of @c wchar_t or less than @c 0.
- * @remarks This method reads the size of @c wchar_t number of bytes at the given index,
- * composing it into a @c wchar_t value.
+ * @exception E_OUT_OF_RANGE Either of the following conditions has occurred:
+ * - The specified @c index is outside the bounds of the data structure.
+ * - The specified @c index is larger than the limit minus the size of the @c wchar_t value.
+ * - The specified @c index is less than @c 0.
+ * @remarks This method reads the size of the @c wchar_t number of bytes at the given @c index
+ * and converts it into a @c wchar_t value.
* @see SetMchar()
* @endif
*/
result GetMchar(int index, wchar_t& value) const;
/**
- * Provides a way for absolute indexing and reading. @n
- * It reads the size of @c wchar_t number of bytes at the given index and converts it to equivalent @c wchar_t value.
+ * Provides a way to perform absolute indexing and reading. @n
+ * It reads the size of the @c wchar_t number of bytes at the given @c index and converts it to the equivalent @c wchar_t value.
*
* @since 2.0
*
* @return An error code
* @param[in] index The index of the current %ByteBuffer instance, from which the bytes are read
- * @param[out] value The @c wchar_t value at the given index
+ * @param[out] value The @c wchar_t value at the given @c index
* @exception E_SUCCESS The method is successful.
- * @exception E_OUT_OF_RANGE The specified index is outside the bounds of the data structure, or
- * the @c index is larger than the limit minus size of @c wchar_t or less than @c 0.
- * @remarks This method reads the size of @c wchar_t number of bytes at the given index,
- * composing it into a @c wchar_t value.
+ * @exception E_OUT_OF_RANGE Either of the following conditions has occurred:
+ * - The specified @c index is outside the bounds of the data structure.
+ * - The specified @c index is larger than the limit minus the size of the @c wchar_t value.
+ * - The specified @c index is less than @c 0.
+ * @remarks This method reads the size of the @c wchar_t number of bytes at the given @c index
+ * and converts it into a @c wchar_t value.
* @see SetWchar()
*/
result GetWchar(int index, wchar_t& value) const;
/**
- * Gets the size of @c short number of bytes from the buffer at the current position, converts
+ * Gets the size of the @c short number of bytes from the buffer at the current position, converts
* it to the corresponding @c short equivalent, and then increments the position. @n
- * Provides a way for relative indexing and reading.
+ * Provides a way to perform relative indexing and reading.
*
* @since 2.0
*
* @return An error code
* @param[out] value The @c short value at the current position in the %ByteBuffer instance
* @exception E_SUCCESS The method is successful.
- * @exception E_UNDERFLOW The operation (arithmetic/casting/conversion) has caused an underflow, or
- * the remaining bytes of this buffer are smaller than the size of @c short.
- * @remarks This method reads the next size of @c short number of bytes at the current position,
- * composing it into a @c short value, and then increments the position by the size of @c short.
+ * @exception E_UNDERFLOW Either of the following conditions has occurred:
+ * - The operation (arithmetic/casting/conversion) has caused an underflow.
+ * - The remaining bytes of this buffer are smaller than the size of the @c short value.
+ * @remarks This method reads the next size of the @c short number of bytes at the current position,
+ * converts it into a @c short value, and then increments the position by the size of the @c short value.
* @see SetShort()
*/
result GetShort(short& value);
/**
- * Gets the size of @c short number of bytes at the given index and converts it to the equivalent @c short value. @n
- * Provides a way for absolute indexing and reading.
+ * Gets the size of the @c short number of bytes at the given @c index and converts it to the equivalent @c short value. @n
+ * Provides a way to perform absolute indexing and reading.
*
* @since 2.0
*
* @return An error code
- * @param[in] index The index of the current %ByteBuffer instance, from which the bytes are read
- * @param[out] value The @c short value at the given index
+ * @param[in] index The index of the current %ByteBuffer instance, from which the bytes are read
+ * @param[out] value The @c short value at the given @c index
* @exception E_SUCCESS The method is successful.
- * @exception E_OUT_OF_RANGE The specified index is outside the bounds of the data structure, or
- * the @c index is larger than the limit minus size of @c short or less than @c 0.
- * @remarks This method reads the size of @c short number of bytes at the given index,
- * composing it into a @c short value.
+ * @exception E_OUT_OF_RANGE Either of the following conditions has occurred:
+ * - The specified @c index is outside the bounds of the data structure.
+ * - The specified @c index is larger than the limit minus the size of the @c short value.
+ * - The specified @c index is less than @c 0.
+ * @remarks This method reads the size of the @c short number of bytes at the given @c index
+ * and converts it into a @c short value.
* @see SetShort()
*/
result GetShort(int index, short& value) const;
/**
- * Copies the remaining bytes of the input %ByteBuffer instance into the calling %ByteBuffer instance
+ * Copies the remaining bytes of the input %ByteBuffer instance into the calling %ByteBuffer instance,
* if the remaining part of the current instance is greater than or equal to the remaining part of the input instance. @n
* Otherwise, the number of bytes copied is equal to the number of remaining elements of the current instance.
*
* @since 2.0
*
* @return An error code
- * @param[in] buffer The source buffer from which bytes are read @n
- * It must not be the calling %ByteBuffer instance.
+ * @param[in] buffer The source buffer from which bytes are read @n
+ * It must not be the calling %ByteBuffer instance.
* @exception E_SUCCESS The method is successful.
* @exception E_INVALID_ARG The specified input parameter is invalid.
*
- * @remarks After the copy operation, the current (destination) buffer's position and the given
- * (source) buffer's position are incremented by the number of elements copied (the lesser of
- * the number of elements remaining in the current buffer and the given buffer). @n
- * If the remaining part of the current instance is greater than or equal to the remaining part of the input instance,
- * the effect of this method is the same as the CopyFrom() method. But when the remaining part of the
- * current instance is less, the CopyFrom() method returns E_OVERFLOW and does not transfer;
+ * @remarks
+ * - After the copy operation, the current (destination) buffer's position and the given
+ * (source) buffer's position are incremented by the number of elements copied (the lesser of
+ * the number of elements remaining in the current buffer and the given buffer).
+ * - If the remaining part of the current instance is greater than or equal to the remaining part of the input instance,
+ * the effect of this method is the same as the CopyFrom() method. @n
+ * If the remaining part of the current instance is less, the %CopyFrom() method returns @c E_OVERFLOW and does not transfer;
* whereas this method copies the number of remaining elements of the current instance.
- * @see CopyFrom()
*
* The following example demonstrates how to use the %ReadFrom() method.
*
result ReadFrom(ByteBuffer& buffer);
/**
- * Sets the @c byte values on the specified array to the current instance of %ByteBuffer.
+ * Sets the @c byte values in the specified array to the current instance of %ByteBuffer.
*
* @since 2.0
*
* @return An error code
- * @param[in] pArray The array from which bytes are read
- * @param[in] index The starting index of the array from where the first @c byte value is read
- * @param[in] length The number of bytes to read from the given array
+ * @param[in] pArray The array from which the bytes are read
+ * @param[in] index The starting index of the array from where the first @c byte value is read
+ * @param[in] length The number of bytes to read from the given array
* @exception E_SUCCESS The method is successful.
- * @exception E_INVALID_ARG A specified input parameter is invalid, or
- * the @c pArray is @c null.
- * @exception E_OUT_OF_RANGE The specified index is outside the bounds of the data structure, or
- * the @c index or length is less than @c 0.
- * @exception E_OVERFLOW The operation (arithmetic/casting/conversion) has caused an overflow, or
- * the remaining bytes are smaller than @c length.
- * @remarks This method copies the specified number (@c length) of @c byte values into
- * the calling object of buffer from the source array,
- * starting from the current position, and at the given index in the array.
+ * @exception E_INVALID_ARG Either of the following conditions has occurred:
+ * - A specified input parameter is invalid.
+ * - The specified @c pArray is @c null.
+ * @exception E_OUT_OF_RANGE Either of the following conditions has occurred:
+ * - The specified @c index is outside the bounds of the data structure.
+ * - The specified @c index or the specified @c length is less than @c 0.
+ * @exception E_OVERFLOW Either of the following conditions has occurred:
+ * - The operation (arithmetic/casting/conversion) has caused an overflow.
+ * - The remaining bytes are smaller than the specified @c length.
+ * @remarks This method copies the specified number (@c length) of @c byte values from the source array
+ * into the calling object of the buffer, starting from the current position,
+ * and at the given index in the array. @n
* After the copy operation, the position is incremented by @c length.
* @see GetArray()
*/
/**
* Sets the given @c byte value into the calling %ByteBuffer object
* at the current position, and then increments the position. @n
- * Provides a way for relative indexing and writing.
+ * It provides a way to perform relative indexing and writing.
*
* @since 2.0
*
* @return An error code
* @param[in] value The @c byte value to write to the current instance of %ByteBuffer
* @exception E_SUCCESS The method is successful.
- * @exception E_OVERFLOW The operation (arithmetic/casting/conversion) has caused an overflow, or
- * the current position is not smaller than the limit.
+ * @exception E_OVERFLOW Either of the following conditions has occurred:
+ * - The operation (arithmetic/casting/conversion) has caused an overflow.
+ * - The current position is not smaller than the limit.
* @see GetByte()
*/
result SetByte(byte value);
/**
- * Sets the given @c byte value into the calling %ByteBuffer object at the specified index. @n
- * Provides a way for absolute indexing and writing.
+ * Sets the given @c byte value into the calling %ByteBuffer object at the specified @c index. @n
+ * Provides a way to perform absolute indexing and writing.
*
* @since 2.0
*
* @return An error code
- * @param[in] index The index of the current instance of %ByteBuffer at which the byte is written
- * @param[in] value The @c byte value to write
+ * @param[in] index The index of the current instance of %ByteBuffer at which the byte is written
+ * @param[in] value The @c byte value to write
* @exception E_SUCCESS The method is successful.
- * @exception E_OUT_OF_RANGE The specified index is outside the bounds of the data structure, or
- * the @c index is not smaller than the limit or less than @c 0.
+ * @exception E_OUT_OF_RANGE Either of the following conditions has occurred:
+ * - The specified @c index is outside the bounds of the data structure.
+ * - The specified @c index is not smaller than the limit.
+ * - The specified @c index is less than @c 0.
* @see GetByte()
*/
result SetByte(int index, byte value);
/**
* Sets the given @c double value into the calling %ByteBuffer object
* at the current position, and then increments the position. @n
- * Provides a way for relative indexing and writing.
+ * It provides a way to perform relative indexing and writing.
*
* @since 2.0
*
* @return An error code
* @param[in] value The @c double value to write
* @exception E_SUCCESS The method is successful.
- * @exception E_OVERFLOW The operation (arithmetic/casting/conversion) has caused an overflow, or
- * the remaining bytes of this buffer are smaller than the size of @c double.
- * @remarks This method writes the size of @c double number of bytes containing the given @c double value
- * into the calling buffer, at the current position, and then increments the position by the size of @c double.
+ * @exception E_OVERFLOW Either of the following conditions has occurred:
+ * - The operation (arithmetic/casting/conversion) has caused an overflow.
+ * - The remaining bytes of this buffer are smaller than the size of the @c double value.
+ * @remarks This method writes the size of the @c double number of bytes containing the given @c double value
+ * into the calling buffer, at the current position, and then increments the position by the size of the @c double value.
* @see GetDouble()
*/
result SetDouble(double value);
/**
* Sets the given @c float value into the calling %ByteBuffer object
* at the current position, and then increments the position. @n
- * Provides a way for relative indexing and writing.
+ * It provides a way to perform relative indexing and writing.
*
* @since 2.0
*
* @return An error code
* @param[in] value The @c float value to write
* @exception E_SUCCESS The method is successful.
- * @exception E_OVERFLOW The operation (arithmetic/casting/conversion) has caused an overflow, or
- * the remaining bytes of this buffer are smaller than the size of @c float.
- * @remarks This method writes the size of @c float number of bytes containing the given @c float value
- * into this buffer at the current position, and then increments the position by the size of @c float.
+ * @exception E_OVERFLOW Either of the following conditions has occurred:
+ * - The operation (arithmetic/casting/conversion) has caused an overflow.
+ * - The remaining bytes of this buffer are smaller than the size of the @c float value.
+ * @remarks This method writes the size of the @c float number of bytes containing the given @c float value
+ * into the calling buffer, at the current position, and then increments the position by the size of the @c float value.
* @see GetFloat()
*/
result SetFloat(float value);
/**
* Sets the given @c int value into the calling %ByteBuffer instance at the current
* position, and then increments the position. @n
- * Provides a way for relative indexing and writing.
+ * It provides a way to perform relative indexing and writing.
*
* @since 2.0
*
* @return An error code
* @param[in] value The @c int value to write
* @exception E_SUCCESS The method is successful.
- * @exception E_OVERFLOW The operation (arithmetic/casting/conversion) has caused an overflow, or
- * the remaining bytes of this buffer are smaller than the size of @c int.
- * @remarks This method writes the size of @c int number of bytes containing the given @c int value
- * into this buffer at the current position, and then increments the position by the size of @c int.
+ * @exception E_OVERFLOW Either of the following conditions has occurred:
+ * - The operation (arithmetic/casting/conversion) has caused an overflow.
+ * - The remaining bytes of this buffer are smaller than the size of the @c int value.
+ * @remarks This method writes the size of the @c int number of bytes containing the given @c int value
+ * into the calling buffer, at the current position, and then increments the position by the size of the @c int value.
* @see GetInt()
*/
result SetInt(int value);
/**
* Sets the given @c long value into the calling %ByteBuffer instance at the current
* position, and then increments the position. @n
- * Provides a way for relative indexing and writing.
+ * It provides a way to perform relative indexing and writing.
*
* @since 2.0
*
* @return An error code
* @param[in] value The @c long value to write
* @exception E_SUCCESS The method is successful.
- * @exception E_OVERFLOW The operation (arithmetic/casting/conversion) has caused an overflow, or
- * the remaining bytes of this buffer are smaller than size of @c long.
- * @remarks This method writes the size of @c long number of bytes containing the given @c long value
- * into this buffer at the current position, and then increments the position by the size of @c long.
+ * @exception E_OVERFLOW Either of the following conditions has occurred:
+ * - The operation (arithmetic/casting/conversion) has caused an overflow.
+ * - The remaining bytes of this buffer are smaller than the size of the @c long value.
+ * @remarks This method writes the size of the @c long number of bytes containing the given @c long value
+ * into the calling buffer, at the current position, and then increments the position by the size of the @c long value.
* @see GetLong()
*/
result SetLong(long value);
/**
- * Sets the given @c long @c long value into the calling %ByteBuffer object at the current
+ * Sets the given @c long @c long value into the calling %ByteBuffer instance at the current
* position, and then increments the position. @n
- * Provides a way for relative indexing and writing.
+ * It provides a way to perform relative indexing and writing.
*
* @since 2.0
*
* @return An error code
* @param[in] value The @c long @c long value to write
* @exception E_SUCCESS The method is successful.
- * @exception E_OVERFLOW The operation (arithmetic/casting/conversion) has caused an overflow, or
- * the remaining bytes of this buffer are smaller than the size of @c long @c long.
- * @remarks This method writes the size of @c long @c long number of bytes containing the given @c long @c long value
- * into this buffer at the current position, and then increments the position by the size of @c long @c long.
+ * @exception E_OVERFLOW Either of the following conditions has occurred:
+ * - The operation (arithmetic/casting/conversion) has caused an overflow.
+ * - The remaining bytes of this buffer are smaller than the size of the @c long @c long value.
+ * @remarks This method writes the size of the @c long @c long number of bytes containing the given @c long @c long value
+ * into the calling buffer, at the current position, and then increments the position by the size of the @c long @c long value.
* @see GetLongLong()
*/
result SetLongLong(long long value);
/**
* @if OSPDEPREC
- * Sets the given @c wchar_t value into the calling %ByteBuffer object at the current
+ * Sets the given @c wchar_t value into the calling %ByteBuffer instance at the current
* position, and then increments the position. @n
- * Provides a way for relative indexing and writing.
+ * It provides a way to perform relative indexing and writing.
*
- * @brief <i> [Deprecated] </i>
- * @deprecated This method is deprecated as @c mchar type is changed to @c wchar_t type.
- * Instead of using this method, use the SetWchar(wchar_t value) method.
+ * @brief <i> [Deprecated] </i>
+ * @deprecated This method is deprecated as @c mchar type is changed to @c wchar_t type.
+ * Instead of using this method, use the SetWchar(wchar_t value) method.
* @since 2.0
*
* @return An error code
* @param[in] value The @c wchar_t value to write
* @exception E_SUCCESS The method is successful.
- * @exception E_OVERFLOW The operation (arithmetic/casting/conversion) has caused an overflow, or
- * the remaining bytes of this buffer are smaller than size of @c wchar_t.
- * @remarks This method writes the size of @c wchar_t number of bytes containing the given @c wchar_t value
- * into this buffer at the current position, and then increments the position by the size of @c wchar_t.
+ * @exception E_OVERFLOW Either of the following conditions has occurred:
+ * - The operation (arithmetic/casting/conversion) has caused an overflow.
+ * - The remaining bytes of this buffer are smaller than the size of the @c wchar_t value.
+ * @remarks This method writes the size of the @c wchar_t number of bytes containing the given @c wchar_t value
+ * into the calling buffer, at the current position, and then increments the position by the size of the @c wchar_t value.
* @see GetMchar()
* @endif
*/
result SetMchar(wchar_t value);
/**
- * Sets the given @c wchar_t value into the calling %ByteBuffer object at the current
+ * Sets the given @c wchar_t value into the calling %ByteBuffer instance at the current
* position, and then increments the position. @n
- * Provides a way for relative indexing and writing.
+ * It provides a way to perform relative indexing and writing.
*
* @since 2.0
*
* @return An error code
* @param[in] value The @c wchar_t value to write
* @exception E_SUCCESS The method is successful.
- * @exception E_OVERFLOW The operation (arithmetic/casting/conversion) has caused an overflow, or
- * the remaining bytes of this buffer are smaller than size of @c wchar_t.
- * @remarks This method writes the size of @c wchar_t number of bytes containing the given @c wchar_t value
- * into this buffer at the current position, and then increments the position by the size of @c wchar_t.
+ * @exception E_OVERFLOW Either of the following conditions has occurred:
+ * - The operation (arithmetic/casting/conversion) has caused an overflow.
+ * - The remaining bytes of this buffer are smaller than the size of the @c wchar_t value.
+ * @remarks This method writes the size of the @c wchar_t number of bytes containing the given @c wchar_t value
+ * into the calling buffer, at the current position, and then increments the position by the size of the @c wchar_t value.
* @see GetWchar()
*/
result SetWchar(wchar_t value);
/**
- * Sets the given @c short value into the current instance of %ByteBuffer at the current
+ * Sets the given @c short value into the current %ByteBuffer instance at the current
* position, and then increments the position. @n
- * Provides a way for relative indexing and writing.
+ * Provides a way to perform relative indexing and writing.
*
* @since 2.0
*
* @return An error code
* @param[in] value The @c short value to write
* @exception E_SUCCESS The method is successful.
- * @exception E_OVERFLOW The operation (arithmetic/casting/conversion) has caused an overflow, or
- * the remaining bytes of this buffer are smaller than the size of @c short.
- * @remarks This method writes the size of @c short number of bytes containing the given @c short value
- * into this buffer at the current position, and then increments the position by the size of @c short.
+ * @exception E_OVERFLOW Either of the following conditions has occurred:
+ * - The operation (arithmetic/casting/conversion) has caused an overflow.
+ * - The remaining bytes of this buffer are smaller than the size of the @c short value.
+ * @remarks This method writes the size of the @c short number of bytes containing the given @c short value
+ * into the calling buffer, at the current position, and then increments the position by the size of the @c short value.
* @see GetShort()
*/
result SetShort(short value);
/**
- * Sets a @c double value at the specified index of the current instance of %ByteBuffer. @n
- * Provides a way for absolute indexing and writing.
+ * Sets a @c double value at the specified @c index of the current %ByteBuffer instance. @n
+ * It provides a way to perform absolute indexing and writing.
*
* @since 2.0
*
* @return An error code
- * @param[in] index The index of current instance of %ByteBuffer at which the bytes are written
- * @param[in] value The @c double value to write
+ * @param[in] index The index of the current instance of %ByteBuffer at which the bytes are written
+ * @param[in] value The @c double value to write
* @exception E_SUCCESS The method is successful.
- * @exception E_OUT_OF_RANGE The specified index is outside the bounds of the data structure, or
- * the @c index is larger than the limit minus the size of @c double or less than @c 0.
- * @remarks This method writes the size of @c double number of bytes containing the given @c double value
- * into this buffer at the given index.
+ * @exception E_OUT_OF_RANGE Either of the following conditions has occurred:
+ * - The specified @c index is outside the bounds of the data structure.
+ * - The specified @c index is larger than the limit minus the size of the @c double value.
+ * - The specified @c index is less than @c 0.
+ * @remarks This method writes the size of the @c double number of bytes containing the given @c double value
+ * into the calling buffer, at the given @c index.
* @see GetDouble()
*/
result SetDouble(int index, double value);
/**
- * Sets a @c float value at the specified index of the calling %ByteBuffer object. @n
- * Provides a way for absolute indexing and writing.
+ * Sets a @c float value at the specified @c index of the calling %ByteBuffer instance. @n
+ * It provides a way to perform absolute indexing and writing.
*
* @since 2.0
*
* @return An error code
- * @param[in] index The index of current instance of %ByteBuffer at which the bytes are written
- * @param[in] value The @c float value to write
+ * @param[in] index The index of the current instance of %ByteBuffer at which the bytes are written
+ * @param[in] value The @c float value to write
* @exception E_SUCCESS The method is successful.
- * @exception E_OUT_OF_RANGE The specified index is outside the bounds of the data structure, or
- * the @c index is larger than the limit minus the size of @c float or less than @c 0.
- * @remarks This method writes the size of @c float number of bytes containing the given @c float value
- * into this buffer at the given index.
+ * @exception E_OUT_OF_RANGE Either of the following conditions has occurred:
+ * - The specified @c index is outside the bounds of the data structure.
+ * - The specified @c index is larger than the limit minus the size of the @c float value.
+ * - The specified @c index is less than @c 0.
+ * @remarks This method writes the size of the @c float number of bytes containing the given @c float value
+ * into the calling buffer, at the given @c index.
* @see GetFloat()
*/
result SetFloat(int index, float value);
/**
- * Sets a @c int value at the specified index of the calling %ByteBuffer object. @n
- * Provides a way for absolute indexing and writing.
+ * Sets a @c int value at the specified @c index of the calling %ByteBuffer instance. @n
+ * It provides a way to perform absolute indexing and writing.
*
* @since 2.0
*
* @return An error code
- * @param[in] index The index of current instance of %ByteBuffer at which the bytes are written
- * @param[in] value The @c int value to write
- * @exception E_SUCCESS The method is successful.
- * @exception E_OUT_OF_RANGE The specified index is outside the bounds of the data structure, or
- * the @c index is larger than the limit minus size of @c int or less than @c 0.
- * @remarks This method writes the size of @c int number of bytes containing the given @c int value
- * into this buffer at the given index.
+ * @param[in] index The index of the current instance of %ByteBuffer at which the bytes are written
+ * @param[in] value The @c int value to write
+ * @exception E_SUCCESS The method is successful.
+ * @exception E_OUT_OF_RANGE Either of the following conditions has occurred:
+ * - The specified @c index is outside the bounds of the data structure.
+ * - The specified @c index is larger than the limit minus the size of the @c int value.
+ * - The specified @c index is less than @c 0
+ * @remarks This method writes the size of the @c int number of bytes containing the given @c int value
+ * into the calling buffer, at the given @c index.
* @see GetInt()
*/
result SetInt(int index, int value);
/**
- * Sets a @c long value at the specified index of the calling %ByteBuffer object. @n
- * Provides a way for absolute indexing and writing.
+ * Sets a @c long value at the specified index of the calling %ByteBuffer instance. @n
+ * It provides a way to perform absolute indexing and writing.
*
* @since 2.0
*
* @return An error code
- * @param[in] index The index at which the bytes are written
- * @param[in] value The @c long value to write
+ * @param[in] index The index at which the bytes are written
+ * @param[in] value The @c long value to write
* @exception E_SUCCESS The method is successful.
- * @exception E_OUT_OF_RANGE The specified index is outside the bounds of the data structure, or
- * the @c index is larger than the limit minus the size of @c long or less than @c 0.
- * @remarks This method writes size of @c long number of bytes containing the given @c long value
- * into this buffer at the given index.
+ * @exception E_OUT_OF_RANGE Either of the following conditions has occurred:
+ * - The specified @c index is outside the bounds of the data structure.
+ * - The specified @c index is larger than the limit minus the size of the @c long value.
+ * - The specified @c index is less than @c 0.
+ * @remarks This method writes the size of the @c long number of bytes containing the given @c long value
+ * into the calling buffer, at the given @c index.
* @see GetLong()
*/
result SetLong(int index, long value);
/**
- * Sets a @c long @c long value at the specified index of the calling %ByteBuffer object. @n
- * Provides a way for absolute indexing and writing.
+ * Sets a @c long @c long value at the specified @c index of the calling %ByteBuffer instance. @n
+ * It provides a way to perform absolute indexing and writing.
*
* @since 2.0
*
* @return An error code
- * @param[in] index The index at which the bytes will be written
- * @param[in] value The @c long @c long value to write
+ * @param[in] index The index at which the bytes are written
+ * @param[in] value The @c long @c long value to write
* @exception E_SUCCESS The method is successful.
- * @exception E_OUT_OF_RANGE The specified index is outside the bounds of the data structure, or
- * the @c index is larger than the limit minus the size of @c long @c long or less than @c 0.
- * @remarks This method writes the size of @c long @c long number of bytes containing the given @c long @c long value
- * into this buffer at the given index.
+ * @exception E_OUT_OF_RANGE Either of the following conditions has occurred:
+ * - The specified @c index is outside the bounds of the data structure.
+ * - The specified @c index is larger than the limit minus the size of the @c long @c long value.
+ * - The specified @c index is less than @c 0.
+ * @remarks This method writes the size of the @c long @c long number of bytes containing the given @c long @c long value
+ * into the calling buffer, at the given @c index.
* @see GetLongLong()
*/
result SetLongLong(int index, long long value);
/**
* @if OSPDEPREC
- * Sets a @c wchar_t value at the specified index of the calling %ByteBuffer object. @n
- * Provides a way for absolute indexing and writing.
+ * Sets a @c wchar_t value at the specified @c index of the calling %ByteBuffer instance. @n
+ * It provides a way to perform absolute indexing and writing.
*
- * @brief <i> [Deprecated] </i>
- * @deprecated This method is deprecated as @c mchar type is changed to @c wchar_t type.
- * Instead of using this method, use the SetWchar(int index, wchar_t value) method.
+ * @brief <i> [Deprecated] </i>
+ * @deprecated This method is deprecated as @c mchar type is changed to @c wchar_t type.
+ * Instead of using this method, use the SetWchar(int index, wchar_t value) method.
* @since 2.0
*
* @return An error code
- * @param[in] index The index at which the bytes will be written
- * @param[in] value The @c wchar_t value to write
+ * @param[in] index The index at which the bytes are written
+ * @param[in] value The @c wchar_t value to write
* @exception E_SUCCESS The method is successful.
- * @exception E_OUT_OF_RANGE The specified index is outside the bounds of the data structure, or
- * the @c index is larger than the limit minus the size of @c wchar_t or less than @c 0.
- * @remarks This method writes the size of @c wchar_t number of bytes containing the given @c wchar_t value
- * into this buffer at the given index.
+ * @exception E_OUT_OF_RANGE Either of the following conditions has occurred:
+ * - The specified index is outside the bounds of the data structure.
+ * - The specified @c index is larger than the limit minus the size of the @c wchar_t value.
+ * - The specified @c index is less than @c 0.
+ * @remarks This method writes the size of the @c wchar_t number of bytes containing the given @c wchar_t value
+ * into the calling buffer, at the given @c index.
* @see GetMchar()
* @endif
*/
result SetMchar(int index, wchar_t value);
/**
- * Sets a @c wchar_t value at the specified index of the calling %ByteBuffer object. @n
- * Provides a way for absolute indexing and writing.
+ * Sets a @c wchar_t value at the specified @c index of the calling %ByteBuffer instance. @n
+ * It provides a way to perform absolute indexing and writing.
*
* @since 2.0
*
* @return An error code
- * @param[in] index The index at which the bytes will be written
+ * @param[in] index The index at which the bytes are written
* @param[in] value The @c wchar_t value to write
* @exception E_SUCCESS The method is successful.
- * @exception E_OUT_OF_RANGE The specified index is outside the bounds of the data structure, or
- * the @c index is larger than the limit minus the size of @c wchar_t or less than @c 0.
- * @remarks This method writes the size of @c wchar_t number of bytes containing the given @c wchar_t value
- * into this buffer at the given index.
+ * @exception E_OUT_OF_RANGE Either of the following conditions has occurred:
+ * - The specified @c index is outside the bounds of the data structure.
+ * - The specified @c index is larger than the limit minus the size of the @c wchar_t value.
+ * - The specified @c index is less than @c 0.
+ * @remarks This method writes the size of the @c wchar_t number of bytes containing the given @c wchar_t value
+ * into the calling buffer, at the given @c index.
* @see GetWchar()
*/
result SetWchar(int index, wchar_t value);
/**
- * Sets a @c short value at the specified index of the calling %ByteBuffer object. @n
- * Provides a way for absolute indexing and writing.
+ * Sets a @c short value at the specified @c index of the calling %ByteBuffer instance. @n
+ * It provides a way to perform absolute indexing and writing.
*
* @since 2.0
*
* @return An error code
- * @param[in] index The index of at which the bytes are written
- * @param[in] value The @c short value to write
+ * @param[in] index The index of at which the bytes are written
+ * @param[in] value The @c short value to write
* @exception E_SUCCESS The method is successful.
- * @exception E_OUT_OF_RANGE The specified index is outside the bounds of the data structure, or
- * the @c index is larger than the limit minus the size of @c short or less than @c 0.
- * @remarks This method writes the size of @c short number of bytes containing the given @c short value
- * into this buffer at the given index.
+ * @exception E_OUT_OF_RANGE Either of the following conditions has occurred:
+ * - The specified @c index is outside the bounds of the data structure.
+ * - The specified @c index is larger than the limit minus the size of the @c short value.
+ * - The specified @c index is less than @c 0.
+ * @remarks This method writes the size of the @c short number of bytes containing the given @c short value
+ * into the calling buffer, at the given @c index.
* @see GetShort()
*/
result SetShort(int index, short value);
/**
* Creates a new %ByteBuffer whose content is a shared portion of
- * the content of the calling %ByteBuffer object.
+ * the content of the calling %ByteBuffer instance.
*
* @since 2.0
*
- * @return %ByteBuffer pointer to the current position of the calling object
- * @remarks The content of the new buffer starts at the current position of the calling %ByteBuffer object.
- * The new buffer's position is zero, its capacity and limit are
- * the number of bytes remaining of the current instance of %ByteBuffer,
+ * @return A %ByteBuffer pointer to the current position of the calling object
+ * @remarks
+ * - The content of the new buffer starts at the current position of the calling %ByteBuffer object.
+ * - The new buffer's position is zero, its capacity and limit are
+ * the number of bytes remaining in the current instance of %ByteBuffer,
* and its mark is undefined.
*/
ByteBuffer* SliceN(void) const;
/**
- * Gets the pointer to the raw array of the calling buffer. @n
+ * Gets a pointer to the raw array of the calling buffer. @n
* If the capacity is zero, it returns @c null.
*
* @since 2.0
const byte* GetPointer(void) const;
/**
- * Gets the pointer to the raw array of the calling buffer. @n
+ * Gets a pointer to the raw array of the calling buffer. @n
* If the capacity is zero, it returns @c null.
*
* @since 2.1
*
- * @return A pointer(non-const) to the raw array of the calling buffer
+ * @return A pointer (non-constant) to the raw array of the calling buffer
*/
byte* GetPointer(void);
*
* @since 2.0
*
- * @return @c true if the input object equals the calling %ByteBuffer instance, @n
+ * @return @c true if the input Object equals the calling %ByteBuffer instance, @n
* else @c false
- * @param[in] obj The object instance to compare with the calling object
- * @remarks This method returns @c true only if the specified object is also an instance of
- * the %ByteBuffer class, the two buffers have the same number of remaining elements, and the two
- * sequences of remaining elements are equal (considered independent of their starting positions).
+ * @param[in] obj The Object instance to compare with the calling object
+ * @remarks This method returns @c true only if the specified object is also an instance of
+ * the %ByteBuffer class, the two buffers have the same number of remaining elements, and the
+ * sequences of the remaining elements are equal (considered independent of their starting positions).
* @see Tizen::Base::BufferBase::GetHashCode()
*/
virtual bool Equals(const Tizen::Base::Object& obj) const;
*
* @since 2.0
*
- * @return The hash value of the current instance
+ * @return The hash value of the current instance
* @remarks The hash code of a buffer depends only upon its remaining elements.
*/
virtual int GetHashCode(void) const;
/**
* @enum UnicodeCategory
*
- * Defines the constants used to distinguish the categories of Unicode characters.
+ * Defines the constants used to distinguish the categories of the Unicode characters.
*
* @since 2.0
*/
enum UnicodeCategory
{
- UNICODE_SURROGATE = 1, /**< The surrogate Unicode category */
- UNICODE_MODIFIER, /**< The spacing modifier Unicode category */
- UNICODE_ARROW, /**< @if OSPDEPREC @deprecated This enum value is deprecated because this category is not valid anymore. @endif*/
- UNICODE_SPACE, /**< The space Unicode category */
- UNICODE_PUNCTUATION, /**< The punctuation Unicode category */
- UNICODE_CONTROL, /**< The control Unicode category */
- UNICODE_MATH, /**< The math Unicode category */
- UNICODE_DIGIT, /**< The digit Unicode category */
- UNICODE_HANGUL, /**< @if OSPDEPREC @deprecated This enum value is deprecated because this category is not valid anymore. @endif*/
- UNICODE_HANJA, /**< @if OSPDEPREC @deprecated This enum value is deprecated because this category is not valid anymore. @endif*/
- UNICODE_COMBINING, /**< @if OSPDEPREC @deprecated This enum value is deprecated because this category is not valid anymore. @endif*/
- UNICODE_LANGUAGE, /**< @if OSPDEPREC @deprecated This enum value is deprecated because this category is not valid anymore. @endif*/
- UNICODE_UPPERCASE, /**< The uppercase Unicode category*/
- UNICODE_LOWERCASE, /**< The lowercase Unicode category*/
- UNICODE_TITLECASE, /**< The titlecase Unicode category*/
- UNICODE_LETTER, /**< The letter Unicode category*/
- UNICODE_MARK, /**< The mark Unicode category*/
- UNICODE_CURRENCY, /**< The currency Unicode category*/
- UNICODE_SEPARATOR, /**< The separator Unicode category*/
- UNICODE_OTHER /**< The other Unicode category */
+ UNICODE_SURROGATE = 1, /**< The surrogate Unicode category */
+ UNICODE_MODIFIER, /**< The spacing modifier Unicode category */
+ UNICODE_ARROW, /**< @if OSPDEPREC @deprecated This enum value is deprecated because this category is not valid anymore. @endif */
+ UNICODE_SPACE, /**< The space Unicode category */
+ UNICODE_PUNCTUATION, /**< The punctuation Unicode category */
+ UNICODE_CONTROL, /**< The control Unicode category */
+ UNICODE_MATH, /**< The math Unicode category */
+ UNICODE_DIGIT, /**< The digit Unicode category */
+ UNICODE_HANGUL, /**< @if OSPDEPREC @deprecated This enum value is deprecated because this category is not valid anymore. @endif */
+ UNICODE_HANJA, /**< @if OSPDEPREC @deprecated This enum value is deprecated because this category is not valid anymore. @endif */
+ UNICODE_COMBINING, /**< @if OSPDEPREC @deprecated This enum value is deprecated because this category is not valid anymore. @endif */
+ UNICODE_LANGUAGE, /**< @if OSPDEPREC @deprecated This enum value is deprecated because this category is not valid anymore. @endif */
+ UNICODE_UPPERCASE, /**< The uppercase Unicode category */
+ UNICODE_LOWERCASE, /**< The lowercase Unicode category */
+ UNICODE_TITLECASE, /**< The titlecase Unicode category */
+ UNICODE_LETTER, /**< The letter Unicode category */
+ UNICODE_MARK, /**< The mark Unicode category */
+ UNICODE_CURRENCY, /**< The currency Unicode category */
+ UNICODE_SEPARATOR, /**< The separator Unicode category */
+ UNICODE_OTHER /**< The other Unicode category */
};
*
* @since 2.0
*
- * The %Character class wraps a value of the @c wchar_t type. It also provides
+ * The %Character class wraps the value of the @c wchar_t type. It also provides
* several methods for determining a Unicode character's category, and for
- * converting the case of intrinsic characters. The class is useful when
+ * converting the case of the intrinsic characters. This class is useful when
* passing a Unicode character to a method expecting an instance of Object.
*
* The following example demonstrates how to use the %Character class.
*
* using namespace Tizen::Base;
*
- * // This method converts the first character of the given @c string to the upper case.
+ * // This method converts the first character of the given string to the upper case.
* void
* MyClass::CharacterSample(String& str)
* {
*
* @since 2.0
*
- * @param[in] value A multi-byte character used to initialize the %Character instance
+ * @param[in] value The multi-byte character used to initialize the %Character instance
*/
Character(wchar_t value);
*
* @since 2.0
*
- * @param[in] value An instance of %Character
+ * @param[in] value An instance of %Character to copy
*/
Character(const Character& value);
*
* @since 2.0
*
- * @param[in] rhs An instance of %Character
+ * @param[in] rhs An instance of %Character to copy
*/
Character& operator =(const Character& rhs);
*
* @since 2.0
*
- * @return A 32-bit @c signed integer value
- * @param[in] value The character instance to compare with
+ * @return The 32-bit @c signed integer value
+ * @param[in] value The %Character instance to compare with
*
* @code
* @li < 0 if the value of the current instance is less than the value of the input instance
int CompareTo(const Character& value) const;
/**
- * Checks whether the value of the Object parameter is equal
- * to the value of the calling object.
+ * Checks whether the value of the input Object is equal
+ * to the value of the calling %Object.
*
* @since 2.0
* @return @c true if the input Object is equal to the calling %Object, @n
* else @c false
- * @param[in] obj The object to compare with the calling object
- * @see Tizen::Base::Object::Equals()
+ * @param[in] obj The object to compare with the calling object
+ * @see Tizen::Base::Object::Equals()
*/
virtual bool Equals(const Object& obj) const;
* @since 2.0
*
* @return The hash value of the current instance
- * @remarks The two Tizen::Base::Object::Equals() instances must return the same hash value. For better performance,
- * the used hash function must generate a random distribution for all inputs.
+ * @remarks The two Tizen::Base::Object::Equals() instances must return the same hash value. @n
+ * For better performance,the used hash function must generate a random distribution for all the inputs.
*/
virtual int GetHashCode(void) const;
/**
- * Returns the value of the current instance as a
- * @c wchar_t.
+ * Returns the value of the current instance as a @c wchar_t value.
*
* @since 2.0
*
- * @return The value of this instance as
- * a @c wchar_t
+ * @return The value of this instance as a @c wchar_t value
*/
wchar_t ToMchar(void) const;
/**
* @if OSPDEPREC
* Converts the Unicode characters of the calling object to its equivalent lowercase. @n
- * The Unicode characters other than English alphabets are not changed.
+ * Unicode characters other than the English alphabets are not changed.
*
- * @brief <i> [Deprecated] </i>
+ * @brief <i> [Deprecated] </i>
* @deprecated This method is deprecated as a new method has been introduced.
- * Instead of using this method, use the ToLowerCase() method that supports Unicode characters other than English alphabets.
+ * Instead of using this method, use the ToLowerCase() method that supports Unicode characters other than the English alphabets.
*
* @since 2.0
* @endif
/**
* Converts the Unicode characters of the calling object to its equivalent lowercase. @n
- * The Unicode characters other than English alphabets are also supported.
+ * Unicode characters other than the English alphabets are also supported.
*
* @since 2.0
*/
/**
* @if OSPDEPREC
* Converts the Unicode characters of the current object to its equivalent uppercase. @n
- * The Unicode characters other than English alphabets are not changed.
+ * Unicode characters other than the English alphabets are not changed.
*
- * @brief <i> [Deprecated] </i>
+ * @brief <i> [Deprecated] </i>
* @deprecated This method is deprecated as a new method has been introduced.
- * Instead of using this method, use the ToUpperCase() method that supports the Unicode characters other than English alphabets.
+ * Instead of using this method, use the ToUpperCase() method that supports Unicode characters other than the English alphabets.
*
* @since 2.0
* @endif
/**
* Converts the Unicode characters of the current object to its equivalent uppercase. @n
- * The Unicode characters other than English alphabets are also supported.
+ * Unicode characters other than English alphabets are also supported.
*
* @since 2.0
*/
/**
- * Returns a string representing the value of the calling %Character instance.
+ * Returns a string that represents the value of the calling %Character instance.
*
* @since 2.0
*
- * @return An instance of String class that
+ * @return An instance of String that
* contains a Unicode representation of the calling instance
*/
String ToString(void) const;
*
* @since 2.0
*
- * @return An instance of the String class
+ * @return An instance of String
* that contains the Unicode representation of the
* input value
* @param[in] value The Unicode character to convert
static String ToString(wchar_t value);
/**
- * Categorizes a Unicode character into a group identified by
+ * Categorizes a Unicode character into a group that is identified by
* one of the UnicodeCategory values.
*
* @since 2.0
*
- * @return A value of type UnicodeCategory that identifies the group that contains the specified @c ch
+ * @return The value of type UnicodeCategory that identifies the group that contains the specified @c ch
* @param[in] ch The Unicode character to categorize
*
*/
/**
* @if OSPDEPREC
* Converts the input Unicode character to its equivalent lowercase. @n
- * The Unicode characters other than English alphabets are not changed.
+ * Unicode characters other than the English alphabets are not changed.
*
- * @brief <i> [Deprecated] </i>
+ * @brief <i> [Deprecated] </i>
* @deprecated This method is deprecated as a new method has been introduced.
- * Instead of using this method, use the ToLowerCase(wchar_t ch) method that supports the Unicode characters other than English alphabets.
+ * Instead of using this method, use the ToLowerCase(wchar_t ch) method that supports Unicode characters other than the English alphabets.
*
* @since 2.0
- * @return An lowercase equivalent of the input Unicode character
+ * @return The lowercase equivalent of the input Unicode character
* @param[in] ch The Unicode character to convert
* @endif
*/
/**
* Converts the input Unicode character to its equivalent lowercase. @n
- * The Unicode characters other than English alphabets are also supported.
+ * Unicode characters other than the English alphabets are also supported.
*
* @since 2.0
*
- * @return An lowercase equivalent of the input Unicode character
+ * @return The lowercase equivalent of the input Unicode character
* @param[in] ch The Unicode character to convert
*/
static wchar_t ToLowerCase(wchar_t ch);
/**
* @if OSPDEPREC
* Converts the input Unicode character to its equivalent uppercase. @n
- * The Unicode characters other than English alphabets are not changed.
+ * Unicode characters other than the English alphabets are not changed.
*
- * @brief <i> [Deprecated] </i>
+ * @brief <i> [Deprecated] </i>
* @deprecated This method is deprecated as a new method has been introduced.
- * Instead of using this method, use the ToUpperCase(wchar_t ch) method that supports Unicode characters other than English alphabets.
+ * Instead of using this method, use the ToUpperCase(wchar_t ch) method that supports Unicode characters other than the English alphabets.
*
* @since 2.0
- * @return An uppercase equivalent of the input Unicode character
+ * @return The uppercase equivalent of the input Unicode character
* @param[in] ch The Unicode character to convert
* @endif
*/
/**
* Converts the input Unicode character to its equivalent uppercase. @n
- * The Unicode characters other than English alphabets are also supported.
+ * Unicode characters other than the English alphabets are also supported.
*
* @since 2.0
*
- * @return An uppercase equivalent of the input Unicode character
+ * @return The uppercase equivalent of the input Unicode character
* @param[in] ch The Unicode character to convert
*/
static wchar_t ToUpperCase(wchar_t ch);
/**
* Checks whether the input character is an alphanumeric character (letter or digit). @n
- * A character is considered to be an alphanumeric character if either Character::isLetter(wchar_t ch) or Character::isDigit(wchar_t ch) returns true for the character
+ * A character is considered to be an alphanumeric character if either Character::isLetter(wchar_t ch) or Character::isDigit(wchar_t ch) returns @c true for the character
* @if OSPCOMPAT
* @brief <i> [Compatibility] </i>
* @endif
* @section CompCharacterIsAlphaNumericPageIssueSection Issues
* Implementing this method in OSP compatible applications has the following issues: @n
*
- * -# The method returns true only if the character is alphabet character and cannot checks other Unicode character in Letter and digit category.
+ * -# The method returns @c true only if the character is an alphabet character, it cannot check other Unicode characters in the letter and digit category.
*
* @section CompCharacterIsAlphaNumericPageSolutionSection Resolutions
*
- * This issue has been resolved in Tizen.
+ * This issue mentioned above is resolved in %Tizen.
* @endif
*/
* @section CompCharacterIsLetterPageIssueSection Issues
* Implementing this method in OSP compatible applications has the following issues: @n
*
- * -# The method returns true only if the character is alphabet character and cannot checks other Unicode character in Letter category.
+ * -# The method returns @c true only if the character is an alphabet character, it cannot check other Unicode characters in the letter category.
*
* @section CompCharacterIsLetterPageSolutionSection Resolutions
*
- * This issue has been resolved in Tizen.
+ * This issue mentioned above is resolved in %Tizen.
* @endif
*/
* @if OSPDEPREC
* Checks whether the input character is a lowercase alphabet.
*
- * @brief <i> [Deprecated] </i>
+ * @brief <i> [Deprecated] </i>
* @deprecated This method is deprecated as a new method has been introduced.
- * Instead of using this method, use the IsLowerCase(wchar_t ch) method that supports Unicode characters.
+ * Instead of using this method, use the IsLowerCase(wchar_t ch) method that supports Unicode characters.
* @since 2.0
*
- * @return @c true if the input character is a lowercase English alphabet, @n
+ * @return @c true if the input character is a lowercase alphabet, @n
* else @c false
* @param[in] ch The Unicode character
* @endif
* @if OSPDEPREC
* Checks whether the input character is an uppercase alphabet.
*
- * @brief <i> [Deprecated] </i>
+ * @brief <i> [Deprecated] </i>
* @deprecated This method is deprecated as a new method has been introduced.
- * Instead of using this method, use the IsUpperCase(wchar_t ch) method that also supports Unicode characters other than English alphabets.
+ * Instead of using this method, use the IsUpperCase(wchar_t ch) method that also supports Unicode characters other than the English alphabets.
* @since 2.0
*
* @return @c true if the input character is an uppercase alphabet, @n
static bool IsUpperCase(wchar_t ch);
/**
- * Returns the value of the input character in the supplied radix. @n
- * The value of radix must be between RADIX_MIN and RADIX_MAX.
+ * Returns the value of the input character in the supplied @c radix. @n
+ * The value of @c radix must be between ::RADIX_MIN and ::RADIX_MAX.
*
* @since 2.0
*
- * @return A integer value of the input character in the supplied radix
- * @param[in] ch The character to determine the value
+ * @return The integer value of the input character in the supplied @c radix
+ * @param[in] ch The character that determines the value
* @param[in] radix The radix
*/
static int ToDigit(wchar_t ch, int radix);
/**
- * Returns the value which represents the input digit with specified radix. @n
- * The value of radix must be between RADIX_MIN and RADIX_MAX.
+ * Returns the value which represents the input digit in the specified @c radix. @n
+ * The value of @c radix must be between ::RADIX_MIN and ::RADIX_MAX.
*
* @since 2.0
*
- * @return A Unicode character of the input digit with specified @c radix @n
- * else @c null character (U+0000)
- * @param[in] digit The digit to determine the value
+ * @return The Unicode character of the input digit in the specified @c radix @n
+ * else a @c null character (U+0000)
+ * @param[in] digit The digit that determines the value
* @param[in] radix The radix
*/
static wchar_t ForDigit(int digit, int radix);
/**
* Gets the numeric value of the input unicode character. @n
- * This is used when some numeric values are fractions, negative, or too large for @c int value.
+ * This is used when some numeric values are fractions, negative, or too large for the @c int value.
*
* @since 2.0
*
- * @return A @c double value @n NO_NUMERIC_VALUE for characters without any numeric values in the Unicode %Character.
- * @param[in] ch A Unicode character
+ * @return The @c double value @n
+ * NO_NUMERIC_VALUE is returned for characters without any numeric values in the Unicode character.
+ * @param[in] ch The Unicode character
*/
static double GetNumericValue(wchar_t ch);
*
* @return @c true if the Unicode character is an assigned character, @n
* else @c false
- * @param[in] ch A Unicode character
+ * @param[in] ch The Unicode character
*/
static bool IsDefined(wchar_t ch);
*
* @return @c true if the Unicode character is a whitespace character, @n
* else @c false
- * @param[in] ch A Unicode character
+ * @param[in] ch The Unicode character
*
* @code
- * It is a Unicode Separator character, but is not also a non-breaking space (U+00A0 NBSP or U+2007 Figure Space or U+202F Narrow NBSP).
+ * It is a Unicode Separator character, but is also not a non-breaking space (U+00A0 NBSP or U+2007 Figure Space or U+202F Narrow NBSP).
* It is U+0009 HORIZONTAL TABULATION.
* It is U+000A LINE FEED.
* It is U+000B VERTICAL TABULATION.
*
* @return @c true if the Unicode character is a title character, @n
* else @c false
- * @param[in] ch A Unicode character
+ * @param[in] ch The Unicode character
*/
static bool IsTitleCase(wchar_t ch);
*
* @since 2.0
*
- * @return A title case character equivalent for the input character @n The character itself is returned if none is defined.
- * @param[in] ch A Unicode character
+ * @return The title case character equivalent for the input character @n
+ * The character itself is returned if no equivalent is defined.
+ * @param[in] ch The Unicode character
*/
static wchar_t ToTitleCase(wchar_t ch);
/**
- * Checks whether the input character is an ISO control code or not.
+ * Checks whether the input character is an ISO control code.
*
* @since 2.0
*
* @return @c true if the Unicode character is an ISO control character, @n
* else @c false
- * @param[in] ch A Unicode character
+ * @param[in] ch The Unicode character
*/
static bool IsISOControl(wchar_t ch);
static const wchar_t VALUE_MAX = 0x10FFFF;
/**
- * A constant holding the smallest value of type wchar_t, 0x0000.
+ * A constant holding the smallest value of type @c wchar_t, 0x0000.
*
* @since 2.0
*/
static const wchar_t VALUE_MIN = 0x0000;
/**
- * The minimum radix available for conversion to and from strings. @n
- * Same value as RADIX_BINARY.
+ * The minimum radix available for converting to and from strings. @n
+ * Same value as ::RADIX_BINARY.
*
* @since 2.0
*/
static const int RADIX_MIN = 2;
/**
- * The radix for binary number.
+ * The radix for a binary number.
*
* @since 2.0
*/
static const int RADIX_BINARY = 2;
/**
- * The radix for decimal number.
+ * The radix for a decimal number.
*
* @since 2.0
*/
static const int RADIX_DECIMAL = 10;
/**
- * The radix for octal number.
+ * The radix for an octal number.
*
* @since 2.0
*/
static const int RADIX_OCTAL = 8;
/**
- * The radix for hexadecimal number.
+ * The radix for a hexadecimal number.
*
* @since 2.0
*/
static const int RADIX_HEXADECIMAL = 16;
/**
- * The maximum radix available for conversion to and from strings. Same value as RADIX_HEXADECIMAL.
+ * The maximum radix available for converting to and from strings. Same value as ::RADIX_HEXADECIMAL.
*
* @since 2.0
*/
static const int RADIX_MAX = 36;
/**
- * Special value that is returned by GetNumericValue(wchar_t ch) when no numeric value is defined for the unicode character.
+ * The special value that is returned by the GetNumericValue(wchar_t ch) method when no numeric value is defined for the unicode character.
*
* @since 2.0
*/
* @since 2.0
*
* @remarks @b Header @b %file: @b \#include @b <FBase.h> @n
- * @b Library : @b osp-appfw
+ * @b Library: @b osp-appfw
*
* The %Collection namespace contains classes and interfaces for various collections
* (such as lists, maps, stacks, and queues), which are an aggregation of similar objects.
*
- * For more information on the %
Base::Collection namespace features, see <a href="../org.tizen.native.appprogramming/html/guide/base/collection_namespace.htm">Collection</a>.
+ * For more information on the %Collection namespace features, see <a href="../org.tizen.native.appprogramming/html/guide/base/collection_namespace.htm">Collection</a>.
*
* The following diagrams illustrate the relationships between the classes belonging to the %Collection namespace.
*
{
/**
* @struct AllElementsDeleter
- * @brief This function object provides a resource clean-up function for collection.
+ * @brief This function object provides a resource clean-up function for a collection.
*
- * The %AllElementsDeleter struct provides a resource clean-up function for collection. This can be used with unique_ptr as a custom deleter.
+ * The %AllElementsDeleter struct provides a resource clean-up function for a collection. This can be used with unique_ptr as a custom deleter.
*
* @since 2.0
*/
* @since 2.0
*
* @param[in] c The collection to clean up
- * @remarks The collection should be destructible and support the RemoveAll(bool) method.
+ * @remarks The collection should be destructible and should support the RemoveAll(bool) method.
* IList, IMap, and IMultiMap support this concept.
*/
template< typename Collection >
*
* @since 2.0
*
- * @param[in] deleter The function pointer to type of the element deleter
- * @remarks To create an owning collection, set the element deleter value as @c SingleObjectDeleter. This gives the collection the ownership of elements and the collection will destroy elements. @n
- * On the other hand, to create a non-owning collection, you do not need to set the element deleter value, as @c NoOpDeleter is the default element deleter.
- * It means that you do not transfer the ownership of elements to the collection.
- * @remarks After creating an instance of the %ArrayList class, one of the Construct() methods must be called explicitly to initialize this instance.
+ * @param[in] deleter A function pointer to the type of the element deleter
+ * @remarks
+ * - To create an owning collection, set the element deleter value as @c SingleObjectDeleter. @n
+ * This gives the collection the ownership of the elements and the collection will destroy the elements. @n
+ * On the other hand, to create a non-owning collection, you do not need to set the element deleter value,
+ * as @c NoOpDeleter is the default element deleter. @n
+ * It means that you do not transfer the ownership of the elements to the collection.
+ * - After creating an instance of the %ArrayList class, one of the Construct() methods must be called explicitly to initialize this instance.
* @see NoOpDeleter()
* @see SingleObjectDeleter()
* @see ArrayDeleter()
* @since 2.0
*
* @return An error code
- * @param[in] capacity The number of elements @n
- * The default capacity is @c 10.
+ * @param[in] capacity The number of elements @n
+ * The default capacity is @c 10.
* @exception E_SUCCESS The method is successful.
- * @exception E_INVALID_ARG A specified input parameter is invalid, or
- * the specified @c capacity is negative.
- * @remarks If the number of elements added to the list reaches the current capacity,
- * the capacity is automatically increased by memory reallocation.
+ * @exception E_INVALID_ARG Either of the following conditions has occurred:
+ * - A specified input parameter is invalid.
+ * - The specified @c capacity is negative.
+ * @remarks If the number of elements added to the list reaches the current capacity,
+ * the capacity is automatically increased by memory reallocation. @n
* Therefore, if the size of the list can be estimated,
* specifying the initial capacity eliminates the need to perform a number of
* resizing operations while adding elements to the list.
* @since 2.0
*
* @return An error code
- * @param[in] collection A collection to add
+ * @param[in] collection The collection to add
* @exception E_SUCCESS The method is successful.
- * @exception E_INVALID_OPERATION The current state of the instance prohibits the execution of the specified operation, or
- * the @c collection is modified during the operation of this method.
- * @remarks This method performs a shallow copy. It copies just the pointer; not the element itself.
+ * @exception E_INVALID_OPERATION Either of the following conditions has occurred:
+ * - The current state of the instance prohibits the execution of the specified operation.
+ * - The specified @c collection is modified during the operation of this method.
+ * @remarks This method performs a shallow copy. It copies just the pointer and not the element itself.
* @see ArrayList()
*/
result Construct(const ICollection& collection);
* @since 2.0
*
* @return An error code
- * @param[in] pObj An pointer to object to add
+ * @param[in] pObj A pointer to the object to add
* @exception E_SUCCESS The method is successful.
* @exception E_INVALID_ARG The specified input parameter is invalid.
- * @remarks This method performs a shallow copy. It adds just the pointer; not the element itself.
+ * @remarks This method performs a shallow copy. It copies just the pointer and not the element itself.
* @see Remove()
*/
virtual result Add(Object* pObj);
* @since 2.0
*
* @return An error code
- * @param[in] collection A collection to add
+ * @param[in] collection The collection to add
* @exception E_SUCCESS The method is successful.
- * @exception E_INVALID_OPERATION The current state of the instance prohibits the execution of the specified operation, or
- * the @c collection is modified during the operation of this method.
- * @remarks This method performs a shallow copy. It adds just the pointer; not the element itself.
+ * @exception E_INVALID_OPERATION Either of the following conditions has occurred:
+ * - The current state of the instance prohibits the execution of the specified operation.
+ * - The specified @c collection is modified during the operation of this method.
+ * @remarks This method performs a shallow copy. It copies just the pointer and not the element itself.
* @see RemoveItems()
*/
virtual result AddItems(const ICollection& collection);
/**
- * Gets an enumerator (an instance of the IEnumerator-derived class) of this list.
+ * Gets the enumerator (an instance of the IEnumerator derived class) of this list.
*
* @since 2.0
*
- * @return An instance of the IEnumerator-derived class, @n
- * else @c null if some exception occurs
+ * @return An instance of the IEnumerator derived class, @n
+ * else @c null if an exception occurs
* @remarks The specific error code can be accessed using the GetLastResult() method.
*/
virtual IEnumerator* GetEnumeratorN(void) const;
/**
- * Gets a bidirectional enumerator (an instance of the IBidirectionalEnumerator derived class) of this list.
+ * Gets the bidirectional enumerator (an instance of the IBidirectionalEnumerator derived class) of this list.
*
* @since 2.0
*
* @return An instance of the IBidirectionalEnumerator derived class, @n
- * else @c null if some exception occurs
- * @remarks Use this method to obtain a bidirectional enumerator (an instance of the IBidirectionalEnumerator derived class)
+ * else @c null if an exception occurs
+ * @remarks
+ * - Use this method to obtain a bidirectional enumerator (an instance of the IBidirectionalEnumerator derived class)
* to iterate over a collection (an instance of the IList derived class).
- * The specific error code can be accessed using GetLastResult() method.
- * @see Tizen::Base::Collection::IBidirectionalEnumerator
+ * - The specific error code can be accessed using GetLastResult() method.
*/
virtual IBidirectionalEnumerator* GetBidirectionalEnumeratorN(void) const;
* @since 2.0
*
* @return The object at the specified @c index of this list, @n
- * else @c null if the index is not valid
- * @param[in] index The index of the object in the calling list to read
+ * else @c null if the @c index is not valid
+ * @param[in] index The index of the object to read in the calling list
* @exception E_SUCCESS The method is successful.
- * @exception E_OUT_OF_RANGE The specified @c index is outside the bounds of the data structure, or
- * the specified @c index is either equal to or greater than the number of elements or less than @c 0.
+ * @exception E_OUT_OF_RANGE Either of the following conditions has occurred:
+ * - The specified @c index is outside the bounds of the data structure.
+ * - The specified @c index is either equal to or greater than the number of elements.
+ * - The specified @c index is less than @c 0.
* @remarks The specific error code can be accessed using the GetLastResult() method.
* @see SetAt()
*/
* @since 2.0
*
* @return The object at the specified @c index of this list, @n
- * else @c null if the index is not valid
- * @param[in] index The index of the object to read
+ * else @c null if the @c index is not valid
+ * @param[in] index The index of the object to read
* @exception E_SUCCESS The method is successful.
- * @exception E_OUT_OF_RANGE The specified @c index is outside the bounds of the data structure, or
- * the specified @c index is either equal to or greater than the number of elements or less than @c 0.
+ * @exception E_OUT_OF_RANGE Either of the following conditions has occurred:
+ * - The specified @c index is outside the bounds of the data structure.
+ * - The specified @c index is either equal to or greater than the number of elements.
+ * - The specified @c index is less than @c 0.
* @remarks The specific error code can be accessed using the GetLastResult() method.
* @see SetAt()
*/
virtual Object* GetAt(int index);
/**
- * Gets the IList within the specified range of this list.
+ * Gets an IList instance within the specified range of this list.
*
* @since 2.0
*
* @return A pointer to IList, @n
- * else @c null if some exception occurs
- * @param[in] startIndex The starting index of the range
- * @param[in] count The number of elements to read
+ * else @c null if an exception occurs
+ * @param[in] startIndex The starting index of the range
+ * @param[in] count The number of elements to read
* @exception E_SUCCESS The method is successful.
- * @exception E_OUT_OF_RANGE Either of the following conditions has occurred: @n
- * - The specified index is outside the bounds of the data structure. @n
- * - The specified @c startIndex is either equal to or greater than the number of elements or less than @c 0. @n
- * - The @c count is greater than the number of elements starting from @c startIndex
- * or less than @c 0.
- * @remarks The IList stores just the pointers to the elements in the list, not the elements themselves.
- * The specific error code can be accessed using the GetLastResult() method.
+ * @exception E_OUT_OF_RANGE Either of the following conditions has occurred:
+ * - The specified index is outside the bounds of the data structure.
+ * - The specified @c startIndex is either equal to or greater than the number of elements.
+ * - The specified @c startIndex is less than @c 0.
+ * - The specified @c count is greater than the number of elements starting from @c startIndex.
+ * - The specified @c count is less than @c 0.
+ * @remarks
+ * - The IList stores only the pointers to the elements in the list, not the elements themselves.
+ * - The specific error code can be accessed using the GetLastResult() method.
*/
virtual IList* GetItemsN(int startIndex, int count) const;
/**
* Searches for an object in this list. @n
- * Gets the index of the object if found.
+ * Gets the @c index of the object if found.
*
* @since 2.0
*
* @return An error code
- * @param[in] obj The object to locate
- * @param[out] index The index of the object
+ * @param[in] obj The object to locate
+ * @param[out] index The index of the object
* @exception E_SUCCESS The method is successful.
- * @exception E_OBJ_NOT_FOUND The specified @c obj is not found.
+ * @exception E_OBJ_NOT_FOUND The specified @c obj has not been found.
* @see LastIndexOf()
*/
virtual result IndexOf(const Object& obj, int& index) const;
/**
- * Searches for an object starting from the specified index. @n
- * Gets the index of the object if found.
+ * Searches for an object starting from the specified @c startIndex. @n
+ * Gets the @c index of the object if found.
*
* @since 2.0
*
* @return An error code
- * @param[in] obj The object to locate
- * @param[in] startIndex The starting index for the search @n
- * It must be less than the number of elements.
- * @param[out] index The index of the object
+ * @param[in] obj The object to locate
+ * @param[in] startIndex The starting index for the search @n
+ * It must be less than the number of elements.
+ * @param[out] index The index of the object
* @exception E_SUCCESS The method is successful.
- * @exception E_OUT_OF_RANGE The specified index is outside the bounds of the data structure, or
- * the specified @c startIndex is either equal to or greater than the number of elements or less than @c 0.
- * @exception E_OBJ_NOT_FOUND The specified @c obj is not found.
+ * @exception E_OUT_OF_RANGE Either of the following conditions has occurred:
+ * - The specified @c index is outside the bounds of the data structure.
+ * - The specified @c startIndex is either equal to or greater than the number of elements.
+ * - The specified @c startIndex is less than @c 0.
+ * @exception E_OBJ_NOT_FOUND The specified @c obj has not been found.
* @see LastIndexOf()
*/
virtual result IndexOf(const Object& obj, int startIndex, int& index) const;
/**
* Searches for an object within the specified range. @n
- * Gets the index of the object if found.
+ * Gets the @c index of the object if found.
*
* @since 2.0
*
* @return An error code
- * @param[in] obj The object to locate
- * @param[in] startIndex The starting index of the range
- * @param[in] count The number of elements to read
- * @param[out] index The index of the object
+ * @param[in] obj The object to locate
+ * @param[in] startIndex The starting index of the range
+ * @param[in] count The number of elements to read
+ * @param[out] index The index of the object
* @exception E_SUCCESS The method is successful.
- * @exception E_OUT_OF_RANGE Either of the following conditions has occurred: @n
- * - The specified index is outside the bounds of the data structure. @n
- * - The specified @c startIndex is either equal to or greater than the number of elements or less than @c 0. @n
- * - The @c count is greater than the number of elements starting from @c startIndex
- * or less than @c 0.
- * @exception E_OBJ_NOT_FOUND The specified @c obj is not found.
+ * @exception E_OUT_OF_RANGE Either of the following conditions has occurred:
+ * - The specified @c index is outside the bounds of the data structure.
+ * - The specified @c startIndex is either equal to or greater than the number of elements.
+ * - The specified @c startIndex is less than @c 0.
+ * - The specified @c count is greater than the number of elements starting from @c startIndex.
+ * - The specified @c count is less than @c 0.
+ * @exception E_OBJ_NOT_FOUND The specified @c obj has not been found.
* @see LastIndexOf()
*/
virtual result IndexOf(const Object& obj, int startIndex, int count, int& index) const;
/**
* Searches for the last occurrence of an object in this list. @n
- * Gets the index of the object if found.
+ * Gets the @c index of the object if found.
*
* @since 2.0
*
* @return An error code
- * @param[in] obj The object to locate
- * @param[out] index The index of the last occurrence of the specified object
+ * @param[in] obj The object to locate
+ * @param[out] index The index of the last occurrence of the specified object
* @exception E_SUCCESS The method is successful.
- * @exception E_OBJ_NOT_FOUND The specified @c obj is not found.
+ * @exception E_OBJ_NOT_FOUND The specified @c obj has not been found.
* @see IndexOf()
*/
virtual result LastIndexOf(const Object& obj, int& index) const;
* @since 2.0
*
* @return An error code
- * @param[in] pObj The pointer to object to insert
- * @param[in] index The index at which the object must be inserted
+ * @param[in] pObj A pointer to the object to insert
+ * @param[in] index The index at which the object is inserted
* @exception E_SUCCESS The method is successful.
* @exception E_INVALID_ARG The specified input parameter is invalid.
- * @exception E_OUT_OF_RANGE The specified index is outside the bounds of the data structure, or
- * the @c index is greater than the number of elements or less than @c 0.
- * @remarks The elements that follow the insertion point move down to accommodate the new element.
- * If the @c index equals to the number of elements, then the new element
+ * @exception E_OUT_OF_RANGE Either of the following conditions has occurred:
+ * - The specified @c index is outside the bounds of the data structure.
+ * - The specified @c index is greater than the number of elements.
+ * - The specified @c index is less than @c 0.
+ * @remarks
+ * - The elements that follow the insertion point move down to accommodate the new element.
+ * - If the @c index is equal to the number of elements, then the new element
* is added at the end of this list.
- * This method performs a shallow copy. It inserts just the pointer; not the element itself.
+ * - This method performs a shallow copy. It inserts just the pointer and not the element itself.
* @see Add()
* @see RemoveAt()
*/
* @since 2.0
*
* @return An error code
- * @param[in] collection The collection to insert
- * @param[in] startIndex The starting index at which the collection must be inserted
+ * @param[in] collection The collection to insert
+ * @param[in] startIndex The starting index at which the collection is inserted
* @exception E_SUCCESS The method is successful.
- * @exception E_OUT_OF_RANGE The specified index is outside the bounds of the data structure, or
- * the @c startIndex is greater than the number of elements or less than @c 0.
- * @exception E_INVALID_OPERATION The current state of the instance prohibits the execution of the specified operation, or
- * the @c collection is modified during the operation of this method.
- * @remarks The elements that follow the insertion point move down to accommodate the new element.
- * If the @c startIndex equals to the number of elements then the new elements
+ * @exception E_OUT_OF_RANGE Either of the following conditions has occurred:
+ * - The specified index is outside the bounds of the data structure.
+ * - The specified @c startIndex is greater than the number of elements.
+ * - The specified @c startIndex is less than @c 0.
+ * @exception E_INVALID_OPERATION Either of the following conditions has occurred:
+ * - The current state of the instance prohibits the execution of the specified operation.
+ * - The specified @c collection is modified during the operation of this method.
+ * @remarks
+ * - The elements that follow the insertion point move down to accommodate the new element.
+ * - If the @c startIndex is equal to the number of elements then the new elements
* are added at the end of this list.
- * This method performs a shallow copy. It inserts just the pointer; not the element itself.
+ * - This method performs a shallow copy. It inserts just the pointer and not the element itself.
* @see RemoveItems()
* @see AddItems()
*/
* @since 2.0
*
* @return An error code
- * @param[in] obj An object to remove
+ * @param[in] obj The object to remove
* @exception E_SUCCESS The method is successful.
- * @exception E_OBJ_NOT_FOUND The specified @c obj is not found.
+ * @exception E_OBJ_NOT_FOUND The specified @c obj has not been found.
* @see Add()
* @see RemoveAt()
* @see RemoveAll()
* @since 2.0
*
* @return An error code
- * @param[in] index The index at which the object must be removed
+ * @param[in] index The index at which the object is removed
* @exception E_SUCCESS The method is successful.
- * @exception E_OUT_OF_RANGE The specified index is outside the bounds of the data structure, or
- * the specified @c index is either equal to or greater than the number of elements or less than @c 0.
+ * @exception E_OUT_OF_RANGE Either of the following conditions has occurred:
+ * - The specified @c index is outside the bounds of the data structure.
+ * - The specified @c index is either equal to or greater than the number of elements.
+ * - The specified @c index is less than @c 0.
* @remarks The elements that follow the deletion point move up to occupy the vacated spot.
* @see InsertAt()
* @see Remove()
* @since 2.0
*
* @return An error code
- * @param[in] startIndex The starting index of the range
- * @param[in] count The number of elements to read
+ * @param[in] startIndex The starting index of the range
+ * @param[in] count The number of elements to read
* @exception E_SUCCESS The method is successful.
- * @exception E_OUT_OF_RANGE Either of the following conditions has occurred: @n
- * - The specified index is outside the bounds of the data structure. @n
- * - The specified @c startIndex is either equal to or greater than the number of elements or less than @c 0. @n
- * - The @c count is greater than the number of elements starting from @c startIndex
- * or less than @c 0.
+ * @exception E_OUT_OF_RANGE Either of the following conditions has occurred:
+ * - The specified index is outside the bounds of the data structure.
+ * - The specified @c startIndex is either equal to or greater than the number of elements.
+ * - The specified @c startIndex is less than @c 0.
+ * - The specified @c count is greater than the number of elements starting from @c startIndex.
+ * - The specified @c count is less than @c 0.
* @remarks The elements that follow the deletion point move up to occupy the vacated spot.
* @see AddItems()
*/
* @return An error code
* @param[in] collection The collection to remove from this list
* @exception E_SUCCESS The method is successful.
- * @exception E_INVALID_OPERATION The current state of the instance prohibits the execution of the specified operation, or
- * the @c collection is modified during the operation of this method.
+ * @exception E_INVALID_OPERATION Either of the following conditions has occurred:
+ * - The current state of the instance prohibits the execution of the specified operation.
+ * - The specified @c collection is modified during the operation of this method.
* @see Remove()
* @see RemoveAt()
*/
virtual result RemoveItems(const ICollection& collection);
/**
- * Removes all of the object pointers in the collection and also removes all of the objects depending on the specified element deleter.
+ * Removes all the object pointers in the collection and also removes all the objects depending on the specified element deleter.
* The %RemoveAll() can be called before the collection is deleted.
*
* @since 2.0
* @since 2.0
*
* @return An error code
- * @param[in] pObj An pointer to object to set
- * @param[in] index The index at which the object must be set
+ * @param[in] pObj A pointer to the object to set
+ * @param[in] index The index at which the object is set
* @exception E_SUCCESS The method is successful.
- * @exception E_INVALID_ARG The specified input parameter is invalid.
- * @exception E_OUT_OF_RANGE The specified index is outside the bounds of the data structure, or
- * the specified @c index is either equal to or greater than the number of elements or less than @c 0.
+ * @exception E_INVALID_ARG A specified input parameter is invalid.
+ * @exception E_OUT_OF_RANGE Either of the following conditions has occurred:
+ * - The specified @c index is outside the bounds of the data structure.
+ * - The specified @c index is either equal to or greater than the number of elements.
+ * - The specified @c index is less than @c 0.
* @see GetAt()
*/
virtual result SetAt(Object* pObj, int index);
/**
- * Sets the capacity of this list to the specified value.
+ * Sets the capacity of this list at the specified value.
*
* @since 2.0
*
* @return An error code
- * @param[in] newCapacity The new capacity of this list
+ * @param[in] newCapacity The new capacity of this list
* @exception E_SUCCESS The method is successful.
- * @exception E_INVALID_ARG The specified input parameter is invalid, or
- * the @c newCapacity is negative.
+ * @exception E_INVALID_ARG Either of the following conditions has occurred:
+ * - The specified input parameter is invalid.
+ * - The specified @c newCapacity is negative.
* @remarks When the new capacity is less than the current capacity, the elements
* within the truncated memory are not destroyed.
* @see Construct()
virtual result SetCapacity(int newCapacity);
/**
- * Sorts the elements of this list using the comparer provided.
+ * Sorts the elements of this list using the @c comparer provided.
*
* @since 2.0
*
virtual int GetCount(void) const;
/**
- * Checks whether a list contains the specified object.
+ * Checks whether the list contains the specified object.
*
* @since 2.0
*
* @return @c true if the object is present in the list, @n
* else @c false
- * @param[in] obj The object to locate
+ * @param[in] obj The object to locate
* @see ContainsAll()
*/
virtual bool Contains(const Object& obj) const;
*
* @return @c true if the list contains all the elements of the specified @c collection, @n
* else @c false
- * @param[in] collection The collection to check for in the list
+ * @param[in] collection The collection to check for in the list
* @exception E_SUCCESS The method is successful.
- * @exception E_INVALID_OPERATION The current state of the instance prohibits the execution of the specified operation, or
- * the @c collection is modified during the operation of this method.
- * @remarks The specific error code can be accessed using the GetLastResult() method.
- * @remarks If the given @c collection is empty, this method will return @c true.
+ * @exception E_INVALID_OPERATION Either of the following conditions has occurred:
+ * - The current state of the instance prohibits the execution of the specified operation.
+ * - The specified @c collection is modified during the operation of this method.
+ * @remarks
+ * - The specific error code can be accessed using the GetLastResult() method.
+ * - If the given @c collection is empty, this method will return @c true.
* @see Contains()
*/
virtual bool ContainsAll(const ICollection& collection) const;
/**
- * Compares the specified Object instance with the calling %ArrayList instance.
+ * Compares the specified Tizen::Base::Object instance with the calling %ArrayList instance.
*
* @since 2.0
*
- * @return @c true if the given object matches the calling List, @n
+ * @return @c true if the given Tizen::Base::Object matches the calling list, @n
* else @c false
* @param[in] obj The object to compare with the calling list
- * @remarks This method returns @c true only if the specified object @c obj is also an instance of %ArrayList class,
- * both lists have the same size, and all the corresponding pairs of the elements in the two lists are equal.
+ * @remarks This method returns @c true only if the specified @c obj is also an instance of %ArrayList,
+ * both lists have the same size, and all the corresponding pairs of the elements in the two lists are equal. @n
* In other words, the two lists are equal if they contain the same elements in the same order.
*/
virtual bool Equals(const Object& obj) const;
* @since 2.0
*
* @return The hash value of the current instance
- * @remarks The two Tizen::Base::Object::Equals() instances must return the same hash value. For better performance, @n
- * the used hash function must generate a random distribution for all inputs.
+ * @remarks The two Tizen::Base::Object::Equals() instances must return the same hash value. @n
+ * For better performance, the used hash function must generate a random distribution for all the inputs.
*/
virtual int GetHashCode(void) const;
/**
- * Distinguish between %ArrayList and LinkedList.
+ * Checks whether the instance is an %ArrayList or a LinkedList.
*
* @since 2.0
* @return @c true if it is an %ArrayList, @n
* @param[in] capacity The initial capacity of the class @n
* The default capacity is @c 10.
* @exception E_SUCCESS The method is successful.
- * @exception E_INVALID_ARG A specified input parameter is invalid, or
- * the specified @c capacity is negative.
- * @remarks If the number of elements added to the list reaches its current capacity,
- * the capacity is automatically increased by memory reallocation.
+ * @exception E_INVALID_ARG Either of the following conditions has occurred:
+ * - The specified input parameter is invalid.
+ * - The specified @c capacity is negative.
+ * @remarks If the number of elements added to the list reaches its current capacity,
+ * the capacity is automatically increased by memory reallocation. @n
* Thus, if the size of the list can be estimated,
* specifying the initial capacity eliminates the need to perform a number of
* resizing operations while adding elements to the list.
* @since 2.0
*
* @return An error code
- * @param[in] collection A collection of elements to add
+ * @param[in] collection The collection of elements to add
* @exception E_SUCCESS The method is successful.
- * @exception E_INVALID_OPERATION The current state of the instance prohibits the execution of the specified operation, or
- * the @c collection is modified during the operation of this method.
+ * @exception E_INVALID_OPERATION Either of the following conditions has occurred:
+ * - The current state of the instance prohibits the execution of the specified operation.
+ * - The specified @c collection is modified during the operation of this method.
* @see ArrayListT()
*/
result Construct(const ICollectionT< Type >& collection)
}
/**
- * Adds the specified object to the end of the list.
+ * Adds the specified @c obj to the end of the list.
*
* @since 2.0
*
* @return An error code
- * @param[in] obj An object to add to the list
+ * @param[in] obj The object to add to the list
* @exception E_SUCCESS The method is successful.
* @exception E_OUT_OF_MEMORY The memory is insufficient.
* @see Remove()
}
/**
- * Adds the elements of the specified collection to the end of the list.
+ * Adds the elements of the specified @c collection to the end of the list.
*
* @since 2.0
*
* @return An error code
- * @param[in] collection A collection of elements to add to the list
+ * @param[in] collection The collection of elements to add to the list
* @exception E_SUCCESS The method is successful.
- * @exception E_INVALID_OPERATION The current state of the instance prohibits the execution of the specified operation, or
- * the @c collection is modified during the operation of this method.
+ * @exception E_INVALID_OPERATION Either of the following conditions has occurred:
+ * - The current state of the instance prohibits the execution of the specified operation.
+ * - The specified @c collection is modified during the operation of this method.
* @see RemoveItems()
*/
virtual result AddItems(const ICollectionT< Type >& collection)
}
/**
- * Gets the elements of the list in an instance of the IEnumeratorT derived class.
+ * Gets the elements of the list through an instance of the IEnumeratorT derived class.
*
* @since 2.0
*
- * @return An instance of the IEnumeratorT derived class if successful, @n
+ * @return An instance of the IEnumeratorT derived class, @n
* else @c null if an exception occurs
* @exception E_SUCCESS The method is successful.
* @exception E_OUT_OF_MEMORY The memory is insufficient.
* @remarks The specific error code can be accessed using the GetLastResult() method.
- * @see Tizen::Base::Collection::IEnumeratorT
*/
virtual IEnumeratorT< Type >* GetEnumeratorN(void) const
{
}
/**
- * Gets a bidirectional enumerator (an instance of the IBidirectionalEnumeratorT derived class) of this list.
+ * Gets the bidirectional enumerator (an instance of the IBidirectionalEnumeratorT derived class) of this list.
*
* @since 2.0
*
* else @c null if an exception occurs
* @exception E_SUCCESS The method is successful.
* @exception E_OUT_OF_MEMORY The memory is insufficient.
- * @remarks Use this method to obtain a bidirectional enumerator (an instance of the IBidirectionalEnumeratorT derived class)
+ * @remarks
+ * - Use this method to obtain a bidirectional enumerator (an instance of the IBidirectionalEnumeratorT derived class)
* to iterate over a collection (an instance of the IListT derived class).
- * @remarks The specific error code can be accessed using the GetLastResult() method.
- * @see Tizen::Base::Collection::IBidirectionalEnumeratorT
+ * - The specific error code can be accessed using the GetLastResult() method.
*/
virtual IBidirectionalEnumeratorT< Type >* GetBidirectionalEnumeratorN(void) const
{
*
* @return An error code
* @param[in] index The index of the object to read
- * @param[out] obj An object to get from this list
+ * @param[out] obj The object to get from this list
* @exception E_SUCCESS The method is successful.
- * @exception E_OUT_OF_RANGE The specified @c index is outside the bounds of the data structure, or
- * the specified @c index is either equal to or greater than the number of elements or less than @c 0.
+ * @exception E_OUT_OF_RANGE Either of the following conditions has occurred:
+ * - The specified @c index is outside the bounds of the data structure.
+ * - The specified @c index is either greater than or equal to the number of elements.
+ * - The specified @c index is less than @c 0.
* @see SetAt()
*/
virtual result GetAt(int index, Type& obj) const
*
* @return An error code
* @param[in] index The index of the object to read
- * @param[out] obj An object to get from this list
+ * @param[out] obj The object to get from this list
* @exception E_SUCCESS The method is successful.
- * @exception E_OUT_OF_RANGE The specified @c index is outside the bounds of the data structure, or
- * the specified @c index is either equal to or greater than the number of elements or less than @c 0.
+ * @exception E_OUT_OF_RANGE Either of the following conditions has occurred:
+ * - The specified @c index is outside the bounds of the data structure.
+ * - The specified @c index is either greater than or equal to the number of elements.
+ * - The specified @c index is less than @c 0.
* @see SetAt()
*/
virtual result GetAt(int index, Type& obj)
}
/**
- * Gets a list of a specified number of elements starting from a specified index.
+ * Gets a list of the specified number of elements starting from the specified index.
*
* @since 2.0
*
* @return An instance of the IListT derived class within the specified range of the list, @n
* else @c null if an exception occurs
- * @param[in] startIndex The index to start reading elements from
- * @param[in] count The number of elements to read
+ * @param[in] startIndex The index to start reading elements from
+ * @param[in] count The number of elements to read
* @exception E_SUCCESS The method is successful.
* @exception E_INVALID_ARG A specified input parameter is invalid.
- * @exception E_OUT_OF_RANGE Either of the following conditions has occurred: @n
- * - The specified index is outside the bounds of the data structure. @n
- * - The specified @c startIndex is either greater than or equal to the number of elements or less than @c 0. @n
- * - The specified @c count is either greater than the number of elements starting from @c startIndex or less than @c 0.
+ * @exception E_OUT_OF_RANGE Either of the following conditions has occurred:
+ * - The specified index is outside the bounds of the data structure.
+ * - The specified @c startIndex is either greater than or equal to the number of elements.
+ * - The specified @c startIndex is less than @c 0.
+ * - The specified @c count is greater than the number of elements starting from @c startIndex.
+ * - The specified @c count is less than @c 0.
*
* @remarks The specific error code can be accessed using the GetLastResult() method.
*/
/**
* Searches for an object in this list. @n
- * Gets the index of the object if found.
+ * Gets the @c index of the object if found.
*
* @since 2.0
*
* @return An error code
- * @param[in] obj The object to locate
- * @param[out] index The index of the object
+ * @param[in] obj The object to locate
+ * @param[out] index The index of the object
* @exception E_SUCCESS The method is successful.
- * @exception E_OBJ_NOT_FOUND The specified @c obj is not found.
+ * @exception E_OBJ_NOT_FOUND The specified @c obj has not been found.
* @see LastIndexOf()
*/
virtual result IndexOf(const Type& obj, int& index) const
/**
* Searches for an object starting from the specified @c index. @n
- * Gets the index of the object if found.
+ * Gets the @c index of the object if found.
*
* @since 2.0
*
* @return An error code
- * @param[in] obj The object to locate
- * @param[in] startIndex The starting index for the search @n
- * It must be less than the number of elements.
- * @param[out] index The index of the object
+ * @param[in] obj The object to locate
+ * @param[in] startIndex The starting index for the search @n
+ * It must be less than the number of elements.
+ * @param[out] index The index of the object
* @exception E_SUCCESS The method is successful.
- * @exception E_OUT_OF_RANGE The specified @c index is outside the bounds of the data structure, or
- * the specified @c startIndex is either equal to or greater than the number of elements or less than @c 0.
- * @exception E_OBJ_NOT_FOUND The specified @c obj is not found.
+ * @exception E_OUT_OF_RANGE Either of the following conditions has occurred:
+ * - The specified @c index is outside the bounds of the data structure.
+ * - The specified @c startIndex is either greater than or equal to the number of elements.
+ * - The specified @c startIndex is less than @c 0.
+ * @exception E_OBJ_NOT_FOUND The specified @c obj has not been found.
* @see LastIndexOf()
*/
virtual result IndexOf(const Type& obj, int startIndex, int& index) const
/**
* Searches for an object within the specified range. @n
- * Gets the index of the object if found.
+ * Gets the @c index of the object if found.
*
* @since 2.0
*
* @return An error code
- * @param[in] obj The object to locate
- * @param[in] startIndex The starting index of the range
- * @param[in] count The number of elements to read
- * @param[out] index The index of the object
+ * @param[in] obj The object to locate
+ * @param[in] startIndex The starting index of the range
+ * @param[in] count The number of elements to read
+ * @param[out] index The index of the object
* @exception E_SUCCESS The method is successful.
- * @exception E_OUT_OF_RANGE Either of the following conditions has occurred: @n
- * - The specified @c index is outside the bounds of the data structure. @n
- * - The specified @c startIndex is either greater than or equal to the number of elements or less than @c 0. @n
- * - The specified @c count is either greater than the number of elements starting from @c startIndex or less than @c 0.
- * @exception E_OBJ_NOT_FOUND The specified @c obj is not found.
+ * @exception E_OUT_OF_RANGE Either of the following conditions has occurred:
+ * - The specified @c index is outside the bounds of the data structure.
+ * - The specified @c startIndex is either greater than or equal to the number of elements.
+ * - The specified @c startIndex is less than @c 0.
+ * - The specified @c count is greater than the number of elements starting from @c startIndex.
+ * - The specified @c count is less than @c 0.
+ * @exception E_OBJ_NOT_FOUND The specified @c obj has not been found.
* @see LastIndexOf()
*/
virtual result IndexOf(const Type& obj, int startIndex, int count, int& index) const
}
/**
- * Inserts an object at a specified location.
+ * Inserts an object at the specified location.
*
* @since 2.0
*
* @return An error code
- * @param[in] obj The object to insert
- * @param[in] index The index at which the object must be inserted
+ * @param[in] obj The object to insert
+ * @param[in] index The index at which the object is inserted
* @exception E_SUCCESS The method is successful.
- * @exception E_OUT_OF_RANGE The specified @c index is outside the bounds of the data structure, or
- * the @c index is greater than the number of elements or less than @c 0.
- * @remarks The elements that follow the insertion point move down to accommodate the new element.
- * If the @c index equals the number of elements in the list, the new element
+ * @exception E_OUT_OF_RANGE Either of the following conditions has occurred:
+ * - The specified @c index is outside the bounds of the data structure.
+ * - The specified @c index is greater than the number of elements.
+ * - The specified @c index is less than @c 0.
+ * @remarks
+ * - The elements that follow the insertion point move down to accommodate the new element.
+ * - If the @c index is equal to the number of elements in the list, the new element
* is added at the end of the list.
* @see Add()
* @see RemoveAt()
}
/**
- * Inserts the elements of a collection at a specified location.
+ * Inserts the elements of the collection from a specified location.
*
* @since 2.0
*
* @return An error code
- * @param[in] collection The collection to insert
- * @param[in] startIndex The index from which the collection must be inserted
+ * @param[in] collection The collection to insert
+ * @param[in] startIndex The index from which the collection is inserted
* @exception E_SUCCESS The method is successful.
- * @exception E_OUT_OF_RANGE The specified index is outside the bounds of the data structure, or
- * the @c startIndex is greater than the number of elements or less than @c 0.
- * @exception E_INVALID_OPERATION The current state of the instance prohibits the execution of the specified operation, or
- * the @c collection is modified during the operation of this method.
- * @remarks The elements that follow the insertion point move down to accommodate the new elements.
- * If the @c startIndex equals the number of elements in the list, the new elements
+ * @exception E_OUT_OF_RANGE Either of the following conditions has occurred:
+ * - The specified @c index is outside the bounds of the data structure.
+ * - The specified @c startIndex is greater than the number of elements.
+ * - The specified @c startIndex is less than @c 0.
+ * @exception E_INVALID_OPERATION Either of the following conditions has occurred:
+ * - The current state of the instance prohibits the execution of the specified operation.
+ * - The specified @c collection is modified during the operation of this method.
+ * @remarks
+ * - The elements that follow the insertion point move down to accommodate the new elements.
+ * - If the @c startIndex is equal to the number of elements in the list, the new elements
* are added at the end of the list.
* @see RemoveItems()
* @see AddItems()
/**
* Searches for the last occurrence of an object in this list. @n
- * Gets the index of the object if found.
+ * Gets the @c index of the object if found.
*
* @since 2.0
*
* @return An error code
- * @param[in] obj The object to locate
- * @param[out] index The index of the last occurrence of the specified object
+ * @param[in] obj The object to locate
+ * @param[out] index The index of the last occurrence of the specified object
* @exception E_SUCCESS The method is successful.
- * @exception E_OBJ_NOT_FOUND The specified @c obj is not found.
+ * @exception E_OBJ_NOT_FOUND The specified @c obj has not been found.
* @see IndexOf()
*/
virtual result LastIndexOf(const Type& obj, int& index) const
}
/**
- * Removes the first occurrence of a specified object.
+ * Removes the first occurrence of the specified object.
*
* @since 2.0
*
* @return An error code
* @param[in] obj The object to remove
* @exception E_SUCCESS The method is successful.
- * @exception E_OBJ_NOT_FOUND The specified @c obj is not found.
+ * @exception E_OBJ_NOT_FOUND The specified @c obj has not been found.
* @see Add()
* @see RemoveAt()
* @see RemoveAll()
}
/**
- * Removes all the elements of a specified collection from the list.
+ * Removes all the elements of the specified collection from the list.
*
* @since 2.0
*
* @return An error code
* @param[in] collection The collection to remove from this list
* @exception E_SUCCESS The method is successful.
- * @exception E_INVALID_OPERATION The current state of the instance prohibits the execution of the specified operation, or
- * the @c collection is modified during the operation of this method.
+ * @exception E_INVALID_OPERATION Either of the following conditions has occurred:
+ * - The current state of the instance prohibits the execution of the specified operation.
+ * - The specified @c collection is modified during the operation of this method.
* @see Remove()
* @see RemoveAt()
*/
}
/**
- * Removes an object from a specified location.
+ * Removes an object from the specified location.
*
* @since 2.0
*
* @return An error code
- * @param[in] index The index of the object that is to remove
+ * @param[in] index The index of the object to remove
* @exception E_SUCCESS The method is successful.
- * @exception E_OUT_OF_RANGE The specified @c index is outside the bounds of the data structure, or
- * the specified @c index is greater than or equal to the number of elements or less than @c 0.
+ * @exception E_OUT_OF_RANGE Either of the following conditions has occurred:
+ * - The specified @c index is outside the bounds of the data structure.
+ * - The specified @c index is greater than or equal to the number of elements.
+ * - The specified @c index is less than @c 0.
* @remarks The elements that follow the deleted object move up the list to occupy the empty location.
* @see InsertAt()
* @see Remove()
}
/**
- * Removes all the elements within a specified range.
+ * Removes all the elements within the specified range.
*
* @since 2.0
*
* @return An error code
- * @param[in] startIndex The starting index of the range
- * @param[in] count The number of elements to remove
+ * @param[in] startIndex The starting index of the range
+ * @param[in] count The number of elements to remove
* @exception E_SUCCESS The method is successful.
- * @exception E_OUT_OF_RANGE Either of the following conditions has occurred: @n
- * - The specified index is outside the bounds of the data structure. @n
- * - The specified @c startIndex is either greater than or equal to the number of elements or less than @c 0. @n
- * - The specified @c count is either greater than the number of elements starting from @c startIndex or less than @c 0.
+ * @exception E_OUT_OF_RANGE Either of the following conditions has occurred:
+ * - The specified index is outside the bounds of the data structure.
+ * - The specified @c startIndex is either greater than or equal to the number of elements.
+ * - The specified @c startIndex is less than @c 0.
+ * - The specified @c count is greater than the number of elements starting from @c startIndex.
+ * - The specified @c count is less than @c 0.
* @remarks The elements that follow the deleted elements move up the list to occupy the empty locations.
* @see AddItems()
* @see InsertItemsFrom()
}
/**
- * Removes all elements in the list.
+ * Removes all the elements in the list.
*
* @since 2.0
*/
}
/**
- * Sets the object at a specified @c index of the current instance of ByteBuffer with the specified object.
+ * Sets the object at the specified @c index of the current instance of ByteBuffer.
*
* @since 2.0
*
* @return An error code
- * @param[in] obj The object to set
- * @param[in] index The index at which the object must be set
+ * @param[in] obj The object to set
+ * @param[in] index The index at which the object must be set
* @exception E_SUCCESS The method is successful.
- * @exception E_OUT_OF_RANGE The specified @c index is outside the bounds of the data structure, or
- * the specified @c index is either equal to or greater than the number of elements or less than @c 0.
+ * @exception E_OUT_OF_RANGE Either of the following conditions has occurred:
+ * - The specified @c index is outside the bounds of the data structure.
+ * - The specified @c index is either greater than or equal to the number of elements.
+ * - The specified @c index is less than @c 0.
* @see GetAt()
*/
virtual result SetAt(const Type& obj, int index)
}
/**
- * Sets the capacity of the list to a specified value.
+ * Sets the capacity of the list at the specified value.
*
* @since 2.0
*
* @return An error code
* @param[in] newCapacity The new capacity to set for the list
* @exception E_SUCCESS The method is successful.
- * @exception E_INVALID_ARG A specified input parameter is invalid, or
- * the @c newCapacity is negative.
+ * @exception E_INVALID_ARG Either of the following conditions has occurred:
+ * - The specified input parameter is invalid.
+ * - The specified @c newCapacity is negative.
* @remarks If the new capacity is less than the current capacity, the memory
* is truncated and the elements within the truncated memory are destroyed.
* @see Construct()
* @return An error code
* @param[in] comparer A pointer to IComparerT
* @exception E_SUCCESS The method is successful.
- * @exception E_INVALID_ARG A specified input parameter is invalid, or
- * the @c comparer is not valid.
+ * @exception E_INVALID_ARG Either of the following conditions has occurred:
+ * - The specified input parameter is invalid.
+ * - The specified @c comparer is invalid.
*/
virtual result Sort(const IComparerT< Type >& comparer)
{
}
/**
- * Trims the capacity of a list to the actual number of elements in the list.
+ * Trims the capacity of the list to the actual number of elements in the list.
*
* @since 2.0
*
* @return An error code
- * @exception E_SUCCESS The method is successful.
- * @exception E_OUT_OF_MEMORY The memory is insufficient.
+ * @exception E_SUCCESS The method is successful.
+ * @exception E_OUT_OF_MEMORY The memory is insufficient.
* @remarks The specific error code can be accessed using the GetLastResult() method.
* @see SetCapacity()
*/
}
/**
- * Checks whether a list contains the specified object.
+ * Checks whether the list contains the specified object.
*
* @since 2.0
*
* @return @c true if the object is present in the list, @n
* else @c false
- * @param[in] obj The object to locate
+ * @param[in] obj The object to locate
* @see ContainsAll()
*/
virtual bool Contains(const Type& obj) const
* @since 2.0
*
* @return An error code
- * @param[in] collection The collection to check for in the list
- * @param[out] out @c true if the list contains all the elements of the specified @c collection, @n
- * else @c false
+ * @param[in] collection The collection to check in the list
+ * @param[out] out @c true if the list contains all the elements of the specified @c collection, @n
+ * else @c false
* @exception E_SUCCESS The method is successful.
- * @exception E_INVALID_OPERATION The current state of the instance prohibits the execution of the specified operation, or
- * the @c collection is modified during the operation of this method.
- * @remarks If the given @c collection is empty, the @c out parameter will be set to @c true.
+ * @exception E_INVALID_OPERATION Either of the following conditions has occurred:
+ * - The current state of the instance prohibits the execution of the specified operation.
+ * - The specified @c collection is modified during the operation of this method.
+ * @remarks If the given @c collection is empty, then @c out is set to @c true.
* @see Contains()
*/
virtual result ContainsAll(const ICollectionT< Type >& collection, bool& out) const
}
/**
- * Compares two instances of the %ArrayListT class.
+ * Compares two instances of %ArrayListT.
*
* @since 2.0
*
* @since 2.0
*
* @return The hash value of the current instance
- * @remarks The two Tizen::Base::Object::Equals() instances must return the same hash value. For better performance, @n
- * the used hash function must generate a random distribution for all inputs.
+ * @remarks The two Tizen::Base::Object::Equals() instances must return the same hash value. @n
+ * For better performance, the used hash function must generate a random distribution for all the inputs.
*/
virtual int GetHashCode(void) const
{
*
* For more information on the class features, see <a href="../org.tizen.native.appprogramming/html/guide/base/hashmap_multihashmap.htm">HashMap and MultiHashMap</a>.
*
- * The following example demonstrates how to use the %HashMap class to create and initialize a %HashMap instance and to use its methods.
+ * The following example demonstrates how to use the %HashMap class to create and initialize a %HashMap instance and use its methods.
*
* @code
*
*
* @since 2.0
*
- * @param[in] deleter The function pointer to type of the element deleter
- * @remarks To create an owning collection, set the element deleter value as @c SingleObjectDeleter. This gives the collection the ownership of elements and the collection will destroy elements. @n
- * On the other hand, to create a non-owning collection, you do not need to set the element deleter value, as @c NoOpDeleter is the default element deleter.
- * It means that you do not transfer the ownership of elements to the collection.
+ * @param[in] deleter A function pointer to the type of the element deleter
+ * @remarks To create an owning collection, set the element deleter value as @c SingleObjectDeleter. @n
+ * This gives the collection, the ownership of the elements and the collection destroys the elements. @n
+ * On the other hand, to create a non-owning collection, do not set the element deleter value, as @c NoOpDeleter is the default element deleter.
+ * It means that you do not transfer the ownership of the elements to the collection.
* @see NoOpDeleter()
* @see SingleObjectDeleter()
* @see ArrayDeleter()
virtual ~HashMap(void);
/**
- * Initializes an instance of an empty %HashMap class with the initial capacity and load factor.
+ * Initializes an instance of the empty %HashMap with the initial @c capacity and the load factor.
*
* @since 2.0
*
* @param[in] capacity The initial capacity
* @param[in] loadFactor The maximum ratio of elements to buckets
* @exception E_SUCCESS The method is successful.
- * @exception E_INVALID_ARG A specified input parameter is invalid, @n
- * the @c capacity or the @c loadFactor is negative.
- * @remarks The GetHashCode() method of key objects is used for hashing and
- * the Equals() method of key objects is used for comparing keys.
+ * @exception E_INVALID_ARG Either of the following conditions has occurred:
+ * - A specified input parameter is invalid.
+ * - The specified @c capacity or the specified @c loadFactor is negative.
+ * @remarks The GetHashCode() method of the key objects is used for hashing and
+ * the Equals() method of the key objects is used for comparing the keys.
* @see HashMap()
*/
result Construct(int capacity = 16, float loadFactor = 0.75);
/**
- * Initializes an instance of a %HashMap class by copying the elements of the specified @c map.
+ * Initializes an instance of %HashMap by copying the elements of the specified @c map.
*
* @since 2.0
*
* @return An error code
- * @param[in] map The map to copy
- * @param[in] loadFactor The maximum ratio of elements to buckets
- * @exception E_SUCCESS The method is successful.
- * @exception E_INVALID_ARG A specified input parameter is invalid, or
- * the @c loadFactor is negative.
- * @exception E_INVALID_OPERATION The current state of the instance prohibits the execution of the specified operation, or
- * the @c map is modified during the operation of this method.
- * @remarks This method performs a shallow copy. It copies only the pointer; not the element itself.
+ * @param[in] map The map to copy
+ * @param[in] loadFactor The maximum ratio of elements to buckets
+ * @exception E_SUCCESS The method is successful.
+ * @exception E_INVALID_ARG Either of the following conditions has occurred:
+ * - A specified input parameter is invalid.
+ * - The specified @c loadFactor is negative.
+ * @exception E_INVALID_OPERATION Either of the following conditions has occurred:
+ * - The current state of the instance prohibits the execution of the specified operation.
+ * - The specified @c map is modified during the operation of this method.
+ * @remarks This method performs a shallow copy. It copies just the pointer and not the element itself.
* @see HashMap()
*/
result Construct(const IMap& map, float loadFactor = 0.75);
/**
- * Initializes an instance of an empty %HashMap class with the specified initial capacity, load factor, hash code provider, and comparer.
+ * Initializes an instance of the empty %HashMap with the specified initial capacity, load factor, hash code provider, and comparer.
*
* @since 2.0
*
* @param[in] comparer An instance of the IComparer derived class to use when comparing the keys
*
* @exception E_SUCCESS The method is successful.
- * @exception E_INVALID_ARG A specified input parameter is invalid, or
- * the @c capacity or the @c loadFactor is negative.
- * @remarks The instances of hash code provider and comparer will not be deallocated later from this map.
+ * @exception E_INVALID_ARG Either of the following conditions has occurred:
+ * - A specified input parameter is invalid.
+ * - The specified @c capacity or the specified @c loadFactor is negative.
+ * @remarks The instances of the hash code provider and the comparer are not deallocated later from this map.
* @see HashMap()
*/
result Construct(int capacity, float loadFactor, const IHashCodeProvider& provider, const IComparer& comparer);
/**
- * Initializes an instance of a %HashMap class by copying the elements of the specified map with the specified load factor, hash code provider, and comparer.
+ * Initializes an instance of %HashMap by copying the elements of the specified map with the specified load factor, hash code provider, and comparer.
*
* @since 2.0
*
* @return An error code
- * @param[in] map The map to copy
- * @param[in] loadFactor The maximum ratio of elements to buckets @n
- * If it is @c 0, the default load factor(0.75) is used.
- * @param[in] provider An instance of the IHashCodeProvider derived class that supplies the hash codes for all keys in this map
- * @param[in] comparer An instance of the IComparer derived class to use when comparing keys
+ * @param[in] map The map to copy
+ * @param[in] loadFactor The maximum ratio of elements to buckets @n
+ * If it is @c 0, the default load factor(0.75) is used.
+ * @param[in] provider An instance of the IHashCodeProvider derived class that supplies the hash codes for all the keys in this map
+ * @param[in] comparer An instance of the IComparer derived class to use when comparing the keys
* @exception E_SUCCESS The method is successful.
- * @exception E_INVALID_ARG A specified input parameter is invalid, or
- * the @c loadFactor is negative.
- * @exception E_INVALID_OPERATION The current state of the instance prohibits the execution of the specified operation, or
- * the @c map is modified during the operation of this method.
- * @remarks This method performs a shallow copy. It copies only the pointer; not the element itself.
- * @remarks The instances of hash code provider and comparer will not be deallocated later from this map.
+ * @exception E_INVALID_ARG Either of the following conditions has occurred:
+ * - A specified input parameter is invalid.
+ * - The specified @c loadFactor is negative.
+ * @exception E_INVALID_OPERATION Either of the following conditions has occurred:
+ * - The current state of the instance prohibits the execution of the specified operation.
+ * - The specified @c map is modified during the operation of this method.
+ * @remarks
+ * - This method performs a shallow copy. It copies just the pointer and not the element itself.
+ * - The instances of the hash code provider and the comparer are not deallocated later from this map.
* @see HashMap()
*/
result Construct(const IMap& map, float loadFactor, const IHashCodeProvider& provider, const IComparer& comparer);
/**
- * Adds the specified key-value pair to a map.
+ * Adds the specified key-value pair to the map.
*
* @since 2.0
*
* @return An error code
- * @param[in] pKey The pointer to key of the value to add
- * @param[in] pValue The pointer to value to add
+ * @param[in] pKey A pointer to the key of the value to add
+ * @param[in] pValue A pointer to the value to add
* @exception E_SUCCESS The method is successful.
- * @exception E_INVALID_ARG A specified input parameter is invalid, or
- * the comparer has failed to compare the keys.
+ * @exception E_INVALID_ARG Either of the following conditions has occurred:
+ * - A specified input parameter is invalid.
+ * - The comparer has failed to compare the keys.
* @exception E_OBJ_ALREADY_EXIST The specified @c pKey already exists.
- * @remarks This method performs a shallow copy. It adds only the pointer; not the element itself.
+ * @remarks This method performs a shallow copy. It adds just the pointer and not the element itself.
* @see Remove()
*/
virtual result Add(Object* pKey, Object* pValue);
/**
- * Gets an enumerator (an instance of the IMapEnumerator derived class) of this map.
+ * Gets the enumerator (an instance of the IMapEnumerator derived class) of this map.
*
* @since 2.0
*
- * @return An instance of the IMapEnumerator derived class, if successful @n
+ * @return An instance of the IMapEnumerator derived class, @n
* else @c null if an exception occurs
* @remarks The specific error code can be accessed using the GetLastResult() method.
* @see Tizen::Base::Collection::IEnumerator
- * @see Tizen::Base::Collection::IMapEnumerator
*/
virtual IEnumerator* GetEnumeratorN(void) const;
/**
- * Gets the elements of the map in an instance of the IMapEnumerator derived class.
+ * Gets the elements of the map through an instance of the IMapEnumerator derived class.
*
* @since 2.0
*
* else @c null if an exception occurs
* @remarks The specific error code can be accessed using the GetLastResult() method.
* @see Tizen::Base::Collection::IEnumerator
- * @see Tizen::Base::Collection::IMapEnumerator
*/
virtual IMapEnumerator* GetMapEnumeratorN(void) const;
/**
- * Gets the value associated with the specified @c key.
+ * Gets the value associated to the specified @c key.
*
* @since 2.0
*
- * @return The value associated with the key, @n
+ * @return The value associated to the key, @n
* else @c null if an exception occurs
- * @param[in] key The key to locate
+ * @param[in] key The key to locate
* @exception E_SUCCESS The method is successful.
- * @exception E_INVALID_ARG The specified input parameter is invalid, or
- * the comparer has failed to compare the keys.
- * @exception E_OBJ_NOT_FOUND The specified @c key is not found in the map.
+ * @exception E_INVALID_ARG Either of the following conditions has occurred:
+ * - The specified input parameter is invalid.
+ * - The comparer has failed to compare the keys.
+ * @exception E_OBJ_NOT_FOUND The specified @c key has not been found in the map.
* @remarks The specific error code can be accessed using the GetLastResult() method.
* @see SetValue()
*/
virtual const Object* GetValue(const Object& key) const;
/**
- * Gets the value associated with the specified @c key.
+ * Gets the value associated to the specified @c key.
*
* @since 2.0
*
- * @return The value associated with the key, @n
+ * @return The value associated to the key, @n
* else @c null if an exception occurs
- * @param[in] key The key to locate
+ * @param[in] key The key to locate
* @exception E_SUCCESS The method is successful.
- * @exception E_INVALID_ARG A specified input parameter is invalid, or
- * the comparer has failed to compare the keys.
- * @exception E_OBJ_NOT_FOUND The specified @c key is not found in the map.
+ * @exception E_INVALID_ARG Either of the following conditions has occurred:
+ * - The specified input parameter is invalid.
+ * - The comparer has failed to compare the keys.
+ * @exception E_OBJ_NOT_FOUND The specified @c key has not been found in the map.
* @remarks The specific error code can be accessed using the GetLastResult() method.
* @see SetValue()
*/
virtual Object* GetValue(const Object& key);
/**
- * Gets a list of all the keys in a map.
+ * Gets the list of all the keys in the map.
*
* @since 2.0
*
- * @return A pointer to an IList object containing all the keys in the map, @n
+ * @return A pointer to the IList object containing all the keys in the map, @n
* else @c null if an exception occurs
- * @remarks The order of the keys is the same as the corresponding values in the IList interface returned by the GetValuesN() method.
- * The IList stores just the pointers to the elements in the map, not the elements themselves.
- * The specific error code can be accessed using the GetLastResult() method.
- * @see GetValuesN()
+ * @remarks
+ * - The order of the keys is the same as the corresponding values in the IList interface returned by the GetValuesN() method.
+ * - The IList stores just the pointers to the elements in the map and not the elements themselves.
+ * - The specific error code can be accessed using the GetLastResult() method.
*/
virtual IList* GetKeysN(void) const;
*
* @since 2.0
*
- * @return A pointer to an IList object containing all the values in the map, @n
+ * @return A pointer to the IList object that contains all the values in the map, @n
* else @c null if an exception occurs
- * @remarks The IList stores just the pointers to the elements in the map, not the elements themselves.
- * @remarks The specific error code can be accessed using the GetLastResult() method.
+ * @remarks
+ * - The IList stores just the pointers to the elements in the map and not the elements themselves.
+ * - The specific error code can be accessed using the GetLastResult() method.
* @see GetKeysN()
*/
virtual IList* GetValuesN(void) const;
/**
- * Removes the values associated with the specified @c key.
+ * Removes the values associated to the specified @c key.
*
* @since 2.0
*
* @return An error code
- * @param[in] key The key to remove
+ * @param[in] key The key to remove
* @exception E_SUCCESS The method is successful.
- * @exception E_INVALID_ARG The specified input parameter is invalid, or
- * the comparer has failed to compare keys.
- * @exception E_OBJ_NOT_FOUND The specified @c key is not found in the map.
+ * @exception E_INVALID_ARG Either of the following conditions has occurred:
+ * - The specified input parameter is invalid.
+ * - The comparer has failed to compare the keys.
+ * @exception E_OBJ_NOT_FOUND The specified @c key has not been found in the map.
* @see Add()
*/
virtual result Remove(const Object& key);
virtual void RemoveAll(void);
/**
- * Sets the value associated with the specified @c key by allocating it a new value.
+ * Sets the value associated to the specified @c key by allocating a new value to it.
*
* @since 2.0
*
* @return An error code
- * @param[in] key The key whose value is to replace
- * @param[in] pValue The pointer to new value to replace
+ * @param[in] key The key whose value is replaced
+ * @param[in] pValue A pointer to the new value to replace
* @exception E_SUCCESS The method is successful.
- * @exception E_INVALID_ARG A specified input parameter is invalid, or
- * the comparer has failed to compare keys.
- * @exception E_OBJ_NOT_FOUND The specified @c key is not found in the map.
+ * @exception E_INVALID_ARG Either of the following conditions has occurred:
+ * - A specified input parameter is invalid.
+ * - The comparer has failed to compare the keys.
+ * @exception E_OBJ_NOT_FOUND The specified @c key has not been found in the map.
* @remarks To add a new key-value pair, use the Add() method.
- * @see Add()
* @see GetValue()
*/
virtual result SetValue(const Object& key, Object* pValue);
*
* @return @c true if the map contains the specified @c key, @n
* else @c false
- * @param[in] key The key to locate
+ * @param[in] key The key to locate
* @exception E_SUCCESS The method is successful.
- * @exception E_INVALID_ARG The specified input parameter is invalid, or
- * the comparer has failed to compare the keys.
+ * @exception E_INVALID_ARG Either of the following conditions has occurred:
+ * - The specified input parameter is invalid.
+ * - The comparer has failed to compare the keys.
* @remarks The specific error code can be accessed using the GetLastResult() method.
* @see ContainsValue()
*/
virtual bool ContainsValue(const Object& value) const;
/**
- * Compares two instances of the %HashMap class.
+ * Compares two instances of %HashMap.
*
* @since 2.0
*
* @return @c true if the two instances match, @n
* else @c false
* @param[in] obj The object to compare with the current instance
- * @remarks This method returns @c true if and only if the two instances contain the same number of elements and all the elements contained in each other.
+ * @remarks This method returns @c true if and only if the two instances contain the same number of elements and all the elements are present in both of them.
*/
virtual bool Equals(const Object& obj) const;
* @since 2.0
*
* @return The hash value of the current instance
- * @remarks The two Tizen::Base::Object::Equals() instances must return the same hash value. For better performance, @n
- * the used hash function must generate a random distribution for all inputs.
+ * @remarks The two Tizen::Base::Object::Equals() instances must return the same hash value. @n
+ * For better performance, the used hash function must generate a random distribution for all the inputs.
*/
virtual int GetHashCode(void) const;
* The %HashMapT class provides a template-based collection of associated keys and values
* that are organized based on the hash code of the key.
* It contains unique keys and each key maps to one single value.
- * The key and value cannot be a null reference. Several methods in the %HashMapT class need assignment (=) operators of KeyType and ValueType.
+ * The key and value cannot be a @c null reference. Several methods in the %HashMapT class need the assignment (=) operators of the KeyType and the ValueType.
* @n
* For more information on the class features, see <a href="../org.tizen.native.appprogramming/html/guide/base/hashmap_multihashmap.htm">HashMap and MultiHashMap</a>.
*
* @param[in] capacity The initial capacity
* @param[in] loadFactor The maximum ratio of elements to buckets
* @exception E_SUCCESS The method is successful.
- * @exception E_INVALID_ARG A specified input parameter is invalid, or
- * the @c capacity or the @c loadFactor is negative.
+ * @exception E_INVALID_ARG Either of the following conditions has occurred:
+ * - A specified input parameter is invalid.
+ * - The specified @c capacity or the specified @c loadFactor is negative.
* @remarks To work properly, the key type must be of a primitive number type.
* @see HashMapT()
*/
* @since 2.0
*
* @return An error code
- * @param[in] map The map to copy
- * @param[in] loadFactor The maximum ratio of elements to buckets
+ * @param[in] map The map to copy
+ * @param[in] loadFactor The maximum ratio of elements to buckets
* @exception E_SUCCESS The method is successful.
- * @exception E_INVALID_ARG A specified input parameter is invalid, or
- * the @c loadFactor is negative.
- * @exception E_INVALID_OPERATION The current state of the instance prohibits the execution of the specified operation, or
- * the @c map is modified during the operation of this method.
+ * @exception E_INVALID_ARG Either of the following conditions has occurred:
+ * - A specified input parameter is invalid.
+ * - The specified @c loadFactor is negative.
+ * @exception E_INVALID_OPERATION Either of the following conditions has occurred:
+ * - The current state of the instance prohibits the execution of the specified operation.
+ * - The specified @c map is modified during the operation of this method.
* @see HashMapT()
*/
result Construct(const IMapT< KeyType, ValueType >& map, float loadFactor = 0.75)
}
/**
- * Initializes this instance of an empty %HashMapT class, with the specified initial capacity, load factor, hash code provider, and comparer.
+ * Initializes this instance of the empty %HashMapT, with the specified initial capacity, load factor, hash code provider, and comparer.
*
* @since 2.0
*
* @return An error code
- * @param[in] capacity The initial capacity @n
- * If it is @c 0, the default capacity (16) is used.
- * @param[in] loadFactor The maximum ratio of the elements to buckets @n
- * If it is @c 0, the default load factor (0.75) is used.
- * @param[in] provider An instance of the IHashCodeProviderT-derived class that supplies the hash codes
- * for all keys in this map
- * @param[in] comparer An instance of the IComparerT-derived class to use when comparing keys
+ * @param[in] capacity The initial capacity @n
+ * If it is @c 0, the default capacity (16) is used.
+ * @param[in] loadFactor The maximum ratio of the elements to buckets @n
+ * If it is @c 0, the default load factor (0.75) is used.
+ * @param[in] provider An instance of the IHashCodeProviderT-derived class that supplies the hash codes
+ * for all the keys in this map
+ * @param[in] comparer An instance of the IComparerT-derived class to use when comparing the keys
* @exception E_SUCCESS The method is successful.
- * @exception E_INVALID_ARG Either of the following conditions has occurred: @n
- * - A specified input parameter is invalid. @n
- * - The specified @c capacity is negative. @n
- * - The @c loadFactor is negative.
- * @remarks The instances of hash code provider and comparer will not be deallocated later from this map.
+ * @exception E_INVALID_ARG Either of the following conditions has occurred:
+ * - A specified input parameter is invalid.
+ * - The specified @c capacity is negative.
+ * - The specified @c loadFactor is negative.
+ * @remarks The instances of the hash code provider and the comparer are not deallocated later from this map.
* @see HashMapT()
*/
result Construct(int capacity, float loadFactor, const IHashCodeProviderT< KeyType >& provider,
* @since 2.0
*
* @return An error code
- * @param[in] map The map to copy
- * @param[in] loadFactor The maximum ratio of elements to buckets @n
- * If it is @c 0, the default load factor (0.75) is used.
- * @param[in] provider An instance of the IHashCodeProviderT-derived class that supplies the hash codes
- * for all keys in this map
- * @param[in] comparer An instance of the IComparerT-derived class to use when comparing keys
+ * @param[in] map The map to copy
+ * @param[in] loadFactor The maximum ratio of elements to buckets @n
+ * If it is @c 0, the default load factor (0.75) is used.
+ * @param[in] provider An instance of the IHashCodeProviderT-derived class that supplies the hash codes
+ * for all the keys in this map
+ * @param[in] comparer An instance of the IComparerT-derived class to use when comparing the keys
* @exception E_SUCCESS The method is successful.
- * @exception E_INVALID_ARG Either of the following conditions has occurred: @n
- * - A specified input parameter is invalid. @n
- * - The @c loadFactor is negative. @n
- * - The @c provider is a @c null or the @c comparer is a @c null.
- * @exception E_INVALID_OPERATION The current state of the instance prohibits the execution of the specified operation, or
- * the @c map is modified during the operation of this method.
- * @remarks The instances of hash code provider and comparer will not be deallocated later from this map.
+ * @exception E_INVALID_ARG Either of the following conditions has occurred:
+ * - A specified input parameter is invalid.
+ * - The specified @c loadFactor is negative.
+ * - Either the specified @c provider or the specified @c comparer is @c null.
+ * @exception E_INVALID_OPERATION Either of the following conditions has occurred:
+ * - The current state of the instance prohibits the execution of the specified operation.
+ * - The specified @c map is modified during the operation of this method.
+ * @remarks The instances of the hash code provider and the comparer are not deallocated later from this map.
* @see HashMapT()
*/
result Construct(const IMapT< KeyType, ValueType >& map, float loadFactor, const IHashCodeProviderT< KeyType >& provider,
}
/**
- * Adds the specified key-value pair to a map.
+ * Adds the specified key-value pair to the map.
*
* @since 2.0
*
* @return An error code
- * @param[in] key The key of the value to add
- * @param[in] value The value to add
+ * @param[in] key The key of the value to add
+ * @param[in] value The value to add
* @exception E_SUCCESS The method is successful.
- * @exception E_INVALID_ARG A specified input parameter is invalid, or
- * the comparer has failed to compare the keys.
+ * @exception E_INVALID_ARG Either of the following conditions has occurred:
+ * - A specified input parameter is invalid.
+ * - The comparer has failed to compare the keys.
* @exception E_OBJ_ALREADY_EXIST The specified @c key already exists.
* @see Remove()
*/
}
/**
- * Gets the elements of a map in an instance of the IMapEnumeratorT-derived class.
+ * Gets the elements of the map through an instance of the IMapEnumeratorT-derived class.
*
* @since 2.0
*
- * @return An instance of the IMapEnumeratorT-derived class if successful, @n
+ * @return An instance of the IMapEnumeratorT-derived class, @n
* else @c null if an exception occurs
* @exception E_SUCCESS The method is successful.
* @exception E_OUT_OF_MEMORY The memory is insufficient.
}
/**
- * Gets the elements of a map in an instance of the IMapEnumeratorT class.
+ * Gets the elements of the map through an instance of the IMapEnumeratorT class.
*
* @since 2.0
*
- * @return An instance of the IMapEnumeratorT class if successful, @n
+ * @return An instance of the IMapEnumeratorT class, @n
* else @c null if an exception occurs
* @exception E_SUCCESS The method is successful.
* @exception E_OUT_OF_MEMORY The memory is insufficient.
*
* @return The value associated with the key, @n
* else @c null if an exception occurs
- * @param[in] key The key to locate
- * @param[out] value The value associated with the key
+ * @param[in] key The key to locate
+ * @param[out] value The value associated with the @c key
* @exception E_SUCCESS The method is successful.
- * @exception E_INVALID_ARG A specified input parameter is invalid, or
- * The comparer has failed to compare the keys.
- * @exception E_OBJ_NOT_FOUND The specified @c key is not found in the map.
+ * @exception E_INVALID_ARG Either of the following conditions has occurred:
+ * - A specified input parameter is invalid.
+ * - The comparer has failed to compare the keys.
+ * @exception E_OBJ_NOT_FOUND The specified @c key has not been found in the map.
* @see SetValue()
*/
virtual result GetValue(const KeyType& key, ValueType& value) const
*
* @return The value associated with the key, @n
* else @c null if an exception occurs
- * @param[in] key The key to locate
- * @param[out] value The value associated with the key
+ * @param[in] key The key to locate
+ * @param[out] value The value associated with the @c key
* @exception E_SUCCESS The method is successful.
- * @exception E_INVALID_ARG A specified input parameter is invalid, or
- * the comparer has failed to compare the keys.
- * @exception E_OBJ_NOT_FOUND The specified @c key is not found in the map.
+ * @exception E_INVALID_ARG Either of the following conditions has occurred:
+ * - A specified input parameter is invalid.
+ * - The comparer has failed to compare the keys.
+ * @exception E_OBJ_NOT_FOUND The specified @c key has not been found in the map.
* @see SetValue()
*/
virtual result GetValue(const KeyType& key, ValueType& value)
}
/**
- * Gets a list of all the keys in a map.
+ * Gets the list of all the keys in the map.
*
* @since 2.0
*
- * @return A pointer to an IListT object containing all the keys in the map, @n
+ * @return A pointer to the IListT object that contains all the keys in the map, @n
* else @c null if an exception occurs
* @exception E_SUCCESS The method is successful.
* @exception E_OUT_OF_MEMORY The memory is insufficient.
- * @remarks The order of the keys is the same as the corresponding values in the IListT interface returned by the GetValuesN() method.
- * @remarks The specific error code can be accessed using the GetLastResult() method.
+ * @remarks
+ * - The order of the keys is the same as the corresponding values in the IListT interface returned by the GetValuesN() method.
+ * - The specific error code can be accessed using the GetLastResult() method.
* @see GetValuesN()
*/
virtual IListT< KeyType >* GetKeysN(void) const
}
/**
- * Gets all the values in a map.
+ * Gets all the values in the map.
*
* @since 2.0
*
- * @return A pointer to an IListT object containing all the values in the map, @n
+ * @return A pointer to the IListT object that contains all the values in the map, @n
* else @c null if an exception occurs
* @exception E_SUCCESS The method is successful.
* @exception E_OUT_OF_MEMORY The memory is insufficient.
}
/**
- * Removes the value associated with the specified @c key.
+ * Removes the value associated to the specified @c key.
*
* @since 2.0
*
* @return An error code
- * @param[in] key The key to remove
+ * @param[in] key The key to remove
* @exception E_SUCCESS The method is successful.
- * @exception E_INVALID_ARG The specified input parameter is invalid, or
- * the comparer has failed to compare the keys.
- * @exception E_OBJ_NOT_FOUND The specified @c key is not found in the map.
+ * @exception E_INVALID_ARG Either of the following conditions has occurred:
+ * - The specified input parameter is invalid.
+ * - The comparer has failed to compare the keys.
+ * @exception E_OBJ_NOT_FOUND The specified @c key has not been found in the map.
* @see Add()
*/
virtual result Remove(const KeyType& key)
}
/**
- * Removes all key-value pairs in the map.
+ * Removes all the key-value pairs in the map.
*
* @since 2.0
*/
* @since 2.0
*
* @return An error code
- * @param[in] key The key for which the value is to replace
- * @param[in] value The new value to replace
+ * @param[in] key The key whose value is replaced
+ * @param[in] value The new value to replace
* @exception E_SUCCESS The method is successful.
- * @exception E_INVALID_ARG A specified input parameter is invalid, or
- * the comparer has failed to compare the keys.
- * @exception E_OBJ_NOT_FOUND The specified @c key is not found in the map.
+ * @exception E_INVALID_ARG Either of the following conditions has occurred:
+ * - A specified input parameter is invalid.
+ * - The comparer has failed to compare the keys.
+ * @exception E_OBJ_NOT_FOUND The specified @c key has not been found in the map.
* @remarks Use the Add() method to add a new key-value pair.
- * @see Add()
* @see GetValue()
*/
virtual result SetValue(const KeyType& key, const ValueType& value)
}
/**
- * Gets the number of pairs currently stored in a map.
+ * Gets the number of pairs currently stored in the map.
*
* @since 2.0
*
}
/**
- * Checks whether a map contains the specified @c key.
+ * Checks whether the map contains the specified @c key.
*
* @since 2.0
*
* @return An error code
- * @param[in] key The key to locate
- * @param[out] out Set to @c true if the map contains the specified @c key, @n
- * else @c false
+ * @param[in] key The key to locate
+ * @param[out] out Set to @c true if the map contains the specified @c key, @n
+ * else @c false
* @exception E_SUCCESS The method is successful.
- * @exception E_INVALID_ARG A specified input parameter is invalid, or
- * the comparer has failed to compare the keys.
+ * @exception E_INVALID_ARG Either of the following conditions has occurred:
+ * - A specified input parameter is invalid.
+ * - The comparer has failed to compare the keys.
* @see ContainsValue()
*/
virtual result ContainsKey(const KeyType& key, bool& out) const
}
/**
- * Checks whether a map contains the specified @c value.
+ * Checks whether the map contains the specified @c value.
*
* @since 2.0
*
}
/**
- * Compares two instances of the %HashMapT class.
+ * Compares two instances of %HashMapT.
*
* @since 2.0
*
* @return @c true if the two instances match, @n
* else @c false
* @param[in] obj The object to compare with the current instance
- * @remarks This method returns @c true if and only if the two instances contain the same number of elements and all the elements of each other.
+ * @remarks This method returns @c true if and only if the two instances contain the same number of elements and all the elements are present in both of them.
*/
virtual bool Equals(const Object& obj) const
{
* @since 2.0
*
* @return The hash value of the current instance
- * @remarks The two Tizen::Base::Object::Equals() instances must return the same hash value. For better performance, @n
- * the used hash function must generate a random distribution for all inputs.
+ * @remarks The two Tizen::Base::Object::Equals() instances must return the same hash value. @n
+ * For better performance, the used hash function must generate a random distribution for all the inputs.
*/
virtual int GetHashCode(void) const
{
* @param[in] k The key to include in this entry
* @param[in] v The value to include in this entry
* @param[in] next A pointer to the next entry
- * @param[in] h A hash value of the key
+ * @param[in] h The hash value of the key
*/
__HashMapEntryT(const KeyType& k, const ValueType& v, __HashMapEntryT< KeyType, ValueType >* next, int h)
: key(k)
* @return An error code
* @param[out] obj The current object
* @exception E_SUCCESS The method is successful.
- * @exception E_INVALID_OPERATION The current state of the instance prohibits the execution of the specified operation. @n
- * This enumerator is currently positioned before the first element or
- * past the last element or the map is modified after this enumerator is created.
+ * @exception E_INVALID_OPERATION Either of the following conditions has occurred:
+ * - The current state of the instance prohibits the execution of the specified operation.
+ * - This enumerator is currently positioned before the first element or past the last element.
+ * - The map is modified after this enumerator is created.
*/
virtual result GetCurrent(MapEntryT< KeyType, ValueType >& obj) const
{
}
/**
- * Moves this enumerator to the next elements of the map.
+ * Moves this enumerator to the next element of the map.
* When this enumerator is first created, or when the Reset() method is called, or when the %MoveNext() method is first called, the enumerator positions itself to the first element in the map.
*
* @since 2.0
*
* @return An error code
* @exception E_SUCCESS The method is successful.
- * @exception E_INVALID_OPERATION The current state of the instance prohibits the execution of the specified operation, or
- * the map is modified after this enumerator is created.
+ * @exception E_INVALID_OPERATION Either of the following conditions has occurred:
+ * - The current state of the instance prohibits the execution of the specified operation.
+ * - The map is modified after this enumerator is created.
* @exception E_OUT_OF_RANGE The enumerator has passed the end of the map.
- * @see Reset()
*/
virtual result MoveNext(void)
{
}
/**
- * Positions the enumerator before the first element in a map.
+ * Positions the enumerator before the first element in the map.
*
* @since 2.0
*
* @return An error code
* @exception E_SUCCESS The method is successful.
- * @exception E_INVALID_OPERATION The current state of the instance prohibits the execution of the specified operation, or
- * the map is modified after this enumerator is created.
+ * @exception E_INVALID_OPERATION Either of the following conditions has occurred:
+ * - The current state of the instance prohibits the execution of the specified operation.
+ * - The map is modified after this enumerator is created.
*/
virtual result Reset(void)
{
}
/**
- * Gets the current key in a map.
+ * Gets the current key in the map.
*
* @since 2.0
*
* @return An error code
* @param[out] key The current key
* @exception E_SUCCESS The method is successful.
- * @exception E_INVALID_OPERATION The current state of the instance prohibits the execution of the specified operation. @n
- * This enumerator is currently positioned before the first element or
- * past the last element or the map is modified after this enumerator is created.
+ * @exception E_INVALID_OPERATION Either of the following conditions has occurred:
+ * - The current state of the instance prohibits the execution of the specified operation.
+ * - This enumerator is currently positioned before the first element or past the last element.
+ * - The map is modified after this enumerator is created.
*/
virtual result GetKey(KeyType& key) const
{
}
/**
- * Gets the current value in a map.
+ * Gets the current value in the map.
*
* @since 2.0
*
* @return An error code
- * @param[out] value The current value
+ * @param[out] value The current value
* @exception E_SUCCESS The method is successful.
- * @exception E_INVALID_OPERATION The current state of the instance prohibits the execution of the specified operation. @n
- * This enumerator is currently positioned before the first element or
- * past the last element or the map is modified after the enumerator is created.
+ * @exception E_INVALID_OPERATION Either of the following conditions has occurred:
+ * - The current state of the instance prohibits the execution of the specified operation.
+ * - This enumerator is currently positioned before the first element or past the last element
+ * - The map is modified after the enumerator is created.
*/
virtual result GetValue(ValueType& value) const
{
*
* @since 2.0
*
- * @remarks
- * An enumerator remains valid as long as the collection remains unchanged.
- * If changes are made to the collection, such as adding, modifying, or
- * deleting elements, the enumerator is irrecoverably invalidated. The next call to GetCurrent(), MoveNext(), MovePrevious(), Reset(), or ResetLast() fails (E_INVALID_OPERATION).
+ * @remarks An enumerator remains valid as long as the collection remains unchanged.@n
+ * If changes are made to the collection, such as adding, modifying, or
+ * deleting elements, the enumerator is irrecoverably invalidated. @n
+ * The next call to GetCurrent(), MoveNext(), MovePrevious(), Reset(), or ResetLast() fails (@c E_INVALID_OPERATION).
*
* The %IBidirectionalEnumerator interface supports a bidirectional iteration over a collection.
- * One can only access the elements in a collection through %IBidirectionalEnumerator. The elements cannot be modified through this interface.
+ * One can only access the elements in a collection through %IBidirectionalEnumerator. The elements cannot be modified through this interface.
*/
class _OSP_EXPORT_ IBidirectionalEnumerator
: public virtual IEnumerator
/**
* Moves %IBidirectionalEnumerator to the previous element of the collection. @n
- * A call to the MovePrevious() method after the ResetLast() method positions the enumerator to the last element in the collection.
+ * A call to the %MovePrevious() method after the ResetLast() method, positions the enumerator to the last element in the collection.
*
* @since 2.0
*
* @return An error code
* @exception E_SUCCESS The method is successful.
* @exception E_OUT_OF_RANGE The enumerator has passed the front of the collection.
- * @exception E_INVALID_OPERATION The current state of the instance prohibits the execution of the specified operation, or
- * the collection is modified after the enumerator is created.
+ * @exception E_INVALID_OPERATION Either of the following conditions has occurred:
+ * - The current state of the instance prohibits the execution of the specified operation.
+ * - The collection is modified after the enumerator is created.
* @see Tizen::Base::Collection::IEnumerator::MoveNext()
- * @see ResetLast()
*/
virtual result MovePrevious(void) = 0;
*
* @return An error code
* @exception E_SUCCESS The method is successful.
- * @exception E_INVALID_OPERATION The current state of the instance prohibits the execution of the specified operation, or
- * the collection is modified after the enumerator is created.
+ * @exception E_INVALID_OPERATION Either of the following conditions has occurred:
+ * - The current state of the instance prohibits the execution of the specified operation.
+ * - The collection is modified after the enumerator is created.
* @see Tizen::Base::Collection::IEnumerator::Reset()
* @see MovePrevious()
*/
*
* @since 2.0
*
- * @remarks
- * An enumerator remains valid as long as the collection remains unchanged.
- * If changes are made to the collection, such as adding, modifying, or
- * deleting elements, the enumerator is irrecoverably invalidated. The next call to GetCurrent(), MoveNext(), MovePrevious(), Reset(), or ResetLast() fails (E_INVALID_OPERATION).
+ * @remarks An enumerator remains valid as long as the collection remains unchanged.@n
+ * If changes are made to the collection, such as adding, modifying, or
+ * deleting elements, the enumerator is irrecoverably invalidated. @n
+ * The next call to GetCurrent(), MoveNext(), MovePrevious(), Reset(), or ResetLast() fails (@c E_INVALID_OPERATION).
*
* The %IBidirectionalEnumeratorT interface supports a bidirectional iteration over a collection.
* One can only access the elements in a collection through %IBidirectionalEnumeratorT. The elements cannot be modified through this interface.
* @return An error code
* @exception E_SUCCESS The method is successful.
* @exception E_OUT_OF_RANGE The enumerator has passed the front of the collection.
- * @exception E_INVALID_OPERATION The current state of the instance prohibits the execution of the specified operation, or
- * the collection is modified after the enumerator is created.
+ * @exception E_INVALID_OPERATION Either of the following conditions has occurred:
+ * - The current state of the instance prohibits the execution of the specified operation, or
+ * - The collection is modified after the enumerator is created.
* @see Tizen::Base::Collection::IEnumeratorT< Type >::MoveNext()
- * @see ResetLast()
*/
virtual result MovePrevious(void) = 0;
*
* @return An error code
* @exception E_SUCCESS The method is successful.
- * @exception E_INVALID_OPERATION The current state of the instance prohibits the execution of the specified operation, or
- * the collection is modified after the enumerator is created.
+ * @exception E_INVALID_OPERATION Either of the following conditions has occurred:
+ * - The current state of the instance prohibits the execution of the specified operation.
+ * - The collection is modified after the enumerator is created.
* @see Tizen::Base::Collection::IEnumeratorT< Type >::Reset()
* @see MovePrevious()
*/
/**
* @interface ICollection
* @brief This interface represents a collection of objects. @n
- * It defines the size, enumerators, and the synchronization mechanism of a collection.
+ * It defines the size, the enumerators, and the synchronization mechanism of a collection.
*
* @since 2.0
*
- * The %ICollection interface represents a collection of objects. It defines the size, enumerators, and the synchronization mechanism of a collection.
+ * The %ICollection interface represents a collection of objects. It defines the size, the enumerators, and the synchronization mechanism of a collection.
*
*/
class _OSP_EXPORT_ ICollection
*
* @since 2.0
*
- * @return An integer value indicating the number of objects currently stored in the collection
+ * @return The integer value that indicates the number of objects currently stored in the collection
*/
virtual int GetCount(void) const = 0;
/**
* Gets the enumerator of the %ICollection derived class,
- * or returns @c null if some exception occurs.
+ * or returns @c null if an exception occurs.
*
* @since 2.0
*
- * @return A pointer to an enumerator interface of the %ICollection derived class, @n
+ * @return A pointer to the enumerator interface of the %ICollection derived class, @n
* else @c null if an exception occurs
* @exception E_SUCCESS The method is successful.
* @exception E_OUT_OF_MEMORY The memory is insufficient.
- * @remarks Use this method to obtain an enumerator (an instance of the IEnumerator derived class)
+ * @remarks
+ * - Use this method to obtain an enumerator (an instance of the IEnumerator derived class)
* to iterate over a collection (an instance of the %ICollection derived class).
- * @remarks The specific error code can be accessed using GetLastResult() method.
- * @see Tizen::Base::Collection::IEnumerator
+ * - The specific error code can be accessed using GetLastResult() method.
*
*/
virtual IEnumerator* GetEnumeratorN(void) const = 0;
/**
* @interface ICollectionT
* @brief This interface represents a template-based collection of objects.
- * It defines the size, and enumerators.
+ * It defines the size, and the enumerators.
*
* @since 2.0
*
* The %ICollectionT interface represents a template-based collection of objects.
- * It defines the size, and enumerators.
+ * It defines the size, and the enumerators.
*/
template< class Type >
class ICollectionT
*
* @since 2.0
*
- * @return A pointer to an enumerator interface of the %ICollectionT derived class, @n
+ * @return A pointer to the enumerator interface of the %ICollectionT derived class, @n
* else @c null if an exception occurs
* @exception E_SUCCESS The method is successful.
* @exception E_OUT_OF_MEMORY The memory is insufficient.
- * @remarks Use this method to obtain an enumerator (an instance of the IEnumeratorT derived class)
+ * @remarks
+ * - Use this method to obtain the enumerator (an instance of the IEnumeratorT derived class)
* to iterate over a collection (an instance of the %ICollectionT derived class).
- * @remarks The specific error code can be accessed using the GetLastResult() method.
- * @see Tizen::Base::Collection::IEnumerator
+ * - The specific error code can be accessed using the GetLastResult() method.
*/
virtual IEnumeratorT< Type >* GetEnumeratorN(void) const = 0;
{
/**
* @interface IComparer
- * @brief This interface allows a derived class to compare 2 objects of the same type.
+ * @brief This interface allows a derived class to compare two objects of the same type.
*
* @since 2.0
*
- * The %IComparer interface allows a derived class to compare 2 objects of the same type.
+ * The %IComparer interface allows a derived class to compare two objects of the same type.
*/
class _OSP_EXPORT_ IComparer
{
* @return An error code
* @param[in] obj1 The first object to compare
* @param[in] obj2 The second object to compare
- * @param[out] cmp The result of comparison
+ * @param[out] cmp The result of the comparison
* @exception E_SUCCESS The method is successful.
* @exception E_INVALID_ARG The specified object instances are not of the expected type.
* @remarks The value of @c cmp can be:
*
* @code
- * < 0 if the value of @c obj1 is less than the value of @c obj2
- * == 0 if the value of @c obj1 is equal to the value of @c obj2
- * > 0 if the value of @c obj1 is greater than the value of @c obj2
+ * < 0 if the value of obj1 is less than the value of obj2
+ * == 0 if the value of obj1 is equal to the value of obj2
+ * > 0 if the value of obj1 is greater than the value of obj2
* @endcode
*/
virtual result Compare(const Tizen::Base::Object& obj1, const Tizen::Base::Object& obj2, int& cmp) const = 0;
{
/**
* @interface IComparerT
- * @brief This interface allows derived classes to compare 2 template-based objects of the same type.
+ * @brief This interface allows derived classes to compare two template-based objects of the same type.
*
* @since 2.0
*
- * The %IComparerT interface allows derived classes to compare 2 template-based objects of the
+ * The %IComparerT interface allows derived classes to compare two template-based objects of the
* same type.
*/
template< class Type >
* @return An error code
* @param[in] obj1 The first object to compare
* @param[in] obj2 The second object to compare
- * @param[out] cmp The result of comparison
+ * @param[out] cmp The result of the comparison
* @exception E_SUCCESS The method is successful.
* @exception E_INVALID_ARG The specified object instances are not of the expected type.
* @remarks The value of @c cmp can be:
*
* @code
- * < 0 if the value of @c obj1 is less than the value of @c obj2
- * == 0 if the value of @c obj1 is equal to the value of @c obj2
- * > 0 if the value of @c obj1 is greater than the value of @c obj2
+ * < 0 if the value of obj1 is less than the value of obj2
+ * == 0 if the value of obj1 is equal to the value of obj2
+ * > 0 if the value of obj1 is greater than the value of obj2
* @endcode
*/
virtual result Compare(const Type& obj1, const Type& obj2, int& cmp) const = 0;
*
* @since 2.0
*
- * @remarks
- * An enumerator remains valid as long as the collection remains unchanged.
- * If changes are made to the collection, such as adding, modifying, or
- * deleting elements, the enumerator is irrecoverably invalidated. The next call to GetCurrent(), MoveNext(), or Reset() fails and returns
- * E_INVALID_OPERATION.
+ * @remarks An enumerator remains valid as long as the collection remains unchanged. @n
+ * If changes are made to the collection, such as adding, modifying, or
+ * deleting elements, the enumerator is irrecoverably invalidated. @n
+ * The next call to GetCurrent(), MoveNext(), or Reset() fails and returns
+ * @c E_INVALID_OPERATION.
*
* The %IEnumerator interface supports simple iteration over a collection.
* One can only access the elements in a collection through %IEnumerator. The elements cannot be modified through this interface.
* @return The current object in the collection, @n
* else @c null if an exception occurs
* @exception E_SUCCESS The method is successful.
- * @exception E_INVALID_OPERATION Either of the following conditions has occurred: @n
- * - The current state of the instance prohibits the execution of the specified operation. @n
+ * @exception E_INVALID_OPERATION Either of the following conditions has occurred:
+ * - The current state of the instance prohibits the execution of the specified operation.
* - The enumerator is currently positioned before the first element
- * or after the last element. @n
+ * or after the last element.
* - The collection is modified after the enumerator is created.
* @remarks The specific error code can be accessed using the GetLastResult() method.
- * @see GetLastResult()
*/
virtual Tizen::Base::Object* GetCurrent(void) const = 0;
* @return An error code
* @exception E_SUCCESS The method is successful.
* @exception E_OUT_OF_RANGE The enumerator has passed the end of the collection.
- * @exception E_INVALID_OPERATION The current state of the instance prohibits the execution of the specified operation, or
- * the collection is modified after the enumerator is created.
- * @see Reset()
+ * @exception E_INVALID_OPERATION Either of the following conditions has occurred:
+ * - The current state of the instance prohibits the execution of the specified operation.
+ * - The collection is modified after the enumerator is created.
*/
virtual result MoveNext(void) = 0;
*
* @return An error code
* @exception E_SUCCESS The method is successful.
- * @exception E_INVALID_OPERATION The current state of the instance prohibits the execution of the specified operation, or
- * the collection is modified after the enumerator is created.
+ * @exception E_INVALID_OPERATION Either of the following conditions has occurred:
+ * - The current state of the instance prohibits the execution of the specified operation.
+ * - The collection is modified after the enumerator is created.
*/
virtual result Reset(void) = 0;
*
* @since 2.0
*
- * @remarks
- * An enumerator remains valid as long as the collection remains unchanged.
- * If changes are made to the collection, such as adding, modifying, or
- * deleting elements, the enumerator is irrecoverably invalidated. The next call to GetCurrent(), MoveNext(), or Reset() fails and returns
- * E_INVALID_OPERATION.
+ * @remarks An enumerator remains valid as long as the collection remains unchanged. @n
+ * If changes are made to the collection, such as adding, modifying, or
+ * deleting elements, the enumerator is irrecoverably invalidated. @n
+ * The next call to GetCurrent(), MoveNext(), or Reset() fails and returns
+ * @c E_INVALID_OPERATION.
*
* The %IEnumeratorT interface supports simple iteration over a template-based collection.
* One can only access the elements in a collection through %IEnumeratorT. The elements cannot be modified through this interface.
* @since 2.0
*
* @return An error code
- * @param[out] obj A pointer to the current object
+ * @param[out] obj A pointer to the current object
* @exception E_SUCCESS The method is successful.
- * @exception E_INVALID_OPERATION The current state of the instance prohibits the execution of the specified operation. @n
- * The enumerator is currently positioned before the first element or
- * after the last element or the collection is modified after the enumerator is created.
+ * @exception E_INVALID_OPERATION Either of the following conditions has occurred:
+ * - The current state of the instance prohibits the execution of the specified operation.
+ * - The enumerator is currently positioned before the first element or
+ * after the last element.
+ * - The collection is modified after the enumerator is created.
*/
virtual result GetCurrent(Type& obj) const = 0;
* @return An error code
* @exception E_SUCCESS The method is successful.
* @exception E_OUT_OF_RANGE The enumerator has passed the end of the collection.
- * @exception E_INVALID_OPERATION The current state of the instance prohibits the execution of the specified operation, or
- * the collection is modified after the enumerator is created.
- * @see Reset()
+ * @exception E_INVALID_OPERATION Either of the following conditions has occurred:
+ * - The current state of the instance prohibits the execution of the specified operation.
+ * - The collection is modified after the enumerator is created.
*/
virtual result MoveNext(void) = 0;
*
* @return An error code
* @exception E_SUCCESS The method is successful.
- * @exception E_INVALID_OPERATION The current state of the instance prohibits the execution of the specified operation, or
- * the collection is modified after the enumerator is created.
+ * @exception E_INVALID_OPERATION Either of the following conditions has occurred:
+ * - The current state of the instance prohibits the execution of the specified operation.
+ * - The collection is modified after the enumerator is created.
*/
virtual result Reset(void) = 0;
/**
* @interface IHashCodeProvider
- * @brief This interface represents classes that can provide the hash code of a specific type of object.
+ * @brief This interface represents classes that provide the hash code of a specific type of object.
*
* @since 2.0
*
- * The %IHashCodeProvider interface represents classes that can provide the hash code of a specific type of object.
+ * The %IHashCodeProvider interface represents classes that provide the hash code of a specific type of object.
*/
class _OSP_EXPORT_ IHashCodeProvider
{
* @since 2.0
*
* @return The hash code of the specified object
- * @param[in] obj A pointer to the object whose hash code is required
- * @remarks The hash algorithm is usually specific to a type.
- * Two equal instances must return the same hash value.
- * For better performance, the used hash function must generate a random distribution for all inputs.
+ * @param[in] obj A pointer to the object whose hash code is required
+ * @remarks
+ * - The hash algorithm is usually of a specific type.
+ * - Two equal instances must return the same hash value. @n
+ * For better performance, the used hash function must generate a random distribution for all the inputs.
*/
virtual int GetHashCode(const Tizen::Base::Object& obj) const = 0;
/**
* @interface IHashCodeProviderT
- * @brief This interface represents classes that can provide the hash code of a specific type of template-based object.
+ * @brief This interface represents classes that provide the hash code of a specific type of template-based object.
*
* @since 2.0
*
- * The %IHashCodeProviderT interface represents classes that can provide the hash code of a specific type of template-based object.
+ * The %IHashCodeProviderT interface represents classes that provide the hash code of a specific type of template-based object.
*
*/
template< class Type >
* @since 2.0
*
* @return The hash code of the specified object
- * @param[in] obj A pointer to the object for which the hash code is required
- * @remarks The hash algorithm is usually specific to a type. @n
- * Two equal instances must return the same hash value.
- * For better performance, the used hash function must generate a random distribution for all inputs.
+ * @param[in] obj A pointer to the object whose hash code is required
+ * @remarks
+ * - The hash algorithm is usually of a specific type.
+ * - Two equal instances must return the same hash value. @n
+ * For better performance, the used hash function must generate a random distribution for all the inputs.
*/
virtual int GetHashCode(const Type& obj) const = 0;
* Adds the specified object to the list.
*
* @brief <i> [Deprecated] </i>
- * @deprecated This method is deprecated because it has a problem of const reference argument.
+ * @deprecated This method is deprecated because it has a problem of constant reference argument.
* Instead of using this method, use Add(Object* pObj).
* @since 2.0
*
* @param[in] obj The object to add
* @exception E_SUCCESS The method is successful.
* @exception E_OUT_OF_MEMORY The memory is insufficient.
- * @remarks In a collection of contiguous elements, such as a list, the elements
- * that follow the insertion point move down to accommodate the new element.
+ * @remarks
+ * - In a collection of contiguous elements, such as a list, the elements
+ * that follow the insertion point move down to accommodate the new element. @n
* If the collection is indexed, the indexes of the elements that are moved
- * are also updated. This behavior does not apply to collections where
+ * are also updated. @n
+ * This behavior does not apply to collections where
* elements are conceptually grouped into buckets, such as a hashtable.
- * This method performs a shallow copy. It adds the pointer only; not the element itself.
+ * - This method performs a shallow copy. It adds just the pointer only and not the element itself.
* @see Remove()
* @endif
*/
* @since 2.0
*
* @return An error code
- * @param[in] pObj The pointer to object to add
+ * @param[in] pObj A pointer to the object to add
* @exception E_SUCCESS The method is successful.
* @exception E_INVALID_ARG The specified input parameter is invalid.
- * @remarks In a collection of contiguous elements, such as a list, the elements
- * that follow the insertion point move down to accommodate the new element.
+ * @remarks
+ * - In a collection of contiguous elements, such as a list, the elements
+ * that follow the insertion point move down to accommodate the new element. @n
* If the collection is indexed, the indexes of the elements that are moved
- * are also updated. This behavior does not apply to collections where
+ * are also updated. @n
+ * This behavior does not apply to collections where
* elements are conceptually grouped into buckets, such as a hashtable.
- * This method performs a shallow copy. It adds the pointer only; not the element itself.
+ * - This method performs a shallow copy. It adds just the pointer only and not the element itself.
* @see Remove()
*/
virtual result Add(Object* pObj) = 0;
/**
- * Adds the elements of the specified collection to the end of the list.
+ * Adds the elements of the specified @c collection to the end of the list.
*
* @since 2.0
*
* @return An error code
* @param[in] collection The collection to add to the list
* @exception E_SUCCESS The method is successful.
- * @exception E_INVALID_OPERATION The current state of the instance prohibits the execution of the specified operation, or
- * the specified @c collection is modified during the operation of this method.
- * @remarks This method performs a shallow copy. It adds the pointer only; not the element itself.
+ * @exception E_INVALID_OPERATION Either of the following conditions has occurred:
+ * - The current state of the instance prohibits the execution of the specified operation.
+ * - The specified @c collection is modified during the operation of this method.
+ * @remarks This method performs a shallow copy. It adds just the pointer only and not the element itself.
* @see RemoveItems()
*/
virtual result AddItems(const ICollection& collection) = 0;
/**
* Searches for an object in this list. @n
- * Gets the index of the object if found.
+ * Gets the @c index of the object if found.
*
* @since 2.0
*
* @return An error code
- * @param[in] obj The object to locate
- * @param[out] index The index of the object
+ * @param[in] obj The object to locate
+ * @param[out] index The index of the object
* @exception E_SUCCESS The method is successful.
- * @exception E_OBJ_NOT_FOUND The specified @c obj is not found.
+ * @exception E_OBJ_NOT_FOUND The specified @c obj has not been found.
*/
virtual result IndexOf(const Object& obj, int& index) const = 0;
* Inserts an object at the specified location in the list.
*
* @brief <i> [Deprecated] </i>
- * @deprecated This method is deprecated because it has a problem of const reference argument.
+ * @deprecated This method is deprecated because it has a problem of constant reference argument.
* Instead of using this method, use InsertAt(const Object* pObj, int index).
* @since 2.0
*
* @return An error code
- * @param[in] obj The object to insert
- * @param[in] index The index at which the object must be inserted
+ * @param[in] obj The object to insert
+ * @param[in] index The index at which the object is inserted
* @exception E_SUCCESS The method is successful.
- * @exception E_OUT_OF_RANGE The specified index is outside the bounds of the data structure, or
- * the @c index is greater than the number of elements in the list or less than @c 0.
- * @remarks If the @c index equals the number of elements in the list, the new element
+ * @exception E_OUT_OF_RANGE Either of the following conditions has occurred:
+ * - The specified @c index is outside the bounds of the data structure.
+ * - The specified @c index is greater than the number of elements in the list.
+ * - The specified @c index is less than @c 0.
+ * @remarks
+ * - If the @c index equals the number of elements in the list, the new element
* is added at the end of the list.
- * This method performs a shallow copy. It inserts the pointer only; not the element itself.
+ * - This method performs a shallow copy. It inserts just the pointer only and not the element itself.
* @see Add(Object*)
* @see RemoveAt()
* @endif
* @since 2.0
*
* @return An error code
- * @param[in] pObj The pointer to object to insert
- * @param[in] index The index at which the object must be inserted
+ * @param[in] pObj A pointer to the object to insert
+ * @param[in] index The index at which the object is inserted
* @exception E_SUCCESS The method is successful.
* @exception E_INVALID_ARG The specified input parameter is invalid.
- * @exception E_OUT_OF_RANGE The specified index is outside the bounds of the data structure, or
- * the @c index is greater than the number of elements in the list or less than @c 0.
- * @remarks If the @c index equals the number of elements in the list, the new element
+ * @exception E_OUT_OF_RANGE Either of the following conditions has occurred:
+ * - The specified index is outside the bounds of the data structure.
+ * - The specified @c index is greater than the number of elements in the list.
+ * - The specified @c index is less than @c 0.
+ * @remarks
+ * - If the @c index equals the number of elements in the list, the new element
* is added at the end of the list.
- * This method performs a shallow copy. It inserts the pointer only; not the element itself.
+ * - This method performs a shallow copy. It inserts just the pointer only and not the element itself.
* @see Add(Object*)
* @see RemoveAt()
*/
virtual result InsertAt(Object* pObj, int index) = 0;
/**
- * Searches for an object starting from the specified index. @n
- * Gets the index of the object if found.
+ * Searches for an object starting from the specified @c index. @n
+ * Gets the @c index of the object if found.
*
* @since 2.0
*
* @return An error code
- * @param[in] obj The object to locate
- * @param[in] startIndex The starting index for the search @n
- * It must be less than the number of elements.
- * @param[out] index The index of the object
+ * @param[in] obj The object to locate
+ * @param[in] startIndex The starting index for the search @n
+ * It must be less than the number of elements.
+ * @param[out] index The index of the object
* @exception E_SUCCESS The method is successful.
- * @exception E_OUT_OF_RANGE The specified index is outside the bounds of the data structure, or
- * the specified @c startIndex is either equal to or greater than the number of elements in the list or less than @c 0.
- * @exception E_OBJ_NOT_FOUND The specified @c obj is not found.
+ * @exception E_OUT_OF_RANGE Either of the following conditions has occurred:
+ * - The specified @c index is outside the bounds of the data structure.
+ * - The specified @c startIndex is either greater than or equal to the number of elements in the list.
+ * - The specified @c startIndex is less than @c 0.
+ * @exception E_OBJ_NOT_FOUND The specified @c obj has not been found.
* @see LastIndexOf()
*/
virtual result IndexOf(const Object& obj, int startIndex, int& index) const = 0;
/**
* Searches for an object within the specified range. @n
- * Gets the index of the object if found.
+ * Gets the @c index of the object if found.
*
* @since 2.0
*
* @return An error code
- * @param[in] obj The object to locate
- * @param[in] startIndex The starting index of the range
- * @param[in] count The number of elements to read
- * @param[out] index The index of the object
+ * @param[in] obj The object to locate
+ * @param[in] startIndex The starting index of the range
+ * @param[in] count The number of elements to read
+ * @param[out] index The index of the object
* @exception E_SUCCESS The method is successful.
- * @exception E_OUT_OF_RANGE Either of the following conditions has occurred: @n
- * - The specified index is outside the bounds of the data structure. @n
- * - The specified @c startIndex is either equal to or greater than the number of elements in the list or less than @c 0. @n
- * - The @c count is greater than the number of elements starting from @c startIndex
- * or less than @c 0.
- * @exception E_OBJ_NOT_FOUND The specified @c obj is not found.
+ * @exception E_OUT_OF_RANGE Either of the following conditions has occurred:
+ * - The specified @c index is outside the bounds of the data structure.
+ * - The specified @c startIndex is either greater than or equal to the number of elements in the list.
+ * - The specified @c startIndex is less than @c 0.
+ * - The specified @c count is greater than the number of elements starting from @c startIndex.
+ * - The specified @c count is less than @c 0.
+ * @exception E_OBJ_NOT_FOUND The specified @c obj has not been found.
* @see LastIndexOf()
*/
virtual result IndexOf(const Object& obj, int startIndex, int count, int& index) const = 0;
/**
- * Searches for the last occurrence of an object in this list. @n
- * Gets the index of the object if found.
+ * Searches for the last occurrence of an object in the list. @n
+ * Gets the @c index of the object if found.
*
* @since 2.0
*
* @return An error code
- * @param[in] obj The object to locate
- * @param[out] index The index of the last occurrence of the specified object
+ * @param[in] obj The object to locate
+ * @param[out] index The index of the last occurrence of the specified object
* @exception E_SUCCESS The method is successful.
- * @exception E_OBJ_NOT_FOUND The specified @c obj is not found.
+ * @exception E_OBJ_NOT_FOUND The specified @c obj has not been found.
* @see IndexOf()
*/
virtual result LastIndexOf(const Object& obj, int& index) const = 0;
* @since 2.0
*
* @return An error code
- * @param[in] collection The collection to insert
- * @param[in] startIndex The starting index at which the collection must be inserted
+ * @param[in] collection The collection to insert
+ * @param[in] startIndex The starting index at which the collection is inserted
* @exception E_SUCCESS The method is successful.
- * @exception E_OUT_OF_RANGE The specified index is outside the bounds of the data structure, or
- * the @c startIndex is greater than the number of elements in the list or less than @c 0.
- * @exception E_INVALID_OPERATION The current state of the instance prohibits the execution of the specified operation, or
- * the specified @c collection is modified during the operation of this method.
- * @remarks If the @c startIndex equals the number of elements in the list, the new elements
+ * @exception E_OUT_OF_RANGE Either of the following conditions has occurred:
+ * - The specified @c index is outside the bounds of the data structure.
+ * - The specified @c startIndex is greater than the number of elements in the list.
+ * - The specified @c startIndex is less than @c 0.
+ * @exception E_INVALID_OPERATION Either of the following conditions has occurred:
+ * - The current state of the instance prohibits the execution of the specified operation.
+ * - The specified @c collection is modified during the operation of this method.
+ * @remarks
+ * - If the @c startIndex is equal to the number of elements in the list, the new elements
* are added at the end of the list.
- * This method performs a shallow copy. It inserts just the pointer; not the element itself.
+ * - This method performs a shallow copy. It inserts just the pointer and not the element itself.
* @see RemoveItems()
* @see AddItems()
*/
* @since 2.0
*
* @return The object at the specified location, @n
- * else @c null if the @c index is not valid
- * @param[in] index The index of the object to get
+ * else @c null if the @c index invalid
+ * @param[in] index The index of the object to get
* @exception E_SUCCESS The method is successful.
- * @exception E_OUT_OF_RANGE The specified index is outside the bounds of the data structure, or
- * the specified @c index is either equal to or greater than the number of elements in the list or less than @c 0.
+ * @exception E_OUT_OF_RANGE Either of the following conditions has occurred:
+ * - The specified @c index is outside the bounds of the data structure.
+ * - The specified @c index is either greater than or equal to the number of elements in the list.
+ * - The specified @c index is less than @c 0.
* @remarks The specific error code can be accessed using the GetLastResult() method.
* @see SetAt()
*/
* @since 2.0
*
* @return The object at the specified location, @n
- * else @c null if the @c index is not valid
+ * else @c null if the @c index invalid
* @param[in] index The index of the object to get
* @exception E_SUCCESS The method is successful.
- * @exception E_OUT_OF_RANGE The specified index is outside the bounds of the data structure, or
- * the specified @c index is either equal to or greater than the number of elements in the list or less than @c 0.
+ * @exception E_OUT_OF_RANGE Either of the following conditions has occurred:
+ * - The specified @c index is outside the bounds of the data structure.
+ * - The specified @c index is either greater than or equal to the number of elements in the list.
+ * - The specified @c index is less than @c 0.
* @remarks The specific error code can be accessed using the GetLastResult() method.
* @see SetAt()
*/
*
* @since 2.0
*
- * @return A pointer to an %IList with elements lying within the specified range, @n
+ * @return A pointer to the %IList that contains elements lying within the specified range, @n
* else @c null if an exception occurs
- * @param[in] startIndex The starting index of the range
- * @param[in] count The number of elements to read
+ * @param[in] startIndex The starting index of the range
+ * @param[in] count The number of elements to read
* @exception E_SUCCESS The method is successful.
- * @exception E_OUT_OF_RANGE Either of the following conditions has occurred: @n
- * - The specified index is outside the bounds of the data structure. @n
- * - The specified @c startIndex is either equal to or greater than the number of elements in the list or less than @c 0. @n
- * - The @c count is greater than the number of elements in the list starting from @c startIndex
- * or less than @c 0.
- * @remarks The %IList stores just the pointers to the elements in the list, not the elements themselves.
- * The specific error code can be accessed using the GetLastResult() method.
+ * @exception E_OUT_OF_RANGE Either of the following conditions has occurred:
+ * - The specified @c index is outside the bounds of the data structure.
+ * - The specified @c startIndex is either greater than or equal to the number of elements in the list.
+ * - The specified @c startIndex is less than @c 0.
+ * - The specified @c count is greater than the number of elements in the list starting from @c startIndex.
+ * - The specified @c count is less than @c 0.
+ * @remarks
+ * - The %IList stores just the pointers to the elements in the list and not the elements themselves.
+ * - The specific error code can be accessed using the GetLastResult() method.
*/
virtual IList* GetItemsN(int startIndex, int count) const = 0;
* @since 2.0
*
* @return An error code
- * @param[in] obj The object to remove
+ * @param[in] obj The object to remove
* @param[in] forceDeletion Set to @c true to deallocate the object, @n
* else @c false
* @exception E_SUCCESS The method is successful.
- * @exception E_OBJ_NOT_FOUND The specified @c obj is not found.
+ * @exception E_OBJ_NOT_FOUND The specified @c obj has not been found.
* @remarks
- * - Based on the specified element deleter, the remove operation not only gets rid of an element from a list, but also deletes its object instance. @n
- * The element deleter style is recommended rather than using the @c forceDeletetion argument in the remove method. @n
- * If both an element deleter and forceDeleteion are set, the remove operation follows @c forceDeletion setting.
+ * - Based on the specified element deleter, the remove operation not only gets rid of an element from the list, but also deletes its object instance. @n
+ * The element deleter style is recommended rather than using @c forceDeletetion in the removing method. @n
+ * If both the element deleter and the @c forceDeletion are set, the remove operation follows the @c forceDeletion setting.
* - Remove(obj, @b true) internally works as the below code:
* @code
* DeleterFunctionType deleter = GetDeleter();
* @return An error code
* @param[in] obj The object to remove
* @exception E_SUCCESS The method is successful.
- * @exception E_OBJ_NOT_FOUND The specified @c obj is not found.
+ * @exception E_OBJ_NOT_FOUND The specified @c obj has not been found.
* @see Add(Object*)
* @see RemoveAt()
*/
* @since 2.0
*
* @return An error code
- * @param[in] index The index at which the object must be removed
- * @param[in] forceDeletion Set to @c true to deallocate the object, @n
- * else @c false
+ * @param[in] index The index at which the object is removed
+ * @param[in] forceDeletion Set to @c true to deallocate the object, @n
+ * else @c false
* @exception E_SUCCESS The method is successful.
- * @exception E_OUT_OF_RANGE The specified index is outside the bounds of the data structure, or
- * the specified @c index is either equal to or greater than the number of elements in the list or less than @c 0.
+ * @exception E_OUT_OF_RANGE Either of the following conditions has occurred:
+ * - The specified @c index is outside the bounds of the data structure.
+ * - The specified @c index is either greater than or equal to the number of elements in the list.
+ * - The specified @c index is less than @c 0.
* @remarks
- * - Based on the specified element deleter, the remove operation not only gets rid of an element from a list, but also deletes its object instance. @n
- * The element deleter style is recommended rather than using the @c forceDeletetion argument in the remove method. @n
- * If both an element deleter and forceDeleteion are set, the remove operation follows @c forceDeletion setting.
+ * - Based on the specified element deleter, the remove operation not only gets rid of an element from the list, but also deletes its object instance. @n
+ * The element deleter style is recommended rather than using @c forceDeletetion in the removing method. @n
+ * If both the element deleter and the @c forceDeletion are set, the remove operation follows the @c forceDeletion setting.
* - RemoveAt(index, @b true) internally works as the below code:
* @code
* DeleterFunctionType deleter = GetDeleter();
* @since 2.0
*
* @return An error code
- * @param[in] index The index at which the object must be removed
+ * @param[in] index The index at which the object is removed
* @exception E_SUCCESS The method is successful.
- * @exception E_OUT_OF_RANGE The specified index is outside the bounds of the data structure, or
- * the specified @c index is either equal to or greater than the number of elements in the list or less than @c 0.
+ * @exception E_OUT_OF_RANGE Either of the following conditions has occurred:
+ * - The specified index is outside the bounds of the data structure.
+ * - The specified @c index is either greater than or equal to the number of elements in the list.
+ * - The specified @c index is less than @c 0.
*/
virtual result RemoveAt(int index) = 0;
* @since 2.0
*
* @return An error code
- * @param[in] startIndex The starting index of the range
- * @param[in] count The number of elements in the range
- * @param[in] forceDeletion Set to @c true to deallocate the object, @n
- * else @c false
+ * @param[in] startIndex The starting index of the range
+ * @param[in] count The number of elements in the range
+ * @param[in] forceDeletion Set to @c true to deallocate the object, @n
+ * else @c false
* @exception E_SUCCESS The method is successful.
- * @exception E_OUT_OF_RANGE Either of the following conditions has occurred: @n
- * - The specified index is outside the bounds of the data structure. @n
- * - The specified @c startIndex is either equal to or greater than the number of elements in the list or less than @c 0. @n
- * - The @c count is greater than the number of elements starting from @c startIndex
- * or less than @c 0.
+ * @exception E_OUT_OF_RANGE Either of the following conditions has occurred:
+ * - The specified @c index is outside the bounds of the data structure.
+ * - The specified @c startIndex is either greater than or equal to the number of elements in the list.
+ * - The specified @c startIndex is less than @c 0.
+ * - The specified @c count is greater than the number of elements starting from @c startIndex.
+ * - The specified @c count is less than @c 0.
* @remarks
- * - Based on the specified element deleter, the remove operation not only gets rid of an element from a list, but also deletes its object instance. @n
- * The element deleter style is recommended rather than using the @c forceDeletetion argument in the remove method. @n
- * If both an element deleter and forceDeleteion are set, the remove operation follows @c forceDeletion setting.
+ * - Based on the specified element deleter, the remove operation not only gets rid of an element from the list, but also deletes its object instance. @n
+ * The element deleter style is recommended rather than using @c forceDeletetion in the removing method. @n
+ * If both the element deleter and the @c forceDeleteion are set, the remove operation follows the @c forceDeletion setting.
* - RemoveItems(startIndex, count, @b true) internally works as the below code:
* @code
* DeleterFunctionType deleter = GetDeleter();
* @since 2.0
*
* @return An error code
- * @param[in] startIndex The starting index of the range
- * @param[in] count The number of elements in the range
+ * @param[in] startIndex The starting index of the range
+ * @param[in] count The number of elements in the range
* @exception E_SUCCESS The method is successful.
- * @exception E_OUT_OF_RANGE Either of the following conditions has occurred: @n
- * - The specified index is outside the bounds of the data structure. @n
- * - The specified @c startIndex is either equal to or greater than the number of elements in the list or less than @c 0. @n
- * - The @c count is greater than the number of elements starting from @c startIndex
- * or less than @c 0.
+ * @exception E_OUT_OF_RANGE Either of the following conditions has occurred:
+ * - The specified @c index is outside the bounds of the data structure.
+ * - The specified @c startIndex is either greater than or equal to the number of elements in the list.
+ * - The specified @c startIndex is less than @c 0.
+ * - The specified @c count is greater than the number of elements starting from @c startIndex.
+ * - The specified @c count is less than @c 0.
* @see AddItems()
*/
virtual result RemoveItems(int startIndex, int count) = 0;
* @since 2.0
*
* @return An error code
- * @param[in] collection The collection to be removed from this list
+ * @param[in] collection The collection to remove from this list
* @param[in] forceDeletion Set to @c true to deallocate the object, @n
* else @c false
* @exception E_SUCCESS The method is successful.
- * @exception E_INVALID_OPERATION The current state of the instance prohibits the execution of the specified operation, or
- * the specified @c collection is modified during the operation of this method.
+ * @exception E_INVALID_OPERATION Either of the following conditions has occurred:
+ * - The current state of the instance prohibits the execution of the specified operation.
+ * - The specified @c collection is modified during the operation of this method.
* @remarks
- * - Based on the specified element deleter, the remove operation not only gets rid of an element from a list, but also deletes its object instance. @n
- * The element deleter style is recommended rather than using the @c forceDeletetion argument in the remove method. @n
- * If both an element deleter and forceDeleteion are set, the remove operation follows @c forceDeletion setting.
+ * - Based on the specified element deleter, the remove operation not only gets rid of an element from the list, but also deletes its object instance. @n
+ * The element deleter style is recommended rather than using @c forceDeletetion in the removing method. @n
+ * If both the element deleter and the @c forceDeleteion are set, the remove operation follows the @c forceDeletion setting.
* - RemoveItems(collection, @b true) internally works as the below code:
* @code
* DeleterFunctionType deleter = GetDeleter();
}
/**
- * Removes all the elements from the list that are common to the specified collection.
+ * Removes all the elements from the list that are common to the specified @c collection.
*
* @since 2.0
*
* @return An error code
* @param[in] collection The collection to remove from this list
* @exception E_SUCCESS The method is successful.
- * @exception E_INVALID_OPERATION The current state of the instance prohibits the execution of the specified operation, or
- * the specified @c collection is modified during the operation of this method.
+ * @exception E_INVALID_OPERATION Either of the following conditions has occurred:
+ * - The current state of the instance prohibits the execution of the specified operation.
+ * - The specified @c collection is modified during the operation of this method.
* @see Remove()
* @see RemoveAt()
*/
/**
* Removes all the object pointers in the collection. @n
- * If the deallocate param is set to @c true, it removes all the objects in the collection. @n
+ * If @c forceDeletion is set to @c true, it removes all the objects from the collection. @n
* This method can be called just before deleting the collection.
*
* @since 2.0
* @param[in] forceDeletion Set to @c true to deallocate all the objects, @n
* else @c false
* @remarks
- * - Based on the specified element deleter, the remove operation not only gets rid of an element from a list, but also deletes its object instance. @n
- * The element deleter style is recommended rather than using the @c forceDeletetion argument in the remove method. @n
- * If both an element deleter and forceDeleteion are set, the remove operation follows @c forceDeletion setting.
+ * - Based on the specified element deleter, the remove operation not only gets rid of an element from the list, but also deletes its object instance. @n
+ * The element deleter style is recommended rather than using @c forceDeletetion in the removing method. @n
+ * If both the element deleter and the @c forceDeleteion are set, the remove operation follows the @c forceDeletion setting.
* - RemoveAll(@b true) internally works as the below code:
* @code
* DeleterFunctionType deleter = GetDeleter();
}
/**
- * Removes all the object pointers in the collection. @n
+ * Removes all the object pointers from the collection. @n
* This method can be called just before deleting the collection.
*
* @since 2.0
virtual void RemoveAll(void) = 0;
/**
- * Replaces the object at the specified index with the specified object.
+ * Replaces the object at the specified @c index with the specified object.
*
* @since 2.0
*
* @return An error code
- * @param[in] obj The new object
- * @param[in] index The index at which the new object must be set
- * @param[in] forceDeletion Set to @c true to deallocate the object, @n
- * else @c false
+ * @param[in] obj The new object
+ * @param[in] index The index at which the new object is set
+ * @param[in] forceDeletion Set to @c true to deallocate the object, @n
+ * else @c false
* @exception E_SUCCESS The method is successful.
- * @exception E_OUT_OF_RANGE The specified index is outside the bounds of the data structure, or
- * the specified @c index is either equal to or greater than the number of elements in the list or less than @c 0.
+ * @exception E_OUT_OF_RANGE Either of the following conditions has occurred:
+ * - The specified @c index is outside the bounds of the data structure.
+ * - The specified @c index is either greater than or equal to the number of elements in the list.
+ * - The specified @c index is less than @c 0.
* @remarks
- * - Based on the specified element deleter, the set operation not only gets rid of an element from a list, but also deletes its object instance. @n
- * The element deleter style is recommended rather than using the @c forceDeletetion argument in the set method. @n
- * If both an element deleter and forceDeleteion are set, the set operation follows @c forceDeletion setting.
+ * - Based on the specified element deleter, the set operation not only gets rid of an element from the list, but also deletes its object instance. @n
+ * The element deleter style is recommended rather than using @c forceDeletetion in the set method. @n
+ * If both the element deleter and the @c forceDeleteion are set, the set operation follows the @c forceDeletion setting.
* - SetAt(obj, index, @b true) internally works as the below code:
* @code
* DeleterFunctionType deleter = GetDeleter();
}
/**
- * Replaces the object at the specified index with the specified object.
+ * Replaces the object at the specified @c index with the specified object.
*
* @since 2.0
*
* @return An error code
- * @param[in] pObj The pointer to new object
- * @param[in] index The index at which the new object must be set
+ * @param[in] pObj A pointer to the new object
+ * @param[in] index The index at which the new object is set
* @exception E_SUCCESS The method is successful.
- * @exception E_INVALID_ARG The specified input parameter is invalid.
- * @exception E_OUT_OF_RANGE The specified index is outside the bounds of the data structure, or
- * the specified @c index is either equal to or greater than the number of elements in the list or less than @c 0.
+ * @exception E_INVALID_ARG A specified input parameter is invalid.
+ * @exception E_OUT_OF_RANGE Either of the following conditions has occurred:
+ * - The specified index is outside the bounds of the data structure.
+ * - The specified @c index is either greater than or equal to the number of elements in the list.
+ * - The specified @c index is less than @c 0.
* @see GetAt()
*/
virtual result SetAt(Object* pObj, int index) = 0;
/**
- * Sorts the elements of this list using the comparer provided.
+ * Sorts the elements of the list using the @c comparer provided.
*
* @since 2.0
*
* @return An error code
- * @param[in] comparer The IComparer implementation to use when comparing elements
+ * @param[in] comparer The IComparer implementation to use when comparing the elements
* @exception E_SUCCESS The method is successful.
* @exception E_INVALID_ARG The specified input parameter is invalid.
*/
/**
* @if OSPDEPREC
- * Checks whether the list contains all the elements of the specified collection.
+ * Checks whether the list contains all the elements of the specified @c collection.
*
* @brief <i> [Deprecated] </i>
- * @deprecated This method is deprecated because it transfers a result of comparison in out-parameter form.
- * The return type will be changed into boolean type and this method will return the result.
+ * @deprecated This method is deprecated because it transfers the result of the comparison in an out-parameter form.
+ * The return type is changed to boolean and this method returns the result.
* Instead of using this method, use bool ContainsAll(const ICollection& collection).
* @since 2.0
*
* @return An error code
- * @param[in] collection The collection to check for containment in this list
- * @param[out] out Set to @c true if the list contains all the elements of the specified collection, @n
- * else @c false
+ * @param[in] collection The collection to check for containment in this list
+ * @param[out] out Set to @c true if the list contains all the elements of the specified collection, @n
+ * else @c false
* @exception E_SUCCESS The method is successful.
- * @exception E_INVALID_OPERATION The current state of the instance prohibits the execution of the specified operation, or
- * the specified @c collection is modified during the operation of this method.
- * @remarks If the given @c collection is empty, the @c out parameter is set to @c true.
+ * @exception E_INVALID_OPERATION Either of the following conditions has occurred:
+ * - The current state of the instance prohibits the execution of the specified operation.
+ * - The specified @c collection is modified during the operation of this method.
+ * @remarks If the given @c collection is empty, then @c out is set to @c true.
* @see Contains()
* @endif
*/
}
/**
- * Checks whether the list contains all the elements of the specified collection.
+ * Checks whether the list contains all the elements of the specified @c collection.
*
* @since 2.0
*
* @return @c true if the list contains all the elements of the specified collection, @n
- * else @c false
+ * else @c false
* @param[in] collection The collection to check for containment in this list
* @exception E_SUCCESS The method is successful.
- * @exception E_INVALID_OPERATION The current state of the instance prohibits the execution of the specified operation, or
- * the specified @c collection is modified during the operation of this method.
+ * @exception E_INVALID_OPERATION Either of the following conditions has occurred:
+ * - The current state of the instance prohibits the execution of the specified operation.
+ * - The specified @c collection is modified during the operation of this method.
* @remarks
* - The specific error code can be accessed using the GetLastResult() method.
- * - If the given @c collection is empty, this method will return @c true.
+ * - If the given @c collection is empty, this method returns @c true.
* @see Contains()
*/
virtual bool ContainsAll(const ICollection& collection) const = 0;
/**
- * Gets a bidirectional enumerator (an instance of the IBidirectionalEnumerator derived class) of this list.
+ * Gets the bidirectional enumerator (an instance of the IBidirectionalEnumerator derived class) of this list.
*
* @since 2.0
*
- * @return A pointer to a bidirectional enumerator interface of the %IList derived class, @n
+ * @return A pointer to the bidirectional enumerator interface of the %IList derived class, @n
* else @c null if an exception occurs
- * @remarks Use this method to obtain a bidirectional enumerator (an instance of the IBidirectionalEnumerator derived class)
+ * @remarks
+ * - Use this method to obtain a bidirectional enumerator (an instance of the IBidirectionalEnumerator derived class)
* to iterate over a collection (an instance of the %IList derived class).
- * The specific error code can be accessed using GetLastResult() method.
- * @see Tizen::Base::Collection::IBidirectionalEnumerator
+ * - The specific error code can be accessed using GetLastResult() method.
*/
virtual IBidirectionalEnumerator* GetBidirectionalEnumeratorN(void) const = 0;
/**
- * This method is for distinguishing between ArrayList and LinkedList.
+ * Checks whether the instance is an ArrayList or a LinkedList.
*
* @since 2.0
*
* @return @c true if it is an ArrayList, @n
- * else @c false if it is a LinkedList.
+ * else @c false if it is a LinkedList
*/
virtual bool IsRandomAccessible(void) const
{
* @return An error code
* @param[in] collection The collection to add
* @exception E_SUCCESS The method is successful.
- * @exception E_INVALID_OPERATION The current state of the instance prohibits the execution of the specified operation, or
- * the specified @c collection is modified during the operation of this method.
+ * @exception E_INVALID_OPERATION Either of the following conditions has occurred:
+ * - The current state of the instance prohibits the execution of the specified operation.
+ * - The specified @c collection is modified during the operation of this method.
* @see RemoveItems()
*/
virtual result AddItems(const ICollectionT< Type >& collection) = 0;
/**
* Searches for an object in this list. @n
- * Gets the index of the object if found.
+ * Gets the @c index of the object if found.
*
* @since 2.0
*
* @return An error code
- * @param[in] obj The object to locate
- * @param[out] index The index of the object
+ * @param[in] obj The object to locate
+ * @param[out] index The index of the object
* @exception E_SUCCESS The method is successful.
- * @exception E_OBJ_NOT_FOUND The specified @c obj is not found.
+ * @exception E_OBJ_NOT_FOUND The specified @c obj has not been found.
*/
virtual result IndexOf(const Type& obj, int& index) const = 0;
/**
- * Searches for an object starting from the specified index. @n
- * Gets the index of the object if found.
+ * Searches for an object starting from the specified @c startIndex. @n
+ * Gets the @c index of the object if found.
*
* @since 2.0
*
* @return An error code
- * @param[in] obj The object to locate
- * @param[in] startIndex The starting index for the search @n
- * It must be less than the number of elements.
- * @param[out] index The index of the object
+ * @param[in] obj The object to locate
+ * @param[in] startIndex The starting index for the search @n
+ * It must be less than the number of elements.
+ * @param[out] index The index of the object
* @exception E_SUCCESS The method is successful.
- * @exception E_OUT_OF_RANGE The specified index is outside the bounds of the data structure, or
- * the specified @c startIndex is either equal to or greater than the number of elements in the list or less than @c 0.
- * @exception E_OBJ_NOT_FOUND The specified @c obj is not found.
+ * @exception E_OUT_OF_RANGE Either of the following conditions has occurred:
+ * - The specified @c index is outside the bounds of the data structure.
+ * - The specified @c startIndex is either greater than or equal to the number of elements in the list.
+ * - The specified @c startIndex is less than @c 0.
+ * @exception E_OBJ_NOT_FOUND The specified @c obj has not been found.
* @see LastIndexOf()
*/
virtual result IndexOf(const Type& obj, int startIndex, int& index) const = 0;
/**
* Searches for an object within the specified range. @n
- * Gets the index of the object if found.
+ * Gets the @c index of the object if found.
*
* @since 2.0
*
* @return An error code
- * @param[in] obj The object to locate
- * @param[in] startIndex The starting index of the range
- * @param[in] count The number of elements to read
- * @param[out] index The index of the object
+ * @param[in] obj The object to locate
+ * @param[in] startIndex The starting index of the range
+ * @param[in] count The number of elements to read
+ * @param[out] index The index of the object
* @exception E_SUCCESS The method is successful.
- * @exception E_OUT_OF_RANGE Either of the following conditions has occurred: @n
- * - The specified index is outside the bounds of the data structure. @n
- * - The specified @c startIndex is either equal to or greater than the number of elements in the list or less than @c 0. @n
- * - The @c count is greater than the number of elements starting from @c startIndex
- * or less than @c 0.
- * @exception E_OBJ_NOT_FOUND The specified @c obj is not found.
+ * @exception E_OUT_OF_RANGE Either of the following conditions has occurred:
+ * - The specified @c index is outside the bounds of the data structure.
+ * - The specified @c startIndex is either greater than or equal to the number of elements in the list.
+ * - The specified @c startIndex is less than @c 0.
+ * - The specified @c count is greater than the number of elements starting from @c startIndex.
+ * - The specified @c count is less than @c 0.
+ * @exception E_OBJ_NOT_FOUND The specified @c obj has not been found.
* @see LastIndexOf()
*/
virtual result IndexOf(const Type& obj, int startIndex, int count, int& index) const = 0;
/**
* Searches for the last occurrence of an object in this list. @n
- * Gets the index of the object if found.
+ * Gets the @c index of the object if found.
*
* @since 2.0
*
* @return An error code
- * @param[in] obj The object to locate
- * @param[out] index The index of the last occurrence of the specified object
+ * @param[in] obj The object to locate
+ * @param[out] index The index of the last occurrence of the specified object
* @exception E_SUCCESS The method is successful.
- * @exception E_OBJ_NOT_FOUND The specified @c obj is not found.
+ * @exception E_OBJ_NOT_FOUND The specified @c obj has not been found.
* @see IndexOf()
*/
virtual result LastIndexOf(const Type& obj, int& index) const = 0;
* @since 2.0
*
* @return An error code
- * @param[in] obj The object to insert
- * @param[in] index The index at which the object must be inserted
+ * @param[in] obj The object to insert
+ * @param[in] index The index at which the object is inserted
* @exception E_SUCCESS The method is successful.
- * @exception E_OUT_OF_RANGE The specified index is outside the bounds of the data structure, or
- * the @c index is greater than the number of elements in the list or less than @c 0.
- * @remarks If the @c index equals the number of elements in the list, the new element
+ * @exception E_OUT_OF_RANGE Either of the following conditions has occurred:
+ * - The specified @c index is outside the bounds of the data structure.
+ * - The specified @c index is greater than the number of elements in the list.
+ * - The specified @c index is less than @c 0.
+ * @remarks If the @c index is equal to the number of elements in the list, the new element
* is added at the end of the list.
* @see Add()
* @see RemoveAt()
virtual result InsertAt(const Type& obj, int index) = 0;
/**
- * Inserts the elements of a collection in the list at the specified location.
+ * Inserts the elements of a collection at the specified location in the list.
*
* @since 2.0
*
* @return An error code
- * @param[in] collection The collection to insert
- * @param[in] startIndex The starting index at which the collection must be inserted
+ * @param[in] collection The collection to insert
+ * @param[in] startIndex The starting index at which the collection is inserted
* @exception E_SUCCESS The method is successful.
- * @exception E_OUT_OF_RANGE The specified index is outside the bounds of the data structure, or
- * the @c startIndex is greater than the number of elements in the list or less than @c 0.
- * @exception E_INVALID_OPERATION The current state of the instance prohibits the execution of the specified operation, or
- * the specified @c collection is modified during the operation of this method.
+ * @exception E_OUT_OF_RANGE Either of the following conditions has occurred:
+ * - The specified @c index is outside the bounds of the data structure.
+ * - The specified @c startIndex is greater than the number of elements in the list.
+ * - The specified @c startIndex is less than @c 0.
+ * @exception E_INVALID_OPERATION Either of the following conditions has occurred:
+ * - The current state of the instance prohibits the execution of the specified operation.
+ * - The specified @c collection is modified during the operation of this method.
* @remarks If the @c startIndex equals the number of elements in the list, the new elements
* are added at the end of the list.
* @see RemoveItems()
* @since 2.0
*
* @return An error code
- * @param[in] index The index of the object to get
- * @param[out] obj The object obtained from the list
+ * @param[in] index The index of the object to get
+ * @param[out] obj The object obtained from the list
* @exception E_SUCCESS The method is successful.
- * @exception E_OUT_OF_RANGE The specified index is outside the bounds of the data structure, or
- * the specified @c index is either equal to or greater than the number of elements in the list or less than @c 0.
+ * @exception E_OUT_OF_RANGE Either of the following conditions has occurred:
+ * - The specified @c index is outside the bounds of the data structure.
+ * - The specified @c index is either greater than or equal to the number of elements in the list.
+ * - The specified @c index is less than @c 0.
* @see SetAt()
*/
virtual result GetAt(int index, Type& obj) const = 0;
* @since 2.0
*
* @return An error code
- * @param[in] index The index of the object to get
- * @param[out] obj The object obtained from the list
+ * @param[in] index The index of the object to get
+ * @param[out] obj The object obtained from the list
* @exception E_SUCCESS The method is successful.
- * @exception E_OUT_OF_RANGE The specified index is outside the bounds of the data structure, or
- * the specified @c index is either equal to or greater than the number of elements in the list or less than @c 0.
+ * @exception E_OUT_OF_RANGE Either of the following conditions has occurred:
+ * - The specified @c index is outside the bounds of the data structure.
+ * - The specified @c index is either greater than or equal to the number of elements in the list.
+ * - The specified @c index is less than @c 0.
* @see SetAt()
*/
virtual result GetAt(int index, Type& obj) = 0;
*
* @since 2.0
*
- * @return A pointer to %IListT with elements lying within the specified range, @n
+ * @return A pointer to %IListT that contains the elements lying within the specified range, @n
* else @c null if an exception occurs
- * @param[in] startIndex The starting index of the range
- * @param[in] count The number of elements to read
+ * @param[in] startIndex The starting index of the range
+ * @param[in] count The number of elements to read
* @exception E_SUCCESS The method is successful.
- * @exception E_OUT_OF_RANGE Either of the following conditions has occurred: @n
- * - The specified index is outside the bounds of the data structure. @n
- * - The specified @c startIndex is either equal to or greater than the number of elements in the list or less than @c 0. @n
- * - The @c count is greater than the number of elements in the list starting from @c startIndex
- * or less than @c 0.
+ * @exception E_OUT_OF_RANGE Either of the following conditions has occurred:
+ * - The specified @c index is outside the bounds of the data structure.
+ * - The specified @c startIndex is either greater than or equal to the number of elements in the list.
+ * - The specified @c startIndex is less than @c 0.
+ * - The specified @c count is greater than the number of elements in the list starting from @c startIndex.
+ * - The specified @c count is less than @c 0.
* @remarks The specific error code can be accessed using the GetLastResult() method.
*/
virtual IListT< Type >* GetItemsN(int startIndex, int count) const = 0;
* @return An error code
* @param[in] obj The object to remove
* @exception E_SUCCESS The method is successful.
- * @exception E_OBJ_NOT_FOUND The object is not found.
+ * @exception E_OBJ_NOT_FOUND The specified @c obj has not been found.
*/
virtual result Remove(const Type& obj) = 0;
* @since 2.0
*
* @return An error code
- * @param[in] index The index at which the object must be removed
+ * @param[in] index The index at which the object is removed
* @exception E_SUCCESS The method is successful.
- * @exception E_OUT_OF_RANGE The specified index is outside the bounds of the data structure, or
- * the specified @c index is either equal to or greater than the number of elements in the list or less than @c 0.
+ * @exception E_OUT_OF_RANGE Either of the following conditions has occurred:
+ * - The specified @c index is outside the bounds of the data structure.
+ * - The specified @c index is either greater than or equal to the number of elements in the list.
+ * - The specified @c index is less than @c 0.
*/
virtual result RemoveAt(int index) = 0;
/**
- * Removes all the elements from the list that are common to the specified collection.
+ * Removes all the elements from the list that are common to the specified @c collection.
*
* @since 2.0
*
* @return An error code
* @param[in] collection The collection to remove from this list
* @exception E_SUCCESS The method is successful.
- * @exception E_INVALID_OPERATION The current state of the instance prohibits the execution of the specified operation, or
- * the specified @c collection is modified during the operation of this method.
+ * @exception E_INVALID_OPERATION Either of the following conditions has occurred:
+ * - The current state of the instance prohibits the execution of the specified operation.
+ * - The specified @c collection is modified during the operation of this method.
* @see Remove()
* @see RemoveAt()
*/
* @since 2.0
*
* @return An error code
- * @param[in] startIndex The starting index of the range
- * @param[in] count The number of elements in the range
+ * @param[in] startIndex The starting index of the range
+ * @param[in] count The number of elements in the range
* @exception E_SUCCESS The method is successful.
- * @exception E_OUT_OF_RANGE Either of the following conditions has occurred: @n
- * - The specified index is outside the bounds of the data structure. @n
- * - The specified @c startIndex is either equal to or greater than the number of elements in the list or less than @c 0. @n
- * - The @c count is greater than the number of elements starting from @c startIndex
- * or less than @c 0.
+ * @exception E_OUT_OF_RANGE Either of the following conditions has occurred:
+ * - The specified @c index is outside the bounds of the data structure.
+ * - The specified @c startIndex is either greater than or equal to the number of elements in the list.
+ * - The specified @c startIndex is less than @c 0.
+ * - The specified @c count is greater than the number of elements starting from @c startIndex.
+ * - The specified @c count is less than @c 0.
* @see AddItems()
* @see InsertItemsFrom()
*/
virtual result RemoveItems(int startIndex, int count) = 0;
/**
- * Removes all the elements in the list.
+ * Removes all the elements from the list.
*
* @since 2.0
*/
virtual void RemoveAll(void) = 0;
/**
- * Sets the object at the specified index with the specified object.
+ * Sets the object at the specified @c index with the specified object.
*
* @since 2.0
*
* @return An error code
- * @param[in] obj The new object
- * @param[in] index The index at which the new object must be set
+ * @param[in] obj The new object
+ * @param[in] index The index at which the new object is set
* @exception E_SUCCESS The method is successful.
- * @exception E_OUT_OF_RANGE The specified index is outside the bounds of the data structure, or
- * the specified @c index is either equal to or greater than the number of elements in the list or less than @c 0.
+ * @exception E_OUT_OF_RANGE Either of the following conditions has occurred:
+ * - The specified @c index is outside the bounds of the data structure.
+ * - The specified @c index is either greater than or equal to the number of elements in the list.
+ * - The specified @c index is less than @c 0.
* @see GetAt()
*/
virtual result SetAt(const Type& obj, int index) = 0;
/**
- * Sorts the elements of this list using the comparer provided.
+ * Sorts the elements of this list using the @c comparer provided.
*
* @since 2.0
*
* @return An error code
- * @param[in] comparer The IComparerT implementation to use when comparing elements
+ * @param[in] comparer The IComparerT implementation to use when comparing the elements
* @exception E_SUCCESS The method is successful.
* @exception E_INVALID_ARG The specified input parameter is invalid.
*/
virtual bool Contains(const Type& obj) const = 0;
/**
- * Checks whether the list contains all the elements of the specified collection.
+ * Checks whether the list contains all the elements of the specified @c collection.
*
* @since 2.0
*
* @return An error code
- * @param[in] collection The collection to check for containment in this list
- * @param[out] out Set to @c true if the list contains all the elements of the specified collection, @n
- * else @c false
+ * @param[in] collection The collection to check for containment in this list
+ * @param[out] out Set to @c true if the list contains all the elements of the specified collection, @n
+ * else @c false
* @exception E_SUCCESS The method is successful.
- * @exception E_INVALID_OPERATION The current state of the instance prohibits the execution of the specified operation, or
- * the specified @c collection is modified during the operation of this method.
- * @remarks If the given @c collection is empty, the @c out parameter is set to @c true.
+ * @exception E_INVALID_OPERATION Either of the following conditions has occurred:
+ * - The current state of the instance prohibits the execution of the specified operation.
+ * - The specified @c collection is modified during the operation of this method.
+ * @remarks If the given @c collection is empty, then @c out is set to @c true.
* @see Contains()
*/
virtual result ContainsAll(const ICollectionT< Type >& collection, bool& out) const = 0;
/**
- * Gets a bidirectional enumerator (an instance of the IBidirectionalEnumeratorT derived class) of this list.
+ * Gets the bidirectional enumerator (an instance of the IBidirectionalEnumeratorT derived class) of this list.
*
* @since 2.0
*
- * @return A pointer to a bidirectional enumerator interface of the %IListT derived class, @n
+ * @return A pointer to the bidirectional enumerator interface of the %IListT derived class, @n
* else @c null if an exception occurs
* @exception E_SUCCESS The method is successful.
* @exception E_OUT_OF_MEMORY The memory is insufficient.
- * @remarks Use this method to obtain a bidirectional enumerator (an instance of the IBidirectionalEnumeratorT derived class)
- * to iterate over a collection (an instance of the %IListT derived class).
- * @remarks The specific error code can be accessed using the GetLastResult() method.
- * @see Tizen::Base::Collection::IBidirectionalEnumeratorT
+ * @remarks
+ * - Use this method to obtain a bidirectional enumerator (an instance of the IBidirectionalEnumeratorT derived class)
+ * to iterate over a collection (an instance of the %IListT derived class).
+ * - The specific error code can be accessed using the GetLastResult() method.
*/
virtual IBidirectionalEnumeratorT< Type >* GetBidirectionalEnumeratorN(void) const = 0;
*
* @since 2.0
*
- * The %IMap interface abstracts a collection of key-value pairs. An %IMap instance
+ * The %IMap interface represents a collection of key-value pairs. An %IMap instance
* contains unique keys and each key maps to a single value.
* The key and value cannot be a @c null reference.
*
* Adds the specified key-value pair to the map.
*
* @brief <i> [Deprecated] </i>
- * @deprecated This method is deprecated because it has a problem of const reference argument.
+ * @deprecated This method is deprecated because it has a problem of constant reference argument.
* Instead of using this method, use Add(Object* pKey, Object* pValue).
* @since 2.0
*
* @return An error code
- * @param[in] key The key to add
- * @param[in] value The corresponding value to add
+ * @param[in] key The key to add
+ * @param[in] value The corresponding value to add
* @exception E_SUCCESS The method is successful.
- * @exception E_INVALID_ARG A specified input parameter is invalid, or
- * the comparer has failed to compare the keys.
+ * @exception E_INVALID_ARG Either of the following conditions has occurred:
+ * - A specified input parameter is invalid.
+ * - The comparer has failed to compare the keys.
* @exception E_OBJ_ALREADY_EXIST The specified @c key already exists.
- * @remarks This method performs a shallow copy. It adds just the pointer; not the element itself.
+ * @remarks This method performs a shallow copy. It adds just the pointer and not the element itself.
* @see Remove()
* @endif
*/
* @since 2.0
*
* @return An error code
- * @param[in] pKey The pointer to key to add
- * @param[in] pValue The pointer to corresponding value to add
+ * @param[in] pKey A pointer to the key to add
+ * @param[in] pValue A pointer to the corresponding value to add
* @exception E_SUCCESS The method is successful.
- * @exception E_INVALID_ARG A specified input parameter is invalid, or
- * the comparer has failed to compare the keys.
+ * @exception E_INVALID_ARG Either of the following conditions has occurred:
+ * - A specified input parameter is invalid.
+ * - The comparer has failed to compare the keys.
* @exception E_OBJ_ALREADY_EXIST The specified @c pKey already exists.
- * @remarks This method performs a shallow copy. It adds just the pointer; not the element itself.
+ * @remarks This method performs a shallow copy. It adds just the pointer and not the element itself.
* @see Remove()
*/
virtual result Add(Object* pKey, Object* pValue) = 0;
/**
- * Checks if the key exists. If the key does not exist, Add() is called. Unless, SetValue() is called.
+ * Checks whether the key exists. If the key does not exist, the Add() method is called. Unless, the SetValue() method is called.
*
* @since 2.0
*
* @return An error code
- * @param[in] pKey The pointer to key to add
- * @param[in] pValue The pointer to corresponding value to add
+ * @param[in] pKey A pointer to the key to add
+ * @param[in] pValue A pointer to the corresponding value to add
* @exception E_SUCCESS The method is successful.
- * @exception E_INVALID_ARG A specified input parameter is invalid, or
- * the comparer has failed to compare the keys.
- * @remarks This method performs a shallow copy. It adds just the pointer; not the element itself.
+ * @exception E_INVALID_ARG Either of the following conditions has occurred:
+ * - A specified input parameter is invalid.
+ * - The comparer has failed to compare the keys.
+ * @remarks This method performs a shallow copy. It adds just the pointer and not the element itself.
* @see Add(Object*, Object*)
* @see SetValue()
*/
}
/**
- * Gets the value associated with the specified key.
+ * Gets the value associated to the specified @c key.
*
* @since 2.0
*
- * @return The value associated with the specified key, @n
+ * @return The value associated to the specified key, @n
* else @c null if an exception occurs
- * @param[in] key The key to find the associated value
+ * @param[in] key The key used to find the associated value
* @exception E_SUCCESS The method is successful.
- * @exception E_INVALID_ARG The specified input parameter is invalid, or
- * the comparer has failed to compare the keys.
- * @exception E_OBJ_NOT_FOUND The specified @c key is not found in the map.
+ * @exception E_INVALID_ARG Either of the following conditions has occurred:
+ * - The specified input parameter is invalid.
+ * - The comparer has failed to compare the keys.
+ * @exception E_OBJ_NOT_FOUND The specified @c key has not been found in the map.
* @remarks The specific error code can be accessed using the GetLastResult() method.
* @see SetValue()
*/
virtual const Object* GetValue(const Object& key) const = 0;
/**
- * Gets the value associated with the specified key.
+ * Gets the value associated to the specified @c key.
*
* @since 2.0
*
- * @return The value associated with the specified key, @n
+ * @return The value associated to the specified key, @n
* else @c null if an exception occurs
- * @param[in] key The key to find the associated value
+ * @param[in] key The key used to find the associated value
* @exception E_SUCCESS The method is successful.
- * @exception E_INVALID_ARG The specified input parameter is invalid, or
- * the comparer has failed to compare the keys.
- * @exception E_OBJ_NOT_FOUND The specified @c key is not found in the map.
+ * @exception E_INVALID_ARG Either of the following conditions has occurred:
+ * - The specified input parameter is invalid.
+ * - The comparer has failed to compare the keys.
+ * @exception E_OBJ_NOT_FOUND The specified @c key has not been found in the map.
* @remarks The specific error code can be accessed using the GetLastResult() method.
* @see SetValue()
*/
*
* @since 2.0
*
- * @return A pointer to a list of all the keys in the map, @n
+ * @return A pointer to the list of all the keys in the map, @n
* else @c null if an exception occurs
* @remarks
* - The order of the keys is the same as the corresponding values in the IList interface returned by the GetValuesN() method.
- * - The %IList interface stores just the pointers to the elements in the map, not the elements themselves.
+ * - The %IList interface stores just the pointers to the elements in the map and not the elements themselves.
* - The specific error code can be accessed using the GetLastResult() method.
- * @see GetValuesN()
*/
virtual IList* GetKeysN(void) const = 0;
/**
- * Gets a list of all the values in the map.
+ * Gets the list of all the values in the map.
*
* @since 2.0
*
- * @return A pointer to a list of all the values in the map, @n
+ * @return A pointer to the list of all the values in the map, @n
* else @c null if an exception occurs
* @remarks
- * - The IList stores just the pointers to the elements in the map, not the elements themselves.
+ * - The IList interface stores just the pointers to the elements in the map and not the elements themselves.
* - The specific error code can be accessed using the GetLastResult() method.
* @see GetKeysN()
*/
virtual IList* GetValuesN(void) const = 0;
/**
- * Removes the value associated with the specified key.
+ * Removes the value associated to the specified @c key.
*
* @since 2.0
*
* @return An error code
- * @param[in] key The key to remove
- * @param[in] forceDeletion Set to @c true to deallocate the object, @n
- * else @c false
+ * @param[in] key The key to remove
+ * @param[in] forceDeletion Set to @c true to deallocate the object, @n
+ * else @c false
* @exception E_SUCCESS The method is successful.
- * @exception E_INVALID_ARG A specified input parameter is invalid, or
- * the comparer has failed to compare the keys.
- * @exception E_OBJ_NOT_FOUND The specified @c key is not found in the map.
+ * @exception E_INVALID_ARG Either of the following conditions has occurred:
+ * - A specified input parameter is invalid.
+ * - The comparer has failed to compare the keys.
+ * @exception E_OBJ_NOT_FOUND The specified @c key has not been found in the map.
* @remarks
- * - Based on the specified element deleter, the remove operation not only gets rid of an element from a list, but also deletes its object instance. @n
- * The element deleter style is recommended rather than using the @c forceDeletetion argument in the remove method. @n
- * If both an element deleter and forceDeleteion are set, the remove operation follows @c forceDeletion setting.
+ * - Based on the specified element deleter, the remove operation not only gets rid of an element from the list, but also deletes its object instance. @n
+ * The element deleter style is recommended rather than using @c forceDeletetion in the removing method. @n
+ * If both the element deleter and the @c forceDeletion are set, the remove operation follows the @c forceDeletion setting.
* - Remove(key, @b true) internally works as the below code:
* @code
* DeleterFunctionType deleter = GetDeleter();
}
/**
- * Removes the value associated with the specified key.
+ * Removes the value associated to the specified @c key.
*
* @since 2.0
*
* @return An error code
- * @param[in] key The key for which the value is to remove
+ * @param[in] key The key for which the value is removed
* @exception E_SUCCESS The method is successful.
- * @exception E_INVALID_ARG A specified input parameter is invalid, or
- * the comparer has failed to compare the keys.
- * @exception E_OBJ_NOT_FOUND The specified @c key is not found in the map.
+ * @exception E_INVALID_ARG Either of the following conditions has occurred:
+ * - The specified input parameter is invalid.
+ * - The comparer has failed to compare the keys.
+ * @exception E_OBJ_NOT_FOUND The specified @c key has not been found in the map.
* @see Add(Object*, Object*)
*/
virtual result Remove(const Object& key) = 0;
/**
* Removes all the object pointers in the collection. @n
- * If the @c forceDeletion parameter is set to @c true, the method also removes all the objects. This method can be called before deleting the collection.
+ * If @c forceDeletion is set to @c true, the method also removes all the objects. The %RemoveAll() method can be called before deleting the collection.
*
* @since 2.0
*
* @param[in] forceDeletion Set to @c true to deallocate all the objects, @n
* else @c false
* @remarks
- * - Based on the specified element deleter, the remove operation not only gets rid of an element from a list, but also deletes its object instance. @n
- * The element deleter style is recommended rather than using the @c forceDeletetion argument in the remove method. @n
- * If both an element deleter and forceDeleteion are set, the remove operation follows @c forceDeletion setting.
+ * - Based on the specified element deleter, the remove operation not only gets rid of an element from the list, but also deletes its object instance. @n
+ * The element deleter style is recommended rather than using @c forceDeletetion in the removing method. @n
+ * If both the element deleter and the @c forceDeletion are set, the remove operation follows the @c forceDeletion setting.
* - RemoveAll(@b true) internally works as the below code:
* @code
* DeleterFunctionType deleter = GetDeleter();
}
/**
- * Removes all the object pointers in the collection. @n
+ * Removes all the object pointers from the collection. @n
*
* @since 2.0
*/
virtual void RemoveAll(void) = 0;
/**
- * Replaces the value associated with the specified key with the specified value.
+ * Replaces the value associated to the specified @c key with the specified @c value.
*
* @since 2.0
*
* @return An error code
- * @param[in] key The key for which the value is to replace
- * @param[in] value The new value
+ * @param[in] key The key for which the value is replaced
+ * @param[in] value The new value
* @param[in] forceDeletion Set to @c true to deallocate the object, @n
* else @c false
- * @exception E_SUCCESS The method is successful.
- * @exception E_INVALID_ARG A specified input parameter is invalid, or
- * the comparer has failed to compare the keys.
- * @exception E_OBJ_NOT_FOUND The specified @c key is not found in the map.
+ * @exception E_SUCCESS The method is successful.
+ * @exception E_INVALID_ARG Either of the following conditions has occurred:
+ * - A specified input parameter is invalid.
+ * - The comparer has failed to compare the keys.
+ * @exception E_OBJ_NOT_FOUND The specified @c key has not been found in the map.
* @remarks
* - Use the Add(Object*, Object*) method to add a new key-value pair.
- * - Based on the specified element deleter, the set operation not only gets rid of an element from a list, but also deletes its object instance. @n
- * The element deleter style is recommended rather than using the @c forceDeletetion argument in the set method. @n
- * If both an element deleter and forceDeleteion are set, the set operation follows @c forceDeletion setting.
+ * - Based on the specified element deleter, the set operation not only gets rid of an element from the list, but also deletes its object instance. @n
+ * The element deleter style is recommended rather than using @c forceDeletetion in the set method. @n
+ * If both the element deleter and the @c forceDeletion are set, the set operation follows the @c forceDeletion setting.
* - SetValue(key, value, @b true) internally works as the below code:
* @code
* DeleterFunctionType deleter = GetDeleter();
}
/**
- * Replaces the value associated with the specified key with the specified value.
+ * Replaces the value associated to the specified @c key with the specified @c value.
*
* @since 2.0
*
* @return An error code
- * @param[in] key The key for which the value is to replace
- * @param[in] pValue The pointer to new value
+ * @param[in] key The key for which the value is replaced
+ * @param[in] pValue A pointer to the new value
* @exception E_SUCCESS The method is successful.
- * @exception E_INVALID_ARG A specified input parameter is invalid, or
- * the comparer has failed to compare the keys.
- * @exception E_OBJ_NOT_FOUND The specified @c key is not found in the map.
+ * @exception E_INVALID_ARG Either of the following conditions has occurred:
+ * - A specified input parameter is invalid.
+ * - The comparer has failed to compare the keys.
+ * @exception E_OBJ_NOT_FOUND The specified @c key has not been found in the map.
* @remarks Use the Add(Object*, Object*) method to add a new key-value pair.
* @see GetValue()
*/
/**
* @if OSPDEPREC
- * Checks whether the map contains the specified key.
+ * Checks whether the map contains the specified @c key.
*
* @brief <i> [Deprecated] </i>
- * @deprecated This method is deprecated because it transfers a result of comparison in out-parameter form.
- * The return type will be changed into boolean type and this method will return the result.
+ * @deprecated This method is deprecated because it transfers the result of the comparison in an out-parameter form.
+ * The return type is changed into boolean and this method returns the result.
* Instead of using this method, use bool ContainsKey(const Object& key).
* @since 2.0
*
* @return An error code
- * @param[in] key The key to locate
- * @param[out] out Set to @c true if the map contains the specified key, @n
- * else @c false
+ * @param[in] key The key to locate
+ * @param[out] out Set to @c true if the map contains the specified key, @n
+ * else @c false
* @exception E_SUCCESS The method is successful.
- * @exception E_INVALID_ARG A specified input parameter is invalid, or
- * the comparer has failed to compare the keys.
+ * @exception E_INVALID_ARG Either of the following conditions has occurred:
+ * - A specified input parameter is invalid.
+ * - The comparer has failed to compare the keys.
* @see ContainsValue()
* @endif
*/
}
/**
- * Checks whether the map contains the specified key.
+ * Checks whether the map contains the specified @c key.
*
* @since 2.0
*
* else @c false
* @param[in] key The key to locate
* @exception E_SUCCESS The method is successful.
- * @exception E_INVALID_ARG A specified input parameter is invalid, or
- * the comparer has failed to compare the keys.
+ * @exception E_INVALID_ARG Either of the following conditions has occurred:
+ * - The specified input parameter is invalid.
+ * - The comparer has failed to compare the keys.
* @remarks The specific error code can be accessed using the GetLastResult() method.
* @see ContainsValue()
*/
virtual bool ContainsKey(const Object& key) const = 0;
/**
- * Checks whether the map contains the specified value.
+ * Checks whether the map contains the specified @c value.
*
* @since 2.0
*
virtual bool ContainsValue(const Object& value) const = 0;
/**
- * Gets an instance of the IMapEnumerator for the map.
+ * Gets an instance of IMapEnumerator for the map.
*
* @since 2.0
*
- * @return IMapEnumerator object of this map, @n
+ * @return An instance of IMapEnumerator for this map, @n
* else @c null if an exception occurs
* @exception E_SUCCESS The method is successful.
* @remarks The specific error code can be accessed using the GetLastResult() method.
* @see IEnumerator
- * @see IMapEnumerator
*/
virtual IMapEnumerator* GetMapEnumeratorN(void) const = 0;
/**
* @interface IMapEnumerator
- * @brief This interface supports simple iteration over a map.
+ * @brief This interface supports a simple iteration over a map.
*
* @since 2.0
*
- * @remarks
- * An enumerator remains valid as long as the map remains unchanged.
- * If changes are made to the map, such as adding, modifying, or
- * deleting elements, the enumerator is irrecoverably invalidated. The next call to any method returns an E_INVALID_OPERATION message.
+ * @remarks An enumerator remains valid as long as the map remains unchanged. @n
+ * If changes are made to the map, such as adding, modifying, or
+ * deleting elements, the enumerator is irrecoverably invalidated. @n
+ * The next call to any method returns @c E_INVALID_OPERATION.
*
- * The %IMapEnumerator interface supports simple iteration over a map.
+ * The %IMapEnumerator interface supports a simple iteration over a map.
* One can only access the elements in a collection through %IMapEnumerator. The elements cannot be modified through this interface.
*
* For more information on the class features, see <a href="../org.tizen.native.appprogramming/html/guide/base/hashmap_multihashmap.htm">HashMap and MultiHashMap</a>.
virtual ~IMapEnumerator(void) {}
/**
- * Gets the current object from the collection.
+ * Gets the current object in the collection.
*
* @since 2.0
*
* @return A pointer to the current object in the collection, @n
* else @c null if an exception occurs
* @exception E_SUCCESS The method is successful.
- * @exception E_INVALID_OPERATION Either of the following conditions has occurred: @n
- * - The current state of the instance prohibits the execution of the specified operation. @n
- * - The enumerator is currently positioned before the first element or after the last element. @n
+ * @exception E_INVALID_OPERATION Either of the following conditions has occurred:
+ * - The current state of the instance prohibits the execution of the specified operation.
+ * - The enumerator is currently positioned before the first element or after the last element.
* - The collection is modified after the enumerator is created.
* @remarks The specific error code can be accessed using the GetLastResult() method.
*/
* @return A pointer to the current key in the map, @n
* else @c null if an exception occurs
* @exception E_SUCCESS The method is successful.
- * @exception E_INVALID_OPERATION Either of the following conditions has occurred: @n
- * - The current state of the instance prohibits the execution of the specified operation. @n
- * - The enumerator is currently positioned before the first element or after the last element. @n
+ * @exception E_INVALID_OPERATION Either of the following conditions has occurred:
+ * - The current state of the instance prohibits the execution of the specified operation.
+ * - The enumerator is currently positioned before the first element or after the last element.
* - The collection is modified after the enumerator is created.
* @remarks The specific error code can be accessed using the GetLastResult() method.
*/
* @return A pointer to the current value in the map, @n
* else @c null if an exception occurs
* @exception E_SUCCESS The method is successful.
- * @exception E_INVALID_OPERATION Either of the following conditions has occurred: @n
- * - The current state of the instance prohibits the execution of the specified operation. @n
- * - The enumerator is currently positioned before the first element or after the last element. @n
+ * @exception E_INVALID_OPERATION Either of the following conditions has occurred:
+ * - The current state of the instance prohibits the execution of the specified operation.
+ * - The enumerator is currently positioned before the first element or after the last element.
* - The collection is modified after the enumerator is created.
* @remarks The specific error code can be accessed using the GetLastResult() method.
*/
/**
* @interface IMapEnumeratorT
- * @brief This interface supports simple iteration over a template-based map. @n
+ * @brief This interface supports a simple iteration over a template-based map. @n
* Using this method, you can only access the elements in the map. You cannot modify the elements.
*
* @since 2.0
*
- * @remarks
- * An enumerator remains valid as long as the map remains unchanged.
- * If changes are made to the map, such as adding, modifying, or
- * deleting elements, the enumerator is irrecoverably invalidated. The next call to any method returns an @c E_INVALID_OPERATION message.
+ * @remarks An enumerator remains valid as long as the map remains unchanged. @n
+ * If changes are made to the map, such as adding, modifying, or
+ * deleting elements, the enumerator is irrecoverably invalidated. @n
+ * The next call to any method returns @c E_INVALID_OPERATION.
*
- * The %IMapEnumeratorT interface supports simple iteration over a template-based map.
+ * The %IMapEnumeratorT interface supports a simple iteration over a template-based map.
* Using this method, you can only access the elements in the map. You cannot modify the elements.
*
* For more information on the class features, see <a href="../org.tizen.native.appprogramming/html/guide/base/hashmap_multihashmap.htm">HashMap and MultiHashMap</a>.
*
* @return An error code
* @param[out] key The current key
- * @exception E_INVALID_OPERATION The current state of the instance prohibits the execution of the specified operation. @n
- * The enumerator is currently positioned before the first element or after the last element or the collection is modified after the enumerator is created.
+ * @exception E_INVALID_OPERATION Either of the following conditions has occurred:
+ * - The current state of the instance prohibits the execution of the specified operation.
+ * - The enumerator is currently positioned before the first element or after the last element.
+ * - The collection is modified after the enumerator is created.
* @exception E_SUCCESS The method is successful.
*/
virtual result GetKey(KeyType& key) const = 0;
*
* @return An error code
* @param[out] value The current value
- * @exception E_INVALID_OPERATION The current state of the instance prohibits the execution of the specified operation. @n
- * The enumerator is currently positioned before the first element or after the last element or the collection is modified after the enumerator is created.
+ * @exception E_INVALID_OPERATION Either of the following conditions has occurred:
+ * - The current state of the instance prohibits the execution of the specified operation.
+ * - The enumerator is currently positioned before the first element or after the last element.
+ * - The collection is modified after the enumerator is created.
* @exception E_SUCCESS The method is successful.
*/
virtual result GetValue(ValueType& value) const = 0;
/**
* @interface IMapT
- * @brief This interface abstracts a template-based collection of key-value pairs.
+ * @brief This interface represents a template-based collection of key-value pairs.
*
* @since 2.0
*
- * The %IMapT interface abstracts a template-based collection of key-value pairs. An %IMapT
+ * The %IMapT interface represents a template-based collection of key-value pairs. An %IMapT
* contains unique keys and each key maps to a single value.
* The key and value cannot be a @c null reference.
*
* @since 2.0
*
* @return An error code
- * @param[in] key The key to add
- * @param[in] value The corresponding value to add
+ * @param[in] key The key to add
+ * @param[in] value The corresponding value to add
* @exception E_SUCCESS The method is successful.
- * @exception E_INVALID_ARG A specified input parameter is invalid, or
- * the comparer has failed to compare the keys.
+ * @exception E_INVALID_ARG Either of the following conditions has occurred:
+ * - A specified input parameter is invalid.
+ * - The comparer has failed to compare the keys.
* @exception E_OBJ_ALREADY_EXIST The specified @c key already exists.
* @see Remove()
*/
virtual result Add(const KeyType& key, const ValueType& value) = 0;
/**
- * Gets the value associated with the specified @c key.
+ * Gets the value associated to the specified @c key.
*
* @since 2.0
*
- * @return The value associated with the specified @c key, @n
+ * @return The value associated to the specified key, @n
* else @c null if an exception occurs
- * @param[in] key The key to find the associated value
- * @param[out] value The value associated with the key
+ * @param[in] key The key used to find the associated value
+ * @param[out] value The value associated to the key
* @exception E_SUCCESS The method is successful.
- * @exception E_INVALID_ARG A specified input parameter is invalid, or
- * the comparer has failed to compare the keys.
- * @exception E_OBJ_NOT_FOUND The specified @c key is not found in the map.
+ * @exception E_INVALID_ARG Either of the following conditions has occurred:
+ * - A specified input parameter is invalid.
+ * - The comparer has failed to compare the keys.
+ * @exception E_OBJ_NOT_FOUND The specified @c key has not been found in the map.
* @see SetValue()
*/
virtual result GetValue(const KeyType& key, ValueType& value) const = 0;
/**
- * Gets the value associated with the specified @c key.
+ * Gets the value associated to the specified @c key.
*
* @since 2.0
*
* @return An error code
- * @param[in] key The key to find the associated value
- * @param[out] value The value associated with the key
+ * @param[in] key The key used to find the associated value
+ * @param[out] value The value associated to the key
* @exception E_SUCCESS The method is successful.
- * @exception E_INVALID_ARG A specified input parameter is invalid, or
- * the comparer has failed to compare the keys.
- * @exception E_OBJ_NOT_FOUND The specified @c key is not found in the map.
+ * @exception E_INVALID_ARG Either of the following conditions has occurred:
+ * - A specified input parameter is invalid.
+ * - The comparer has failed to compare the keys.
+ * @exception E_OBJ_NOT_FOUND The specified @c key has not been found in the map.
* @see SetValue()
*/
virtual result GetValue(const KeyType& key, ValueType& value) = 0;
/**
- * Gets a list of all the keys in the map.
+ * Gets the list of all the keys in the map.
*
* @since 2.0
*
- * @return A pointer to a list of all the keys in the map, @n
+ * @return A pointer to the list of all the keys in the map, @n
* else @c null if an exception occurs
* @exception E_SUCCESS The method is successful.
* @exception E_OUT_OF_MEMORY The memory is insufficient.
- * @remarks The order of the keys is the same as the corresponding values in the IListT interface returned by the GetValuesN() method.
- * @remarks The specific error code can be accessed using the GetLastResult() method.
- * @see GetValuesN()
+ * @remarks
+ * - The order of the keys is the same as the corresponding values in the IListT interface returned by the GetValuesN() method.
+ * - The specific error code can be accessed using the GetLastResult() method.
*/
virtual IListT< KeyType >* GetKeysN(void) const = 0;
/**
- * Gets a list of all the values in the map.
+ * Gets the list of all the values in the map.
*
* @since 2.0
*
- * @return A pointer to a list of all values in the map, @n
+ * @return A pointer to the list of all values in the map, @n
* else @c null if an exception occurs
* @exception E_SUCCESS The method is successful.
* @exception E_OUT_OF_MEMORY The memory is insufficient.
virtual IListT< ValueType >* GetValuesN(void) const = 0;
/**
- * Removes the value associated with the specified @c key.
+ * Removes the value associated to the specified @c key.
*
* @since 2.0
*
* @return An error code
- * @param[in] key The key for which the value is to remove
+ * @param[in] key The key for which the value is removed
* @exception E_SUCCESS The method is successful.
- * @exception E_INVALID_ARG A specified input parameter is invalid, or
- * the comparer has failed to compare the keys.
- * @exception E_OBJ_NOT_FOUND The specified @c key is not found in the map.
+ * @exception E_INVALID_ARG Either of the following conditions has occurred:
+ * - The specified input parameter is invalid.
+ * - The comparer has failed to compare the keys.
+ * @exception E_OBJ_NOT_FOUND The specified @c key has not been found in the map.
* @see Add()
*/
virtual result Remove(const KeyType& key) = 0;
/**
- * Removes all key-value pairs in the map.
+ * Removes all the key-value pairs in the map.
*
* @since 2.0
*/
virtual void RemoveAll(void) = 0;
/**
- * Replaces the value associated with the specified @c key with the specified @c value.
+ * Replaces the value associated to the specified @c key with the specified @c value.
*
* @since 2.0
*
* @return An error code
- * @param[in] key The key whose value is to replace
- * @param[in] value The new value
+ * @param[in] key The key whose value is replaced
+ * @param[in] value The new value
* @exception E_SUCCESS The method is successful.
- * @exception E_INVALID_ARG A specified input parameter is invalid, or
- * the comparer has failed to compare the keys.
- * @exception E_OBJ_NOT_FOUND The specified @c key is not found in the map.
+ * @exception E_INVALID_ARG Either of the following conditions has occurred:
+ * - A specified input parameter is invalid.
+ * - The comparer has failed to compare the keys.
+ * @exception E_OBJ_NOT_FOUND The specified @c key has not been found in the map.
* @remarks Use the Add() method to add a new key-value pair.
- * @see Add()
* @see GetValue()
*/
virtual result SetValue(const KeyType& key, const ValueType& value) = 0;
* @since 2.0
*
* @return An error code
- * @param[in] key The key to locate
- * @param[out] out Set to @c true if the map contains the specified @c key, @n
- * else @c false
- * @exception E_SUCCESS The method is successful, or
- * the map contains the specified @c key.
- * @exception E_INVALID_ARG A specified input parameter is invalid, or
- * the comparer has failed to compare the keys.
+ * @param[in] key The key to locate
+ * @param[out] out The boolean value that indicates if the map contains the specified @c key
+ * @exception E_SUCCESS Either of the following conditions has occurred:
+ * - The method is successful.
+ * - The map contains the specified @c key.
+ * @exception E_INVALID_ARG Either of the following conditions has occurred:
+ * - A specified input parameter is invalid.
+ * - The comparer has failed to compare the keys.
* @see ContainsValue()
*/
virtual result ContainsKey(const KeyType& key, bool& out) const = 0;
*
* @since 2.0
*
- * @return @c true if the map contains the specified @c value, @n
+ * @return @c true if the map contains the specified value, @n
* else @c false
* @param[in] value The value to locate
*
virtual bool ContainsValue(const ValueType& value) const = 0;
/**
- * Gets an instance of the IMapEnumeratorT class for the map.
+ * Gets an instance of IMapEnumeratorT for the map.
*
* @since 2.0
*
- * @return An object of this map, @n
+ * @return An instance of IMapEnumeratorT for this map, @n
* else @c null if an exception occurs
* @exception E_SUCCESS The method is successful.
* @exception E_OUT_OF_MEMORY The memory is insufficient.
*
* @since 2.0
*
- * The %IMultiMap interface abstracts a collection of key-value pairs.
- * There is no limit on the number of elements with the same key, but duplicated elements with the same key are not allowed.
+ * The %IMultiMap interface represents a collection of key-value pairs.
+ * There is no limit on the number of elements having the same key, but duplicate elements with the same key are not allowed.
* The key and value cannot be a @c null reference.
* @n
* For more information on the class features, see <a href="../org.tizen.native.appprogramming/html/guide/base/hashmap_multihashmap.htm">HashMap and MultiHashMap</a>.
* Adds the specified key-value pair to the map.
*
* @brief <i> [Deprecated] </i>
- * @deprecated This method is deprecated because it has a problem of const reference argument.
+ * @deprecated This method is deprecated because it has a problem of constant reference argument.
* Instead of using this method, use Add(Object* pKey, Object* pValue).
* @since 2.0
*
* @return An error code
- * @param[in] key The key to add
- * @param[in] value The corresponding value to add
+ * @param[in] key The key to add
+ * @param[in] value The corresponding value to add
* @exception E_SUCCESS The method is successful.
- * @exception E_INVALID_ARG A specified input parameter is invalid, or
- * the comparer has failed to compare the keys.
+ * @exception E_INVALID_ARG Either of the following conditions has occurred:
+ * - A specified input parameter is invalid.
+ * - The comparer has failed to compare the keys.
* @exception E_OBJ_ALREADY_EXIST The specified @c key and @c value already exist.
- * @remarks This method performs a shallow copy. It adds just the pointer; not the element itself.
+ * @remarks This method performs a shallow copy. It adds just the pointer and not the element itself.
* @see Remove()
* @endif
*/
* @since 2.0
*
* @return An error code
- * @param[in] pKey The pointer to key to add
- * @param[in] pValue The pointer to corresponding value to add
+ * @param[in] pKey A pointer to the key to add
+ * @param[in] pValue A pointer to the corresponding value to add
* @exception E_SUCCESS The method is successful.
- * @exception E_INVALID_ARG A specified input parameter is invalid, or
- * the comparer has failed to compare the keys.
+ * @exception E_INVALID_ARG Either of the following conditions has occurred:
+ * - A specified input parameter is invalid.
+ * - The comparer has failed to compare the keys.
* @exception E_OBJ_ALREADY_EXIST The specified @c pKey and @c pValue already exist.
- * @remarks This method performs a shallow copy. It adds just the pointer; not the element itself.
+ * @remarks This method performs a shallow copy. It adds just the pointer and not the element itself.
* @see Remove()
*/
virtual result Add(Object* pKey, Object* pValue) = 0;
virtual int GetCount(void) const = 0;
/**
- * Gets the number of values with keys matching the specified key.
+ * Gets the number of values with keys matching the specified @c key.
*
* @since 2.0
*
* @return The number of values with keys matching the specified key
- * @param[in] key The key to locate in the map
- * @param[out] count The number of values with keys matching the specified key
+ * @param[in] key The key to locate in the map
+ * @param[out] count The number of values with keys matching the specified key
* @exception E_SUCCESS The method is successful.
- * @exception E_INVALID_ARG The specified input parameter is invalid, or
- * the comparer has failed to compare the keys.
- * @exception E_OBJ_NOT_FOUND The specified @c key is not found in the map.
+ * @exception E_INVALID_ARG Either of the following conditions has occurred:
+ * - A specified input parameter is invalid.
+ * - The comparer has failed to compare the keys.
+ * @exception E_OBJ_NOT_FOUND The specified @c key has not been found in the map.
*/
virtual result GetCount(const Object& key, int& count) const = 0;
/**
- * Gets an enumerator of the values associated with the specified key.
+ * Gets the enumerator of the values associated with the specified @c key.
*
* @since 2.0
*
- * @return An instance of the IEnumerator derived class with the values associated with the specified key, @n
+ * @return An instance of the IEnumerator derived class that contains the values associated with the specified key, @n
* else @c null if an exception occurs
* @param[in] key The key to locate in the map
* @exception E_SUCCESS The method is successful.
- * @exception E_INVALID_ARG A specified input parameter is invalid, or
- * the comparer has failed to compare the keys.
- * @exception E_OBJ_NOT_FOUND The specified @c key is not found in the map.
+ * @exception E_INVALID_ARG Either of the following conditions has occurred:
+ * - A specified input parameter is invalid.
+ * - The comparer has failed to compare the keys.
+ * @exception E_OBJ_NOT_FOUND The specified @c key has not been found in the map.
* @remarks The specific error code can be accessed using the GetLastResult() method.
*/
virtual IEnumerator* GetValuesN(const Object& key) const = 0;
/**
- * Gets a list of all unique keys in the map.
+ * Gets the list of all the unique keys in the map.
*
* @since 2.0
*
- * @return A pointer to a list of all unique keys in the map, @n
+ * @return A pointer to the list of all the unique keys in the map, @n
* else @c null if an exception occurs
* @remarks
- * - The %IList stores just the pointers to the elements in the map, not the elements themselves.
+ * - The IList stores just the pointers to the elements in the map and not the elements themselves.
* - The specific error code can be accessed using the GetLastResult() method.
* @see GetValuesN()
*/
virtual IList* GetKeysN(void) const = 0;
/**
- * Gets a list of all the values in the map.
+ * Gets the list of all the values in the map.
*
* @since 2.0
*
- * @return A pointer to a list of all the values in the map, @n
+ * @return A pointer to the list of all the values in the map, @n
* else @c null if an exception occurs
* @remarks
- * - The IList stores just the pointers to the elements in the map, not the elements themselves.
+ * - The IList stores just the pointers to the elements in the map and not the elements themselves.
* - The specific error code can be accessed using the GetLastResult() method.
* @see SetValue()
*/
virtual IList* GetValuesN(void) const = 0;
/**
- * Removes all the values associated with the specified key.
+ * Removes all the values associated with the specified @c key.
*
* @since 2.0
*
* @return An error code
- * @param[in] key The key for which the associated values need to remove
+ * @param[in] key The key for which the associated values are removed
* @param[in] forceDeletion Set to @c true to deallocate the object, @n
* else @c false
- * @exception E_SUCCESS The method is successful.
- * @exception E_INVALID_ARG A specified input parameter is invalid, or
- * the comparer has failed to compare the keys.
- * @exception E_OBJ_NOT_FOUND The specified @c key is not found in the map.
+ * @exception E_SUCCESS The method is successful.
+ * @exception E_INVALID_ARG Either of the following conditions has occurred:
+ * - A specified input parameter is invalid.
+ * - The comparer has failed to compare the keys.
+ * @exception E_OBJ_NOT_FOUND The specified @c key has not been found in the map.
* @remarks
- * - Based on the specified element deleter, the remove operation not only gets rid of an element from a list, but also deletes its object instance. @n
- * The element deleter style is recommended rather than using the @c forceDeletetion argument in the remove method. @n
- * If both an element deleter and forceDeleteion are set, the remove operation follows @c forceDeletion setting.
+ * - Based on the specified element deleter, the remove operation not only gets rid of an element from the list, but also deletes its object instance. @n
+ * The element deleter style is recommended rather than using @c forceDeletetion in the removing method. @n
+ * If both the element deleter and the @c forceDeleteion are set, the remove operation follows the @c forceDeletion setting.
* - Remove(key, @b true) internally works as the below code:
* @code
* DeleterFunctionType deleter = GetDeleter();
}
/**
- * Removes all the values associated with the specified key.
+ * Removes all the values associated with the specified @c key.
*
* @since 2.0
*
* @return An error code
- * @param[in] key The key for which the associated values need to remove
+ * @param[in] key The key for which the associated values are removed
* @exception E_SUCCESS The method is successful.
- * @exception E_INVALID_ARG A specified input parameter is invalid, or
- * the comparer has failed to compare the keys.
- * @exception E_OBJ_NOT_FOUND The specified @c key is not found in the map.
+ * @exception E_INVALID_ARG Either of the following conditions has occurred:
+ * - A specified input parameter is invalid.
+ * - The comparer has failed to compare the keys.
+ * @exception E_OBJ_NOT_FOUND The specified @c key has not been found in the map.
* @see Add(Object*, Object*)
*/
virtual result Remove(const Object& key) = 0;
/**
- * Removes the specified value associated with the specified key. @n
- * The key is also removed if there are no more values associated with it.
+ * Removes the specified @c value associated with the specified @c key. @n
+ * The @c key is also removed if there are no more values associated with it.
*
* @since 2.0
*
* @return An error code
- * @param[in] key The key for which the mapping is to remove from the map
- * @param[in] value The value to remove
+ * @param[in] key The key for which the mapping is removed from the map
+ * @param[in] value The value to remove
* @param[in] forceDeletion Set to @c true to deallocate the object, @n
* else @c false
- * @exception E_SUCCESS The method is successful.
- * @exception E_INVALID_ARG A specified input parameter is invalid, or
- * the comparer has failed to compare the keys.
- * @exception E_OBJ_NOT_FOUND The @c key and @c value pair is not found in the map.
+ * @exception E_SUCCESS The method is successful.
+ * @exception E_INVALID_ARG Either of the following conditions has occurred:
+ * - A specified input parameter is invalid.
+ * - The comparer has failed to compare the keys.
+ * @exception E_OBJ_NOT_FOUND The specified @c key and the specified @c value pair has not been found in the map.
* @remarks
- * - Based on the specified element deleter, the remove operation not only gets rid of an element from a list, but also deletes its object instance. @n
- * The element deleter style is recommended rather than using the @c forceDeletetion argument in the remove method. @n
- * If both an element deleter and forceDeleteion are set, the remove operation follows @c forceDeletion setting.
+ * - Based on the specified element deleter, the remove operation not only gets rid of an element from the list, but also deletes its object instance. @n
+ * - The element deleter style is recommended rather than using @c forceDeletetion in the removing method. @n
+ * - If both the element deleter and the @c forceDeleteion are set, the remove operation follows the @c forceDeletion setting.
* - Remove(key, value, @b true) internally works as the below code:
* @code
* DeleterFunctionType deleter = GetDeleter();
}
/**
- * Removes the specified value associated with the specified key. @n
- * The key is also removed if there are no more values associated with it.
+ * Removes the specified @c value associated with the specified @c key. @n
+ * The @c key is also removed if there are no more values associated with it.
*
* @since 2.0
*
* @return An error code
- * @param[in] key The key for which the mapping is to remove from the map
- * @param[in] value The value to remove
+ * @param[in] key The key for which the mapping is removed from the map
+ * @param[in] value The value to remove
* @exception E_SUCCESS The method is successful.
- * @exception E_INVALID_ARG A specified input parameter is invalid, or
- * the comparer has failed to compare the keys.
- * @exception E_OBJ_NOT_FOUND The @c key and @c value pair is not found in the map.
+ * @exception E_INVALID_ARG Either of the following conditions has occurred:
+ * - A specified input parameter is invalid.
+ * - The comparer has failed to compare the keys.
+ * @exception E_OBJ_NOT_FOUND The specified @c key and the specified @c value pair has not been found in the map.
* @see Add(Object*, Object*)
*/
virtual result Remove(const Object& key, const Object& value) = 0;
/**
* Removes all the object pointers in the collection. @n
- * If the @c forceDeletion parameter is set to @c true, the method also removes all the objects. This method can be called before deleting the collection.
+ * If @c forceDeletion is set to @c true, the method also removes all the objects. This method can be called before deleting the collection.
*
* @since 2.0
*
* @param[in] forceDeletion Set to @c true to deallocate all objects, @n
* else @c false
* @remarks
- * - Based on the specified element deleter, the remove operation not only gets rid of an element from a list, but also deletes its object instance. @n
- * The element deleter style is recommended rather than using the @c forceDeletetion argument in the remove method. @n
- * If both an element deleter and forceDeleteion are set, the remove operation follows @c forceDeletion setting.
+ * - Based on the specified element deleter, the remove operation not only gets rid of an element from the list, but also deletes its object instance. @n
+ * - The element deleter style is recommended rather than using @c forceDeletetion in the removing method. @n
+ * - If both the element deleter and the @c forceDeletion are set, the remove operation follows the @c forceDeletion setting.
* - RemoveAll(@b true) internally works as the below code:
* @code
* DeleterFunctionType deleter = GetDeleter();
/**
* Removes all the object pointers in the collection. @n
- * This method can be called before deleting the collection.
+ * The %RemoveAll() method can be called before deleting the collection.
*
* @since 2.0
*/
virtual void RemoveAll(void) = 0;
/**
- * Replaces the specified value associated with the specified key with a new value.
+ * Replaces the specified @c value associated with the specified @c key with a @c newValue.
*
* @since 2.0
*
* @return An error code
- * @param[in] key The key for which the associated value needs to replace
- * @param[in] value The value associated with the key
- * @param[in] newValue The new value
- * @param[in] forceDeletion Set to @c true to deallocate the object, @n
- * else @c false
+ * @param[in] key The key for which the associated value is replaced
+ * @param[in] value The value associated with the key
+ * @param[in] newValue The new value
+ * @param[in] forceDeletion Set to @c true to deallocate the object, @n
+ * else @c false
* @exception E_SUCCESS The method is successful.
- * @exception E_INVALID_ARG A specified input parameter is invalid, or
- * the comparer has failed to compare the keys.
- * @exception E_OBJ_NOT_FOUND The key-value pair is not found in the map.
+ * @exception E_INVALID_ARG Either of the following conditions has occurred:
+ * - A specified input parameter is invalid.
+ * - The comparer has failed to compare the keys.
+ * @exception E_OBJ_NOT_FOUND The key-value pair has not been found in the map.
* @remarks
* - Use the Add(Object*, Object*) method to add a new key-value pair.
- * - Based on the specified element deleter, the set operation not only gets rid of an element from a list, but also deletes its object instance. @n
- * The element deleter style is recommended rather than using the @c forceDeletetion argument in the set method. @n
- * If both an element deleter and forceDeleteion are set, the set operation follows @c forceDeletion setting.
+ * - Based on the specified element deleter, the set operation not only gets rid of an element from the list, but also deletes its object instance. @n
+ * The element deleter style is recommended rather than using @c forceDeletetion in the set method. @n
+ * If both the element deleter and the @c forceDeleteion are set, the set operation follows the @c forceDeletion setting.
* - SetValue(key, value, newValue, @b true) internally works as the below code:
* @code
* DeleterFunctionType deleter = GetDeleter();
}
/**
- * Replaces the specified value associated with the specified key with a new value.
+ * Replaces the specified @c value associated with the specified @c key with a @c pNewValue.
*
* @since 2.0
*
* @return An error code
- * @param[in] key The key for which the associated value needs to replace
- * @param[in] value The value associated with the key
- * @param[in] pNewValue The pointer to new value
+ * @param[in] key The key for which the associated value is replaced
+ * @param[in] value The value associated with the key
+ * @param[in] pNewValue A pointer to the new value
* @exception E_SUCCESS The method is successful.
- * @exception E_INVALID_ARG A specified input parameter is invalid, or
- * the comparer has failed to compare the keys.
- * @exception E_OBJ_NOT_FOUND The key-value pair is not found in the map.
+ * @exception E_INVALID_ARG Either of the following conditions has occurred:
+ * - A specified input parameter is invalid.
+ * - The comparer has failed to compare the keys.
+ * @exception E_OBJ_NOT_FOUND The key-value pair has not been found in the map.
* @remarks Use the Add(Object*, Object*) method to add a new key-value pair.
* @see GetValuesN()
*/
* Checks whether the map contains the specified key-value pair.
*
* @brief <i> [Deprecated] </i>
- * @deprecated This method is deprecated because it transfers a result of comparison in out-parameter form.
- * The return type will be changed into boolean type and this method will return the result.
+ * @deprecated This method is deprecated because it transfers the result of the comparison in an out-parameter form.
+ * The return type is changed into boolean and this method returns the result.
* Instead of using this method, use bool Contains(const Object& key, const Object& value).
* @since 2.0
*
* @return An error code
- * @param[in] key The key to locate
- * @param[in] value The value to locate
- * @param[out] out Set to @c true if the map contains the specified key-value pair, @n
- * else @c false
+ * @param[in] key The key to locate
+ * @param[in] value The value to locate
+ * @param[out] out Set to @c true if the map contains the specified key-value pair, @n
+ * else @c false
* @exception E_SUCCESS The method is successful.
- * @exception E_INVALID_ARG A specified input parameter is invalid, or
- * the comparer has failed to compare the keys.
+ * @exception E_INVALID_ARG Either of the following conditions has occurred:
+ * - A specified input parameter is invalid.
+ * - The comparer has failed to compare the keys.
* @see ContainsKey()
* @see ContainsValue()
* @endif
*
* @return @c true if the map contains the specified key-value pair, @n
* else @c false
- * @param[in] key The key to locate
- * @param[in] value The value to locate
+ * @param[in] key The key to locate
+ * @param[in] value The value to locate
* @exception E_SUCCESS The method is successful.
- * @exception E_INVALID_ARG A specified input parameter is invalid, or
- * the comparer has failed to compare the keys.
+ * @exception E_INVALID_ARG Either of the following conditions has occurred:
+ * - A specified input parameter is invalid.
+ * - The comparer has failed to compare the keys.
* @remarks The specific error code can be accessed using the GetLastResult() method.
* @see ContainsKey(const Object&) const
* @see ContainsValue()
/**
* @if OSPDEPREC
- * Checks whether the map contains the specified key.
+ * Checks whether the map contains the specified @c key.
*
* @brief <i> [Deprecated] </i>
- * @deprecated This method is deprecated because it transfers a result of comparison in out-parameter form.
- * The return type will be changed into boolean type and this method will return the result.
+ * @deprecated This method is deprecated because it transfers the result of the comparison in an out-parameter form.
+ * The return type is changed into boolean and this method returns the result.
* Instead of using this method, use bool ContainsKey(const Object& key).
* @since 2.0
*
* @return An error code
- * @param[in] key The key to locate
- * @param[out] out Set to @c true if the map contains the specified key, @n
- * else @c false
+ * @param[in] key The key to locate
+ * @param[out] out Set to @c true if the map contains the specified key, @n
+ * else @c false
* @exception E_SUCCESS The method is successful.
- * @exception E_INVALID_ARG A specified input parameter is invalid, or
- * the comparer has failed to compare the keys.
+ * @exception E_INVALID_ARG Either of the following conditions has occurred:
+ * - A specified input parameter is invalid.
+ * - The comparer has failed to compare the keys.
* @see ContainsValue()
* @see Contains(const Object&, const Object&)
* @endif
}
/**
- * Checks whether the map contains the specified key.
+ * Checks whether the map contains the specified @c key.
*
* @since 2.0
*
* else @c false
* @param[in] key The key to locate
* @exception E_SUCCESS The method is successful.
- * @exception E_INVALID_ARG A specified input parameter is invalid, or
- * the comparer has failed to compare the keys.
+ * @exception E_INVALID_ARG Either of the following conditions has occurred:
+ * - A specified input parameter is invalid.
+ * - The comparer has failed to compare the keys.
* @remarks The specific error code can be accessed using the GetLastResult() method.
* @see ContainsValue()
* @see Contains(const Object&, const Object&) const
virtual bool ContainsKey(const Object& key) const = 0;
/**
- * Checks whether the map contains the specified value.
+ * Checks whether the map contains the specified @c value.
*
* @since 2.0
*
virtual bool ContainsValue(const Object& value) const = 0;
/**
- * Gets an enumerator of the map.
+ * Gets the enumerator of the map.
*
* @since 2.0
*
- * @return An instance of the IMapEnumerator class for the map, @n
+ * @return An instance of IMapEnumerator for the map, @n
* else @c null if an exception occurs
* @exception E_SUCCESS The method is successful.
* @remarks
* {A: a}, {B: b}, {B: c}, {B, d}, {C: e}, ...
* - The specific error code can be accessed using the GetLastResult() method.
* @see IEnumerator
- * @see IMapEnumerator
*/
virtual IMapEnumerator* GetMapEnumeratorN(void) const = 0;
*
* @since 2.0
*
- * The %IMultiMapT interface abstracts a template-based collection of key-value pairs.
- * There is no limit on the number of elements with the same key, but duplicated elements with the same key are not allowed.
+ * The %IMultiMapT interface represents a template-based collection of key-value pairs.
+ * There is no limit on the number of elements having the same key, but duplicate elements with the same key are not allowed.
* The key and value cannot be a @c null reference.
* @n
* For more information on the class features, see <a href="../org.tizen.native.appprogramming/html/guide/base/hashmap_multihashmap.htm">HashMap and MultiHashMap</a>.
* @since 2.0
*
* @return An error code
- * @param[in] key The key to add
- * @param[in] value The corresponding value to add
+ * @param[in] key The key to add
+ * @param[in] value The corresponding value to add
* @exception E_SUCCESS The method is successful.
- * @exception E_INVALID_ARG A specified input parameter is invalid, or
- * the comparer has failed to compare the keys.
- * @exception E_OBJ_ALREADY_EXIST The specified @c key and @c value already exists.
+ * @exception E_INVALID_ARG Either of the following conditions has occurred:
+ * - A specified input parameter is invalid.
+ * - The comparer has failed to compare the keys.
+ * @exception E_OBJ_ALREADY_EXIST The specified @c key and the specified @c value already exists.
* @exception E_OUT_OF_MEMORY The memory is insufficient.
* @see Remove()
*/
virtual int GetCount(void) const = 0;
/**
- * Gets the number of values whose key matches the specified key.
+ * Gets the number of values whose key matches the specified @c key.
*
* @since 2.0
*
* @return The number of values whose key matches the specified key
- * @param[in] key The key to locate in the map
- * @param[out] count The number of values whose key matches the specified key
+ * @param[in] key The key to locate in the map
+ * @param[out] count The number of values whose key matches the specified key
* @exception E_SUCCESS The method is successful.
- * @exception E_INVALID_ARG A specified input parameter is invalid, or
- * the comparer has failed to compare the keys.
- * @exception E_OBJ_NOT_FOUND The specified @c key is not found in the map.
+ * @exception E_INVALID_ARG Either of the following conditions has occurred:
+ * - A specified input parameter is invalid.
+ * - The comparer has failed to compare the keys.
+ * @exception E_OBJ_NOT_FOUND The specified @c key has not been found in the map.
*/
virtual result GetCount(const KeyType& key, int& count) const = 0;
/**
- * Gets an enumerator of the values associated with the specified key.
+ * Gets the enumerator of the values associated with the specified @c key.
*
* @since 2.0
*
- * @return An instance of the IEnumeratorT derived class with the values associated with the specified key, @n
+ * @return An instance of the IEnumeratorT derived class that contains the values associated with the specified key, @n
* else @c null if an exception occurs
* @param[in] key The key to locate
* @exception E_SUCCESS The method is successful.
- * @exception E_INVALID_ARG A specified input parameter is invalid, or
- * the comparer has failed to compare the keys.
- * @exception E_OBJ_NOT_FOUND The specified @c key is not found in the map.
+ * @exception E_INVALID_ARG Either of the following conditions has occurred:
+ * - A specified input parameter is invalid.
+ * - The comparer has failed to compare the keys.
+ * @exception E_OBJ_NOT_FOUND The specified @c key has not been found in the map.
* @exception E_OUT_OF_MEMORY The memory is insufficient.
* @remarks The specific error code can be accessed using the GetLastResult() method.
* @see SetValue()
virtual IEnumeratorT< ValueType >* GetValuesN(const KeyType& key) const = 0;
/**
- * Gets a list of all unique keys in the map.
+ * Gets the list of all the unique keys in the map.
*
* @since 2.0
*
- * @return A pointer to a list of all unique keys in the map, @n
+ * @return A pointer to the list of all the unique keys in the map, @n
* else @c null if an exception occurs
* @exception E_SUCCESS The method is successful.
* @exception E_OUT_OF_MEMORY The memory is insufficient.
virtual IListT< KeyType >* GetKeysN(void) const = 0;
/**
- * Gets a list of all the values in the map.
+ * Gets the list of all the values in the map.
*
* @since 2.0
*
- * @return A pointer to a list of all the values in the map, @n
+ * @return A pointer to the list of all the values in the map, @n
* else @c null if an exception occurs
* @exception E_SUCCESS The method is successful.
* @exception E_OUT_OF_MEMORY The memory is insufficient.
virtual IListT< ValueType >* GetValuesN(void) const = 0;
/**
- * Removes all the values associated with the specified key.
+ * Removes all the values associated with the specified @c key.
*
* @since 2.0
*
* @return An error code
- * @param[in] key The key whose associated values need to remove
+ * @param[in] key The key whose associated values are removed
* @exception E_SUCCESS The method is successful.
- * @exception E_INVALID_ARG A specified input parameter is invalid, or
- * the comparer has failed to compare the keys.
- * @exception E_OBJ_NOT_FOUND The specified @c key is not found in the map.
+ * @exception E_INVALID_ARG Either of the following conditions has occurred:
+ * - A specified input parameter is invalid.
+ * - The comparer has failed to compare the keys.
+ * @exception E_OBJ_NOT_FOUND The specified @c key has not been found in the map.
* @see Add()
*/
virtual result Remove(const KeyType& key) = 0;
* @since 2.0
*
* @return An error code
- * @param[in] key The key whose mapping is to remove from the map
- * @param[in] value The value to remove
+ * @param[in] key The key whose mapping is removed from the map
+ * @param[in] value The value to remove
* @exception E_SUCCESS The method is successful.
- * @exception E_INVALID_ARG A specified input parameter is invalid, or
- * the comparer has failed to compare the keys.
- * @exception E_OBJ_NOT_FOUND The specified @c key and @c value pair is not found in the map.
+ * @exception E_INVALID_ARG Either of the following conditions has occurred:
+ * - A specified input parameter is invalid.
+ * - The comparer has failed to compare the keys.
+ * @exception E_OBJ_NOT_FOUND The specified @c key and the specified @c value pair has not been found in the map.
* @see Add()
*/
virtual result Remove(const KeyType& key, const ValueType& value) = 0;
virtual void RemoveAll(void) = 0;
/**
- * Replaces the specified value associated with the specified key with a new value.
+ * Replaces the specified @c value associated with the specified @c key with a @c newValue.
*
* @since 2.0
*
* @return An error code
- * @param[in] key The key whose associated value needs to replace
- * @param[in] value The value associated with the key
- * @param[in] newValue The new value
+ * @param[in] key The key whose associated value is replaced
+ * @param[in] value The value associated with the key
+ * @param[in] newValue The new value
* @exception E_SUCCESS The method is successful.
- * @exception E_INVALID_ARG A specified input parameter is invalid, or
- * the comparer has failed to compare the keys.
- * @exception E_OBJ_NOT_FOUND The specified @c key and @c value pair is not found in the map.
+ * @exception E_INVALID_ARG Either of the following conditions has occurred:
+ * - A specified input parameter is invalid.
+ * - The comparer has failed to compare the keys.
+ * @exception E_OBJ_NOT_FOUND The specified @c key and the specified @c value pair has not been found in the map.
* @exception E_OUT_OF_MEMORY The memory is insufficient.
* @remarks Use the Add() method to add a new key-value pair.
* @see Add()
* @since 2.0
*
* @return An error code
- * @param[in] key The key to locate
- * @param[in] value The value to locate
- * @param[out] out Set to @c true if the map contains the specified key-value pair, @n
- * else @c false
- * @exception E_SUCCESS The method is successful. @n
- * @exception E_INVALID_ARG A specified input parameter is invalid, or
- * the comparer has failed to compare the keys.
+ * @param[in] key The key to locate
+ * @param[in] value The value to locate
+ * @param[out] out Set to @c true if the map contains the specified key-value pair, @n
+ * else @c false
+ * @exception E_SUCCESS The method is successful.
+ * @exception E_INVALID_ARG Either of the following conditions has occurred:
+ * - A specified input parameter is invalid.
+ * - The comparer has failed to compare the keys.
* @see ContainsKey()
* @see ContainsValue()
*/
virtual result Contains(const KeyType& key, const ValueType& value, bool& out) const = 0;
/**
- * Checks whether the map contains the specified key.
+ * Checks whether the map contains the specified @c key.
*
* @since 2.0
*
* @return An error code
- * @param[in] key The key to locate
- * @param[out] out Set to @c true if the map contains the specified key, @n
- * else @c false
- * @exception E_SUCCESS The method is successful. @n
- * @exception E_INVALID_ARG A specified input parameter is invalid, or
- * the comparer has failed to compare the keys.
+ * @param[in] key The key to locate
+ * @param[out] out Set to @c true if the map contains the specified key, @n
+ * else @c false
+ * @exception E_SUCCESS The method is successful.
+ * @exception E_INVALID_ARG Either of the following conditions has occurred:
+ * - A specified input parameter is invalid.
+ * - The comparer has failed to compare the keys.
* @see ContainsValue()
* @see Contains()
*/
virtual result ContainsKey(const KeyType& key, bool& out) const = 0;
/**
- * Checks whether the map contains the specified value.
+ * Checks whether the map contains the specified @c value.
*
* @since 2.0
*
virtual bool ContainsValue(const ValueType& value) const = 0;
/**
- * Gets an enumerator of the map.
+ * Gets the enumerator of the map.
*
* @since 2.0
*
- * @return An instance of the IMapEnumeratorT class for the map, @n
+ * @return An instance of IMapEnumeratorT for the map, @n
* else @c null if an exception occurs
* @exception E_SUCCESS The method is successful.
* @exception E_OUT_OF_MEMORY The memory is insufficient.
- * @remarks If a key has multiple values, the enumeration proceeds as follows: @n
- * {A: a}, {B: b}, {B: c}, {B, d}, {C: e}, ... @n
- * The specific error code can be accessed using the GetLastResult() method.
+ * @remarks
+ * - If a key has multiple values, the enumeration proceeds as follows: @n
+ * {A: a}, {B: b}, {B: c}, {B, d}, {C: e}, ...
+ * - The specific error code can be accessed using the GetLastResult() method.
* @see Tizen::Base::Collection::IEnumerator
* @see Tizen::Base::Collection::IMapEnumerator
*/
/**
* @class IteratorT
* @brief This class provides an iterator that is used to convert %IList to STL containers. @n
- * %StlConverter provides static methods to get this iterator from %IList.
+ * %StlConverter provides static methods to get this iterator from IList.
*
* @since 2.1
*
- * @remarks The %IteratorT class satisfies only requirements of C++ standard library InputIterator concept due to limitations of %Tizen collection.
- * So, this class can be used with C++ standard library algorithms which requires only InputIterator concept for their arguments.
+ * @remarks The %IteratorT class satisfies only the requirements of the C++ standard library InputIterator concept due to limitations of the %Tizen collection. @n
+ * This class can be used with the C++ standard library algorithms which require only the InputIterator concept for their arguments.
*
* The %IteratorT class provides an iterator that is used to convert IList to STL containers.
* StlConverter provides static methods to get this iterator from IList.
{
public:
/**
- * Initializes an instance of %IteratorT class.
+ * Initializes an instance of %IteratorT.
*
* @since 2.1
*
* @param[in] list A reference to the IList instance to convert
- * @param[in] isPostEnd A boolean value to check the end of a list
+ * @param[in] isPostEnd The boolean value that checks the end of the list
*/
explicit IteratorT(const IList& list, bool isPostEnd = false)
: __pList(&list)
}
/**
- * This is an assignment operator of the %IteratorT class.
+ * This is the assignment operator of the %IteratorT class.
*
* @since 2.1
*
}
/**
- * This is the indirection operator for the %IteratorT class.
+ * This is the indirection operator of the %IteratorT class.
*
* @since 2.1
*
}
/**
- * This is a structure dereference operator for the %IteratorT class.
+ * This is the structure dereference operator of the %IteratorT class.
*
* @since 2.1
*
* @return A reference to the %IteratorT type instance
* @exception E_SUCCESS The method is successful.
* @exception E_OUT_OF_RANGE The iterator is outside the bounds of the list.
- * @exception E_INVALID_OPERATION The current state of the instance prohibits the execution of the specified operation, or
- * the collection is modified after the enumerator is created.
+ * @exception E_INVALID_OPERATION Either of the following conditions has occurred:
+ * - The current state of the instance prohibits the execution of the specified operation.
+ * - The collection is modified after the enumerator is created.
* @remarks The specific error code can be accessed using GetLastResult() method.
*/
IteratorT< T >& operator ++(void)
* @return An %IteratorT instance
* @exception E_SUCCESS The method is successful.
* @exception E_OUT_OF_RANGE The iterator is outside the bounds of the list.
- * @exception E_INVALID_OPERATION The current state of the instance prohibits the execution of the specified operation, or
- * the collection is modified after the enumerator is created.
+ * @exception E_INVALID_OPERATION Either of the following conditions has occurred:
+ * - The current state of the instance prohibits the execution of the specified operation.
+ * - The collection is modified after the enumerator is created.
* @remarks The specific error code can be accessed using GetLastResult() method.
*/
IteratorT< T > operator ++(int)
* @return A reference to the %IteratorT type instance
* @exception E_SUCCESS The method is successful.
* @exception E_OUT_OF_RANGE The iterator is outside the bounds of the list.
- * @exception E_INVALID_OPERATION The current state of the instance prohibits the execution of the specified operation, or
- * the collection is modified after the enumerator is created.
+ * @exception E_INVALID_OPERATION Either of the following conditions has occurred:
+ * - The current state of the instance prohibits the execution of the specified operation.
+ * - The collection is modified after the enumerator is created.
* @remarks The specific error code can be accessed using GetLastResult() method.
*/
IteratorT< T >& operator --(void)
* @return An %IteratorT instance
* @exception E_SUCCESS The method is successful.
* @exception E_OUT_OF_RANGE The iterator is outside the bounds of the list.
- * @exception E_INVALID_OPERATION The current state of the instance prohibits the execution of the specified operation, or
- * the collection is modified after the enumerator is created.
+ * @exception E_INVALID_OPERATION Either of the following conditions has occurred:
+ * - The current state of the instance prohibits the execution of the specified operation.
+ * - The collection is modified after the enumerator is created.
* @remarks The specific error code can be accessed using GetLastResult() method.
*/
IteratorT< T > operator --(int)
/**
* @class LinkedList
- * @brief This class represents a collection of objects that can be individually accessed by index.
+ * @brief This class represents a collection of objects that can be individually accessed by an index.
*
* @since 2.0
*
- * The %LinkedList class represents a collection of objects that can be individually accessed by index.
+ * The %LinkedList class represents a collection of objects that can be individually accessed by an index.
*
* For more information on the class features, see <a href="../org.tizen.native.appprogramming/html/guide/base/arraylist_linkedlist.htm">ArrayList and LinkedList</a>.
*
*
* @since 2.0
*
- * @param[in] deleter The function pointer to type of the element deleter
- * @remarks To create an owning collection, set the element deleter value as @c SingleObjectDeleter. This gives the collection the ownership of elements and the collection will destroy elements. @n
- * On the other hand, to create a non-owning collection, you do not need to set the element deleter value, as @c NoOpDeleter is the default element deleter.
- * It means that you do not transfer the ownership of elements to the collection.
+ * @param[in] deleter A function pointer to the type of the element deleter
+ * @remarks To create an owing collection, set the element deleter value as @c SingleObjectDeleter. @n
+ * This gives the collection the ownership of the elements and the collection destroys the elements. @n
+ * On the other hand, to create a non-owning collection, do not set the element deleter value, as @c NoOpDeleter is the default element deleter. @n
+ * It means that you do not transfer the ownership of the elements to the collection.
* @see NoOpDeleter()
* @see SingleObjectDeleter()
* @see ArrayDeleter()
* @since 2.0
*
* @return An error code
- * @param[in] pObj An pointer to object to add
+ * @param[in] pObj A pointer to the object to add
* @exception E_SUCCESS The method is successful.
* @exception E_INVALID_ARG The specified input parameter is invalid.
- * @remarks This method performs a shallow copy. It adds just the pointer; not the element itself.
+ * @remarks This method performs a shallow copy. It adds just the pointer and not the element itself.
* @see Remove()
*/
virtual result Add(Object* pObj);
* @since 2.0
*
* @return An error code
- * @param[in] collection A collection to add
+ * @param[in] collection The collection to add
* @exception E_SUCCESS The method is successful.
- * @exception E_INVALID_OPERATION The current state of the instance prohibits the execution of the specified operation, or
- * the @c collection is modified during the operation of this method.
- * @remarks This method performs a shallow copy. It adds just the pointer; not the element itself.
+ * @exception E_INVALID_OPERATION Either of the following conditions has occurred:
+ * - The current state of the instance prohibits the execution of the specified operation.
+ * - The specified @c collection is modified during the operation of this method.
+ * @remarks This method performs a shallow copy. It adds just the pointer and not the element itself.
* @see RemoveItems()
*/
virtual result AddItems(const ICollection& collection);
/**
- * Gets an enumerator (an instance of the IEnumerator derived class) to the list.
+ * Gets the enumerator (an instance of the IEnumerator derived class) of the list.
*
* @since 2.0
*
- * @return An enumerator of the calling list object, @n
+ * @return The enumerator of the calling list object, @n
* else @c null if an exception occurs
* @remarks The specific error code can be accessed using the GetLastResult() method.
- * @see Tizen::Base::Collection::IEnumerator
*/
virtual IEnumerator* GetEnumeratorN(void) const;
/**
- * Gets a bidirectional enumerator (an instance of the IBidirectionalEnumerator derived class) of this list.
+ * Gets the bidirectional enumerator (an instance of the IBidirectionalEnumerator derived class) of the list.
*
* @since 2.0
*
* @return An instance of the IBidirectionalEnumerator derived class, @n
- * else @c null if some exception occurs
- * @remarks Use this method to obtain a bidirectional enumerator (an instance of the IBidirectionalEnumerator derived class)
+ * else @c null if an exception occurs
+ * @remarks
+ * - Use this method to obtain a bidirectional enumerator (an instance of the IBidirectionalEnumerator derived class)
* to iterate over a collection (an instance of the IList derived class).
- * The specific error code can be accessed using GetLastResult() method.
- * @see Tizen::Base::Collection::IBidirectionalEnumerator
+ * - The specific error code can be accessed using GetLastResult() method.
*/
virtual IBidirectionalEnumerator* GetBidirectionalEnumeratorN(void) const;
/**
- * Gets the object at the specified index of the calling list.
+ * Gets the object at the specified @c index of the calling list.
*
* @since 2.0
*
* @return A pointer to the object at the specified index of the list, @n
- * else @c null if the index is not valid
+ * else @c null if the index is invalid
* @param[in] index The index of the object to read
* @exception E_SUCCESS The method is successful.
- * @exception E_OUT_OF_RANGE The specified index is outside the bounds of the data structure, or
- * the specified @c index is equal to or greater than the number of elements or less than @c 0.
+ * @exception E_OUT_OF_RANGE Either of the following conditions has occurred:
+ * - The specified @c index is outside the bounds of the data structure.
+ * - The specified @c index is either greater than or equal to the number of elements.
+ * - The specified @c index is less than @c 0.
* @remarks The specific error code can be accessed using the GetLastResult() method.
* @see SetAt()
*/
virtual const Object* GetAt(int index) const;
/**
- * Gets the object at the specified index of the calling list.
+ * Gets the object at the specified @c index of the calling list.
*
* @since 2.0
*
* @return A pointer to the object at the specified index of the list, @n
- * else @c null if the index is not valid
+ * else @c null if the index is invalid
* @param[in] index The index of the object to read
* @exception E_SUCCESS The method is successful.
- * @exception E_OUT_OF_RANGE The specified index is outside the bounds of the data structure, or
- * the specified @c index is equal to or greater than the number of elements or less than @c 0.
+ * @exception E_OUT_OF_RANGE Either of the following conditions has occurred:
+ * - The specified @c index is outside the bounds of the data structure.
+ * - The specified @c index is either greater than or equal to the number of elements.
+ * - The specified @c index is less than @c 0.
* @remarks The specific error code can be accessed using the GetLastResult() method.
* @see SetAt()
*/
virtual Object* GetAt(int index);
/**
- * Gets an IList with the specified range from the calling list object.
+ * Gets the IList with the specified range from the calling list object.
*
* @since 2.0
*
- * @return An IList pointer if successful, @n
+ * @return An IList pointer , @n
* else @c null if an exception occurs
- * @param[in] startIndex The starting index of the range
- * @param[in] count The number of elements to read
+ * @param[in] startIndex The starting index of the range
+ * @param[in] count The number of elements to read
* @exception E_SUCCESS The method is successful.
- * @exception E_OUT_OF_RANGE Either of the following conditions has occurred: @n
- * - The specified index is outside the bounds of the data structure. @n
- * - The specified @c startIndex is either equal to or greater than the number of elements or less than @c 0. @n
- * - The specified @c count is either greater than the number of elements starting from @c startIndex or less than @c 0.
- * @remarks The IList stores just the pointers to the elements in the list, not the elements themselves.
- * The specific error code can be accessed using the GetLastResult() method.
+ * @exception E_OUT_OF_RANGE Either of the following conditions has occurred:
+ * - The specified @c index is outside the bounds of the data structure.
+ * - The specified @c startIndex is either greater than or equal to the number of elements.
+ * - The specified @c startIndex is less than @c 0.
+ * - The specified @c count is either greater than the number of elements starting from @c startIndex.
+ * - The specified @c count is less than @c 0.
+ * @remarks
+ * - The IList stores just the pointers to the elements in the list and not the elements themselves.
+ * - The specific error code can be accessed using the GetLastResult() method.
*/
virtual IList* GetItemsN(int startIndex, int count) const;
/**
* Searches for an object in this list. @n
- * Gets the index of the object if found.
+ * Gets the @c index of the object if found.
*
* @since 2.0
*
* @return An error code
- * @param[in] obj The object to locate
- * @param[out] index The index of the object
+ * @param[in] obj The object to locate
+ * @param[out] index The index of the object
* @exception E_SUCCESS The method is successful.
- * @exception E_OBJ_NOT_FOUND The specified @c obj is not found.
+ * @exception E_OBJ_NOT_FOUND The specified @c obj has not been found.
*/
virtual result IndexOf(const Object& obj, int& index) const;
/**
- * Searches for an object starting from the specified index. @n
- * Gets the index of the object if found.
+ * Searches for an object starting from the specified @c startIndex. @n
+ * Gets the @c index of the object if found.
*
* @since 2.0
*
* @return An error code
- * @param[in] obj The object to locate
- * @param[in] startIndex The starting index for the search @n
- * It must be less than the number of elements.
- * @param[out] index The index of the object
+ * @param[in] obj The object to locate
+ * @param[in] startIndex The starting index for the search @n
+ * It must be less than the number of elements.
+ * @param[out] index The index of the object
* @exception E_SUCCESS The method is successful.
- * @exception E_OUT_OF_RANGE The specified index is outside the bounds of the data structure, or
- * the specified @c startIndex is either equal to or greater than the number of elements in the list or less than @c 0.
- * @exception E_OBJ_NOT_FOUND The specified @c obj is not found.
+ * @exception E_OUT_OF_RANGE Either of the following conditions has occurred:
+ * - The specified @c index is outside the bounds of the data structure.
+ * - The specified @c startIndex is either greater than or equal to the number of elements in the list.
+ * - The specified @c startIndex is less than @c 0.
+ * @exception E_OBJ_NOT_FOUND The specified @c obj has not been found.
* @see LastIndexOf()
*/
virtual result IndexOf(const Object& obj, int startIndex, int& index) const;
/**
* Searches for an object within the specified range. @n
- * Gets the index of the object if found.
+ * Gets the @c index of the object if found.
*
* @since 2.0
*
* @return An error code
- * @param[in] obj The object to locate
- * @param[in] startIndex The starting index of the range
- * @param[in] count The number of elements to read
- * @param[out] index The index of the object
+ * @param[in] obj The object to locate
+ * @param[in] startIndex The starting index of the range
+ * @param[in] count The number of elements to read
+ * @param[out] index The index of the object
* @exception E_SUCCESS The method is successful.
- * @exception E_OUT_OF_RANGE Either of the following conditions has occurred: @n
- * - The specified index is outside the bounds of the data structure. @n
- * - The specified @c startIndex is either equal to or greater than the number of elements in the list or less than @c 0. @n
- * - The specified @c count is either greater than the number of elements starting from @c startIndex or less than @c 0.
- * @exception E_OBJ_NOT_FOUND The specified @c obj is not found.
+ * @exception E_OUT_OF_RANGE Either of the following conditions has occurred:
+ * - The specified @c index is outside the bounds of the data structure.
+ * - The specified @c startIndex is either greater than or equal to the number of elements in the list.
+ * - The specified @c startIndex is less than @c 0.
+ * - The specified @c count is greater than the number of elements starting from @c startIndex.
+ * - The specified @c count is less than @c 0.
+ * @exception E_OBJ_NOT_FOUND The specified @c obj has not been found.
* @see LastIndexOf()
*/
virtual result IndexOf(const Object& obj, int startIndex, int count, int& index) const;
/**
* Searches for the last occurrence of an object in this list. @n
- * Gets the index of the object if found.
+ * Gets the @c index of the object if found.
*
* @since 2.0
*
* @return An error code
- * @param[in] obj The object to locate
- * @param[out] index The index of the last occurrence of the specified object
+ * @param[in] obj The object to locate
+ * @param[out] index The index of the last occurrence of the specified object
* @exception E_SUCCESS The method is successful.
- * @exception E_OBJ_NOT_FOUND The specified @c obj is not found.
+ * @exception E_OBJ_NOT_FOUND The specified @c obj has not been found.
* @see IndexOf()
*/
virtual result LastIndexOf(const Object& obj, int& index) const;
* @since 2.0
*
* @return An error code
- * @param[in] pObj The pointer to object to insert
- * @param[in] index The index at which the object must be inserted
+ * @param[in] pObj A pointer to the object to insert
+ * @param[in] index The index at which the object is inserted
* @exception E_SUCCESS The method is successful.
- * @exception E_INVALID_ARG The specified input parameter is invalid.
- * @exception E_OUT_OF_RANGE The specified index is outside the bounds of the data structure, or
- * the specified @c index is greater than the number of elements or less than @c 0.
- * @remarks If the @c index equals to the number of elements, then the new element
+ * @exception E_INVALID_ARG A specified input parameter is invalid.
+ * @exception E_OUT_OF_RANGE Either of the following conditions has occurred:
+ * - The specified @c index is outside the bounds of the data structure.
+ * - The specified @c index is greater than the number of elements.
+ * - The specified @c index is less than @c 0.
+ * @remarks
+ * - If the @c index is equal to the number of elements, then the new elements
* is added at the end of this list.
- * This method performs a shallow copy. It inserts just the pointer; not the element itself.
+ * - This method performs a shallow copy. It inserts just the pointer and not the element itself.
* @see Add()
* @see RemoveAt()
*/
* @since 2.0
*
* @return An error code
- * @param[in] collection The collection to insert elements from
- * @param[in] startIndex The starting index at which the elements must be inserted
+ * @param[in] collection The collection to insert elements from
+ * @param[in] startIndex The starting index at which the elements are inserted
* @exception E_SUCCESS The method is successful.
- * @exception E_OUT_OF_RANGE The specified index is outside the bounds of the data structure, or
- * the specified @c startIndex is either greater than the number of elements or less than @c 0.
- * @exception E_INVALID_OPERATION The current state of the instance prohibits the execution of the specified operation, or
- * the @c collection is modified during the operation of this method.
- * @remarks If the @c startIndex equals to the number of elements then the new elements
- * are added at the end of this list.
- * This method performs a shallow copy. It inserts just the pointer; not the element itself.
+ * @exception E_OUT_OF_RANGE Either of the following conditions has occurred:
+ * - The specified index is outside the bounds of the data structure.
+ * - The specified @c startIndex is greater than the number of elements.
+ * - The specified @c startIndex is less than @c 0.
+ * @exception E_INVALID_OPERATION Either of the following conditions has occurred:
+ * - The current state of the instance prohibits the execution of the specified operation.
+ * - The specified @c collection is modified during the operation of this method.
+ * @remarks
+ * - If the specified @c startIndex is equal to the number of elements, then the new elements
+ * are added at the end of this list.
+ * - This method performs a shallow copy. It inserts just the pointer and not the element itself.
* @see RemoveItems()
* @see AddItems()
*/
* @since 2.0
*
* @return An error code
- * @param[in] obj An object to remove
+ * @param[in] obj The object to remove
* @exception E_SUCCESS The method is successful.
- * @exception E_OBJ_NOT_FOUND The specified @c obj is not found.
+ * @exception E_OBJ_NOT_FOUND The specified @c obj has not been found.
* @see Add()
* @see RemoveAt()
*/
* @since 2.0
*
* @return An error code
- * @param[in] index The index at which the object must be removed
+ * @param[in] index The index at which the object is removed
* @exception E_SUCCESS The method is successful.
- * @exception E_OUT_OF_RANGE The specified index is outside the bounds of the data structure, or
- * The specified @c index is equal to or greater than the number of elements or less than @c 0.
+ * @exception E_OUT_OF_RANGE Either of the following conditions has occurred:
+ * - The specified @c index is outside the bounds of the data structure.
+ * - The specified @c index is either greater than or equal to the number of elements.
+ * - The specified @c index is less than @c 0.
* @see InsertAt()
*/
virtual result RemoveAt(int index);
/**
- * Removes all elements within the specified range from the list.
+ * Removes all the elements within the specified range from the list.
*
* @since 2.0
*
* @return An error code
- * @param[in] startIndex The starting index of the range
- * @param[in] count The number of element to remove
+ * @param[in] startIndex The starting index of the range
+ * @param[in] count The number of elements to remove
* @exception E_SUCCESS The method is successful.
- * @exception E_OUT_OF_RANGE Either of the following conditions has occurred: @n
- * - The specified index is outside the bounds of the data structure. @n
- * - The specified @c startIndex is either equal to or greater than the number of elements or less than @c 0. @n
- * - The specified @c count is either greater than the number of elements starting from @c startIndex or less than @c 0.
+ * @exception E_OUT_OF_RANGE Either of the following conditions has occurred:
+ * - The specified @c index is outside the bounds of the data structure.
+ * - The specified @c startIndex is either greater than or equal to the number of elements.
+ * - The specified @c startIndex is less than @c 0.
+ * - The specified @c count is greater than the number of elements starting from @c startIndex.
+ * - The specified @c count is less than @c 0.
* @see AddItems()
* @see InsertItemsFrom()
*/
* @return An error code
* @param[in] collection The collection to remove from this list
* @exception E_SUCCESS The method is successful.
- * @exception E_INVALID_OPERATION The current state of the instance prohibits the execution of the specified operation, or
- * the @c collection is modified during the operation of this method.
+ * @exception E_INVALID_OPERATION Either of the following conditions has occurred:
+ * - The current state of the instance prohibits the execution of the specified operation.
+ * - The specified @c collection is modified during the operation of this method.
* @see Remove()
* @see RemoveAt()
*/
/**
- * Removes all of the object pointers in the collection and also removes all of the objects depending on the specified element deleter.
+ * Removes all of the object pointers in the collection and also removes all the objects depending on the specified element deleter.
* This method can be called before deleting the objects in a collection.
*
* @since 2.0
virtual void RemoveAll(void);
/**
- * Replaces the object at the specified index with the given object.
+ * Replaces the object at the specified @c index with the given object.
*
* @since 2.0
*
* @return An error code
- * @param[in] pObj The pointer to object to set
- * @param[in] index The index at which the object must be set
+ * @param[in] pObj A pointer to the object to set
+ * @param[in] index The index at which the object is set
* @exception E_SUCCESS The method is successful.
- * @exception E_INVALID_ARG The specified input parameter is invalid.
- * @exception E_OUT_OF_RANGE The specified index is outside the bounds of the data structure, or
- * the specified @c index is equal to or greater than the number of elements or less than @c 0.
+ * @exception E_INVALID_ARG A specified input parameter is invalid.
+ * @exception E_OUT_OF_RANGE Either of the following conditions has occurred:
+ * - The specified @c index is outside the bounds of the data structure.
+ * - The specified @c index is either greater than or equal to the number of elements.
+ * - The specified @c index is less than @c 0.
* @see GetAt()
*/
virtual result SetAt(Object* pObj, int index);
/**
- * Sorts the elements of this list using the comparer provided.
+ * Sorts the elements of this list using the @c comparer provided.
*
* @since 2.0
*
* @return An error code
- * @param[in] comparer The IComparer implementation to use when comparing elements
+ * @param[in] comparer The IComparer implementation to use when comparing the elements
* @exception E_SUCCESS The method is successful.
- * @exception E_INVALID_ARG The specified input parameter is invalid, or
- * the @c comparer is not valid.
+ * @exception E_INVALID_ARG Either of the following conditions has occurred:
+ * - The specified input parameter is invalid.
+ * - The specified @c comparer is invalid.
*/
virtual result Sort(const IComparer& comparer);
virtual bool Contains(const Object& obj) const;
/**
- * Checks whether the list contains all the elements of the specified collection.
+ * Checks whether the list contains all the elements of the specified @c collection.
*
* @since 2.0
*
- * @return @c true if this list contains all of the elements in the specified collection, @n
+ * @return @c true if this list contains all the elements in the specified collection, @n
* else @c false
* @param[in] collection The collection to check for containment in this list
* @exception E_SUCCESS The method is successful.
- * @exception E_INVALID_OPERATION The current state of the instance prohibits the execution of the specified operation, or
- * the @c collection is modified during the operation of this method.
- * @remarks The specific error code can be accessed using the GetLastResult() method.
- * @remarks If the given @c collection is empty, this method will return @c true.
+ * @exception E_INVALID_OPERATION Either of the following conditions has occurred:
+ * - The current state of the instance prohibits the execution of the specified operation.
+ * - The @c collection is modified during the operation of this method.
+ * @remarks
+ * - The specific error code can be accessed using the GetLastResult() method.
+ * - If the given @c collection is empty, this method returns @c true.
* @see Contains()
*/
virtual bool ContainsAll(const ICollection& collection) const;
* @return @c true if the specified instance equals the current instance, @n
* else @c false
* @param[in] obj The object to compare with the calling object
- * @remarks This method returns @c true only if the specified object is also an instance of the %LinkedList class,
+ * @remarks
+ * - This method returns @c true only if the specified object is also an instance of the %LinkedList class,
* both lists have the same size, and all corresponding pairs of elements in the two lists are equal.
- * In other words, two lists are equal if they contain the same elements in the same order.
+ * - In other words, two lists are equal if they contain the same elements in the same order.
*/
virtual bool Equals(const Object& obj) const;
* @since 2.0
*
* @return The hash value of the current instance
- * @remarks The two Tizen::Base::Object::Equals() instances must return the same hash value. For better performance, @n
- * the used hash function must generate a random distribution for all inputs.
+ * @remarks The two Tizen::Base::Object::Equals() instances must return the same hash value. @n
+ * For better performance, the used hash function must generate a random distribution for all the inputs.
*/
virtual int GetHashCode(void) const;
/**
* Gets a node from Available node list.
*
- * @return A pointer to a new List Node if successful, @n
+ * @return A pointer to a new List Node, @n
* else @c null if no node is available
*/
_ListNode* GetNewNode(void);
/**
* @class LinkedListT
- * @brief This class represents a template-based collection of objects that can be individually accessed by index.
+ * @brief This class represents a template-based collection of objects that can be individually accessed by an index.
*
* @since 2.0
*
- * The %LinkedListT class represents a template-based collection of objects that can be individually accessed by index.
+ * The %LinkedListT class represents a template-based collection of objects that can be individually accessed by an index.
*
* For more information on the class features, see <a href="../org.tizen.native.appprogramming/html/guide/base/arraylist_linkedlist.htm">ArrayList and LinkedList</a>.
*
* @since 2.0
*
* @return An error code
- * @param[in] obj An object to add
+ * @param[in] obj The object to add
* @exception E_SUCCESS The method is successful.
* @exception E_OUT_OF_MEMORY The memory is insufficient.
* @see Remove()
* @since 2.0
*
* @return An error code
- * @param[in] collection A collection to add
+ * @param[in] collection The collection to add
* @exception E_SUCCESS The method is successful.
- * @exception E_INVALID_OPERATION The current state of the instance prohibits the execution of the specified operation, or
- * the specified @c collection is modified during the operation of this method.
+ * @exception E_INVALID_OPERATION Either of the following conditions has occurred:
+ * - The current state of the instance prohibits the execution of the specified operation.
+ * - The specified @c collection is modified during the operation of this method.
* @see RemoveItems()
*/
virtual result AddItems(const ICollectionT< Type >& collection)
}
/**
- * Gets an enumerator to this list.
+ * Gets the enumerator of this list.
*
* @since 2.0
*
- * @return An enumerator (an instance of the IEnumeratorT derived class) of this list, @n
+ * @return The enumerator (an instance of the IEnumeratorT derived class) of this list, @n
* else @c null if an exception occurs
* @exception E_SUCCESS The method is successful.
* @exception E_OUT_OF_MEMORY The memory is insufficient.
* @remarks The specific error code can be accessed using the GetLastResult() method.
- * @see Tizen::Base::Collection::IEnumeratorT
*/
virtual IEnumeratorT< Type >* GetEnumeratorN(void) const
{
}
/**
- * Gets a bidirectional enumerator (an instance of the IBidirectionalEnumeratorT derived class) of this list.
+ * Gets the bidirectional enumerator (an instance of the IBidirectionalEnumeratorT derived class) of this list.
*
* @since 2.0
*
- * @return An instance of the IBidirectionalEnumeratorT derived class if successful, @n
+ * @return An instance of the IBidirectionalEnumeratorT derived class, @n
* else @c null if an exception occurs
* @exception E_SUCCESS The method is successful.
* @exception E_OUT_OF_MEMORY The memory is insufficient.
- * @remarks Use this method to obtain a bidirectional enumerator (an instance of the IBidirectionalEnumeratorT derived class)
- * to iterate over a collection (an instance of the IListT derived class).
- * The specific error code can be accessed using the GetLastResult() method.
- * @see Tizen::Base::Collection::IBidirectionalEnumeratorT
+ * @remarks
+ * - Use this method to obtain a bidirectional enumerator (an instance of the IBidirectionalEnumeratorT derived class)
+ * to iterate over a collection (an instance of the IListT derived class).
+ * - The specific error code can be accessed using the GetLastResult() method.
*/
virtual IBidirectionalEnumeratorT< Type >* GetBidirectionalEnumeratorN(void) const
{
* @since 2.0
*
* @return An error code
- * @param[in] index The index of the object to read
- * @param[out] obj An object to get from this list
+ * @param[in] index The index of the object to read
+ * @param[out] obj The object to get from this list
* @exception E_SUCCESS The method is successful.
- * @exception E_OUT_OF_RANGE The specified index is outside the bounds of the data structure, or
- * the specified @c index is equal to or greater than the number of elements or less than @c 0.
+ * @exception E_OUT_OF_RANGE Either of the following conditions has occurred:
+ * - The specified @c index is outside the bounds of the data structure.
+ * - The specified @c index is either greater than or equal to the number of elements.
+ * - The specified @c index is less than @c 0.
* @see SetAt()
*/
virtual result GetAt(int index, Type& obj) const
* @since 2.0
*
* @return An error code
- * @param[in] index The index of the object to read
- * @param[out] obj An object to get from this list
+ * @param[in] index The index of the object to read
+ * @param[out] obj The object to get from this list
* @exception E_SUCCESS The method is successful.
- * @exception E_OUT_OF_RANGE The specified index is outside the bounds of the data structure, or
- * the specified @c index is equal to or greater than the number of elements or less than @c 0.
+ * @exception E_OUT_OF_RANGE Either of the following conditions has occurred:
+ * - The specified @c index is outside the bounds of the data structure.
+ * - The specified @c index is either greater than or equal to the number of elements.
+ * - The specified @c index is less than @c 0.
* @see SetAt()
*/
virtual result GetAt(int index, Type& obj)
* @since 2.0
*
* @return A pointer to the IListT derived instance, @n
- * else @c null if an exception occurs.
- * @param[in] startIndex The starting index of the range
- * @param[in] count The number of elements to read
+ * else @c null if an exception occurs
+ * @param[in] startIndex The starting index of the range
+ * @param[in] count The number of elements to read
* @exception E_SUCCESS The method is successful.
- * @exception E_OUT_OF_RANGE Either of the following conditions has occurred: @n
- * - The specified index is outside the bounds of the data structure. @n
- * - The specified @c startIndex is either equal to or greater than the number of elements or less than @c 0. @n
- * - The specified @c count is either greater than the number of elements starting from @c startIndex or less than @c 0.
+ * @exception E_OUT_OF_RANGE Either of the following conditions has occurred:
+ * - The specified @c index is outside the bounds of the data structure.
+ * - The specified @c startIndex is either greater than or equal to the number of elements.
+ * - The specified @c startIndex is less than @c 0. @n
+ * - The specified @c count is greater than the number of elements starting from @c startIndex.
+ * - The specified @c count is less than @c 0.
*
* @remarks The specific error code can be accessed using the GetLastResult() method.
*/
* @since 2.0
*
* @return An error code
- * @param[in] obj The object to locate
- * @param[out] index The index of the object
+ * @param[in] obj The object to locate
+ * @param[out] index The index of the object
* @exception E_SUCCESS The method is successful.
- * @exception E_OBJ_NOT_FOUND The specified @c obj is not found.
+ * @exception E_OBJ_NOT_FOUND The specified @c obj has not been found.
*/
virtual result IndexOf(const Type& obj, int& index) const
{
* @since 2.0
*
* @return An error code
- * @param[in] obj The object to locate
- * @param[in] startIndex The starting index for the search @n
- * It must be less than the number of elements.
- * @param[out] index The index of the object
+ * @param[in] obj The object to locate
+ * @param[in] startIndex The starting index for the search @n
+ * It must be less than the number of elements.
+ * @param[out] index The index of the object
* @exception E_SUCCESS The method is successful.
- * @exception E_OUT_OF_RANGE The specified index is outside the bounds of the data structure, or
- * the specified @c startIndex is either equal to or greater than the number of elements in the list or less than @c 0.
- * @exception E_OBJ_NOT_FOUND The specified @c obj is not found.
+ * @exception E_OUT_OF_RANGE Either of the following conditions has occurred:
+ * - The specified @c index is outside the bounds of the data structure.
+ * - The specified @c startIndex is either greater than or equal to the number of elements in the list.
+ * - The specified @c startIndex is less than @c 0.
+ * @exception E_OBJ_NOT_FOUND The specified @c obj has not been found.
* @see LastIndexOf()
*/
virtual result IndexOf(const Type& obj, int startIndex, int& index) const
* @since 2.0
*
* @return An error code
- * @param[in] obj The object to locate
- * @param[in] startIndex The starting index of the range
- * @param[in] count The number of elements to read
- * @param[out] index The index of the object
+ * @param[in] obj The object to locate
+ * @param[in] startIndex The starting index of the range
+ * @param[in] count The number of elements to read
+ * @param[out] index The index of the object
* @exception E_SUCCESS The method is successful.
- * @exception E_OUT_OF_RANGE Either of the following conditions has occurred: @n
- * - The specified index is outside the bounds of the data structure. @n
- * - The specified @c startIndex is either equal to or greater than the number of elements in the list or less than @c 0. @n
- * - The specified @c count is either greater than the number of elements starting from @c startIndex or less than @c 0.
- * @exception E_OBJ_NOT_FOUND The specified @c obj is not found.
+ * @exception E_OUT_OF_RANGE Either of the following conditions has occurred:
+ * - The specified @c index is outside the bounds of the data structure.
+ * - The specified @c startIndex is either greater than or equal to the number of elements in the list.
+ * - The specified @c startIndex is less than @c 0.
+ * - The specified @c count is greater than the number of elements starting from @c startIndex.
+ * - The specified @c count is less than @c 0.
+ * @exception E_OBJ_NOT_FOUND The specified @c obj has not been found.
* @see LastIndexOf()
*/
virtual result IndexOf(const Type& obj, int startIndex, int count, int& index) const
* @since 2.0
*
* @return An error code
- * @param[in] obj An object to insert
- * @param[in] index The index at which the object must be inserted
+ * @param[in] obj The object to insert
+ * @param[in] index The index at which the object is inserted
* @exception E_SUCCESS The method is successful.
- * @exception E_OUT_OF_RANGE The specified index is outside the bounds of the data structure, or
- * the specified @c index is greater than the number of elements or less than @c 0.
- * @remarks If the @c index equals to the number of elements then the new element
+ * @exception E_OUT_OF_RANGE Either of the following conditions has occurred:
+ * - The specified @c index is outside the bounds of the data structure.
+ * - The specified @c index is greater than the number of elements.
+ * - The specified @c index is less than @c 0.
+ * @remarks If the @c index is equal to the number of elements then the new elements
* is added at the end of this list.
* @see Add()
* @see RemoveAt()
/**
- * Inserts the elements of the @c collection at the location specified.
+ * Inserts the elements of the collection at the specified location.
*
* @since 2.0
*
* @return An error code
- * @param[in] collection The collection to insert
- * @param[in] startIndex The starting index at which the collection must be inserted
+ * @param[in] collection The collection to insert
+ * @param[in] startIndex The starting index at which the collection is inserted
* @exception E_SUCCESS The method is successful.
- * @exception E_OUT_OF_RANGE The specified index is outside the bounds of the data structure, or
- * the specified @c startIndex is either greater than the number of elements or less than @c 0.
- * @exception E_INVALID_OPERATION The current state of the instance prohibits the execution of the specified operation, or
- * the specified @c collection is modified during the operation of this method.
- * @remarks If the @c startIndex equals to the number of elements then the new elements
+ * @exception E_OUT_OF_RANGE Either of the following conditions has occurred:
+ * - The specified @c index is outside the bounds of the data structure.
+ * - The specified @c startIndex is greater than the number of elements.
+ * - The specified @c startIndex is less than @c 0.
+ * @exception E_INVALID_OPERATION Either of the following conditions has occurred:
+ * - The current state of the instance prohibits the execution of the specified operation.
+ * - The specified @c collection is modified during the operation of this method.
+ * @remarks If the @c startIndex is equal to the number of elements then the new elements
* are added at the end of this list.
* @see RemoveItems()
* @see AddItems()
* @since 2.0
*
* @return An error code
- * @param[in] obj The object to locate
- * @param[out] index The index of the last occurrence of the specified object
+ * @param[in] obj The object to locate
+ * @param[out] index The index of the last occurrence of the specified object
* @exception E_SUCCESS The method is successful.
- * @exception E_OBJ_NOT_FOUND The specified @c obj is not found.
+ * @exception E_OBJ_NOT_FOUND The specified @c obj has not been found.
* @see IndexOf()
*/
virtual result LastIndexOf(const Type& obj, int& index) const
* @since 2.0
*
* @return An error code
- * @param[in] obj An object to remove
+ * @param[in] obj The object to remove
* @exception E_SUCCESS The method is successful.
- * @exception E_OBJ_NOT_FOUND The specified @c obj is not found.
+ * @exception E_OBJ_NOT_FOUND The specified @c obj has not been found.
* @see Add()
* @see RemoveAt()
* @see RemoveAll()
}
/**
- * Removes all the elements in the specified @c collection.
+ * Removes all the elements from the specified collection.
*
* @since 2.0
*
* @return An error code
* @param[in] collection The collection to remove from this list
* @exception E_SUCCESS The method is successful.
- * @exception E_INVALID_OPERATION The current state of the instance prohibits the execution of the specified operation, or
- * the specified @c collection is modified during the operation of this method.
+ * @exception E_INVALID_OPERATION Either of the following conditions has occurred:
+ * - The current state of the instance prohibits the execution of the specified operation.
+ * - The specified @c collection is modified during the operation of this method.
* @see Remove()
* @see RemoveAt()
*/
* @since 2.0
*
* @return An error code
- * @param[in] index The index at which the object must be removed
+ * @param[in] index The index at which the object is removed
* @exception E_SUCCESS The method is successful.
- * @exception E_OUT_OF_RANGE The specified index is outside the bounds of the data structure, or
- * the specified @c index is equal to or greater than the number of elements or less than @c 0.
+ * @exception E_OUT_OF_RANGE Either of the following conditions has occurred:
+ * - The specified @c index is outside the bounds of the data structure.
+ * - The specified @c index is greater than the number of elements.
+ * - The specified @c index is less than @c 0.
* @see InsertAt()
*/
virtual result RemoveAt(int index)
}
/**
- * Removes all elements within the specified range.
+ * Removes all the elements within the specified range.
*
* @since 2.0
*
* @return An error code
- * @param[in] startIndex The starting index of the range
- * @param[in] count The number of elements to read
+ * @param[in] startIndex The starting index of the range
+ * @param[in] count The number of elements to read
* @exception E_SUCCESS The method is successful.
- * @exception E_OUT_OF_RANGE Either of the following conditions has occurred: @n
- * - The specified index is outside the bounds of the data structure. @n
- * - The specified @c startIndex is either equal to or greater than the number of elements or less than @c 0. @n
- * - The specified @c count is either greater than the number of elements starting from @c startIndex or less than @c 0.
+ * @exception E_OUT_OF_RANGE Either of the following conditions has occurred:
+ * - The specified @c index is outside the bounds of the data structure.
+ * - The specified @c startIndex is either greater than or equal to the number of elements.
+ * - The specified @c startIndex is less than @c 0.
+ * - The specified @c count is greater than the number of elements starting from @c startIndex.
+ * - The specified @c count is less than @c 0.
* @see AddItems()
* @see InsertItemsFrom()
*/
* @since 2.0
*
* @return An error code
- * @param[in] obj An object to set
- * @param[in] index The index at which the object must be set
+ * @param[in] obj The object to set
+ * @param[in] index The index at which the object is set
* @exception E_SUCCESS The method is successful.
- * @exception E_OUT_OF_RANGE The specified index is outside the bounds of the data structure, or
- * the specified @c index is equal to or greater than the number of elements or less than @c 0.
+ * @exception E_OUT_OF_RANGE Either of the following conditions has occurred:
+ * - The specified @c index is outside the bounds of the data structure.
+ * - The specified @c index is either greater than or equal to the number of elements.
+ * - The specified @c index is less than @c 0.
* @see GetAt()
*/
virtual result SetAt(const Type& obj, int index)
* @return An error code
* @param[in] comparer The IComparerT implementation to use when comparing the elements
* @exception E_SUCCESS The method is successful.
- * @exception E_INVALID_ARG A specified input parameter is invalid, or
- * the @c comparer is not valid.
+ * @exception E_INVALID_ARG Either of the following conditions has occurred:
+ * - The specified input parameter is invalid.
+ * - The specified @c comparer is invalid.
*/
virtual result Sort(const IComparerT< Type >& comparer)
{
* @since 2.0
*
* @return An error code
- * @param[in] collection The collection to check for containment in this list
- * @param[out] out Set to @c true if this list contains all of the elements in the specified collection, @n
- * else @c false
+ * @param[in] collection The collection to check for containment in this list
+ * @param[out] out Set to @c true if this list contains all of the elements in the specified collection, @n
+ * else @c false
* @exception E_SUCCESS The method is successful.
- * @exception E_INVALID_OPERATION The current state of the instance prohibits the execution of the specified operation, or
- * the specified @c collection is modified during the operation of this method.
- * @remarks If the given @c collection is empty, the @c out parameter is set to @c true.
+ * @exception E_INVALID_OPERATION Either of the following conditions has occurred:
+ * - The current state of the instance prohibits the execution of the specified operation.
+ * - The specified @c collection is modified during the operation of this method.
+ * @remarks If the given @c collection is empty, then @c out is set to @c true.
* @see Contains()
*/
virtual result ContainsAll(const ICollectionT< Type >& collection, bool& out) const
*
* @since 2.0
*
- * @return @c true if the specified instance equals to the current instance, @n
+ * @return @c true if the specified instance equals the current instance, @n
* else @c false
* @param[in] obj The object to compare with the calling object
- * @remarks This method returns @c true only if the specified object is also an instance of LinkedList class,
- * both lists have the same size, and all corresponding pairs of elements in the two lists are equal.
- * In other words, two lists are equal if they contain the same elements in the same order.
+ * @remarks This method returns @c true only if the specified object is also an instance of the LinkedList class,
+ * both lists have the same size, and all the corresponding pairs of elements in the two lists are equal. @n
+ * In other words, the two lists are equal if they contain the same elements in the same order.
*/
virtual bool Equals(const Object& obj) const
{
* @since 2.0
*
* @return The hash value of the current instance
- * @remarks The two Tizen::Base::Object::Equals() instances must return the same hash value. For better performance, @n
- * the used hash function must generate a random distribution for all inputs.
+ * @remarks The two Tizen::Base::Object::Equals() instances must return the same hash value. @n
+ * For better performance, the used hash function must generate a random distribution for all the inputs.
*/
virtual int GetHashCode(void) const
{
*
* @since 2.0
*
- * @param[in] obj An object to include in this node
+ * @param[in] obj The object to include in this node
*/
__LinkedListNodeT(const Type& obj)
: pPrev(null)
*
* @since 2.0
*
- * @param[in] list A list to enumerate
+ * @param[in] list The list to enumerate
* @param[in] modCount The modification count to detect the change in the list
*/
__LinkedListEnumeratorT(const LinkedListT< Type >& list, int modCount)
* @since 2.0
*
* @return An error code
- * @param[out] obj The current object
- * @exception E_INVALID_OPERATION Either of the following conditions has occurred: @n
- * - The current state of the instance prohibits the execution of the specified operation. @n
+ * @param[out] obj The current object
+ * @exception E_INVALID_OPERATION Either of the following conditions has occurred:
+ * - The current state of the instance prohibits the execution of the specified operation.
* - This enumerator is currently positioned before the first element or
- * past the last element. @n
- - The list is modified after this enumerator is created.
- * @exception E_SUCCESS The method is successful.
+ * past the last element.
+ * - The list is modified after this enumerator is created.
+ * @exception E_SUCCESS The method is successful.
*/
result GetCurrent(Type& obj) const
{
/**
* Moves this enumerator to the next element of the list. @n
- * When this enumerator is first created or after call to Reset(),
+ * When this enumerator is first created or after a call to Reset(),
* the first call to MoveNext() positions this enumerator to the first element in the list.
*
* @since 2.0
*
* @return An error code
* @exception E_SUCCESS The method is successful.
- * @exception E_INVALID_OPERATION The current state of the instance prohibits the execution of the specified operation, or
- * the list is modified after this enumerator is created.
+ * @exception E_INVALID_OPERATION Either of the following conditions has occurred:
+ * - The current state of the instance prohibits the execution of the specified operation.
+ * - The list is modified after this enumerator is created.
* @exception E_OUT_OF_RANGE The enumerator has passed the end of the list.
* @see Reset()
*/
}
/**
- * Positions this enumerator before the first elements in the list.
+ * Positions this enumerator before the first element in the list.
*
* @since 2.0
*
* @return An error code
* @exception E_SUCCESS The method is successful.
- * @exception E_INVALID_OPERATION The current state of the instance prohibits the execution of the specified operation, or
- * the list is modified after this enumerator is created.
+ * @exception E_INVALID_OPERATION Either of the following conditions has occurred:
+ * - The current state of the instance prohibits the execution of the specified operation.
+ * - The list is modified after this enumerator is created.
*/
result Reset(void)
{
*
* @since 2.0
*
- * @param[in] key The key
+ * @param[in] key The key
* @param[in] value The value
*/
MapEntry(const Object& key, const Object& value);
virtual Object* GetValue(void);
/**
- * Compares the value of the given Object to the
+ * Compares the value of the given Tizen::Base::Object to the
* value of the calling object.
*
* @since 2.0
* @return @c true if the values are equal, @n
* else @c false
* @param[in] obj The object to compare with the calling object
- * @remarks Returns @c false if the given object is not a %MapEntry object.
+ * @remarks This method returns @c false if the given object is not a %MapEntry object.
*/
virtual bool Equals(const Object& obj) const;
* @since 2.0
*
* @return The hash value of the current instance
- * @remarks The two Tizen::Base::Object::Equals() instances must return the same hash value. For better performance, @n
- * the used hash function must generate a random distribution for all inputs.
+ * @remarks The two Tizen::Base::Object::Equals() instances must return the same hash value. @n
+ * For better performance, the used hash function must generate a random distribution for all the inputs.
*/
virtual int GetHashCode(void) const;
* @since 2.0
*
* @return The hash value of the current instance
- * @remarks The two Tizen::Base::Object::Equals() instances must return the same hash value. For better performance, @n
- * the used hash function must generate a random distribution for all inputs.
+ * @remarks The two Tizen::Base::Object::Equals() instances must return the same hash value. @n
+ * For better performance, the used hash function must generate a random distribution for all the inputs.
*/
virtual int GetHashCode(void) const
{
*
* @since 2.0
*
- * The %MultiHashMap class represents a collection of associated keys and values that are organized based on the hash code of the key.
- * There is no limit on the number of elements with the same key, but duplicated elements with the same key are not allowed.
- * The key and value cannot be @c null.
+ * The %MultiHashMap class represents a collection of associated keys and values that are organized based on the hash code of the key.
+ * There is no limit on the number of elements having the same key, but duplicate elements with the same key are not allowed.
+ * The key and value cannot be a @c null.
* @n
* For more information on the class features, see <a href="../org.tizen.native.appprogramming/html/guide/base/hashmap_multihashmap.htm">HashMap and MultiHashMap</a>.
*
*
* @since 2.0
*
- * @param[in] deleter The function pointer to type of the element deleter
- * @remarks To create an owning collection, set the element deleter value as @c SingleObjectDeleter. This gives the collection the ownership of elements and the collection will destroy elements. @n
- * On the other hand, to create a non-owning collection, you do not need to set the element deleter value, as @c NoOpDeleter is the default element deleter.
- * It means that you do not transfer the ownership of elements to the collection.
+ * @param[in] deleter A function pointer to the type of the element deleter
+ * @remarks To create an owning collection, set the element deleter value as @c SingleObjectDeleter. @n
+ * This gives the collection the ownership of the elements and the collection destroys the elements. @n
+ * On the other hand, to create a non-owning collection, do not set the element deleter value, as @c NoOpDeleter is the default element deleter. @n
+ * It means that the ownership of the elements is not transferred to the collection.
* @see NoOpDeleter()
* @see SingleObjectDeleter()
* @see ArrayDeleter()
virtual ~MultiHashMap(void);
/**
- * Initializes a new instance of %MultiHashMap with the specified capacity and load factor.
+ * Initializes a new instance of %MultiHashMap with the specified @c capacity and @c loadFactor.
*
* @since 2.0
*
* @param[in] capacity The initial capacity
* @param[in] loadFactor The maximum ratio of elements to buckets
* @exception E_SUCCESS The method is successful.
- * @exception E_INVALID_ARG A specified input parameter is invalid, or
- * the @c capacity or the @c loadFactor is negative.
+ * @exception E_INVALID_ARG Either of the following conditions has occurred:
+ * - A specified input parameter is invalid.
+ * - The specified @c capacity or the specified @c loadFactor is negative.
* @remarks The GetHashCode() method of the key object is used for hashing and the
* Equals() method of the key object is used for comparing the keys.
* @see MultiHashMap()
result Construct(int capacity = 16, float loadFactor = 0.75);
/**
- * Initializes a new instance of %MultiHashMap by copying the elements of the given map.
+ * Initializes a new instance of %MultiHashMap by copying the elements of the given @c map.
*
* @since 2.0
*
* @return An error code
- * @param[in] map The map to copy
- * @param[in] loadFactor The maximum ratio of elements to buckets @n
- * If it is @c 0, the default load factor(0.75) is used.
+ * @param[in] map The map to copy
+ * @param[in] loadFactor The maximum ratio of elements to buckets @n
+ * If it is @c 0, the default load factor(0.75) is used.
* @exception E_SUCCESS The method is successful.
* @exception E_INVALID_ARG The specified @c loadFactor is negative.
- * @exception E_INVALID_OPERATION The current state of the instance prohibits the execution of the specified operation, or
- * the @c map is modified during the operation of this method.
- * @remarks This method performs a shallow copy. It copies just the pointer; not the element itself.
+ * @exception E_INVALID_OPERATION Either of the following conditions has occurred:
+ * - The current state of the instance prohibits the execution of the specified operation.
+ * - The specified @c map is modified during the operation of this method.
+ * @remarks This method performs a shallow copy. It copies just the pointer and not the element itself.
* @see MultiHashMap()
*/
result Construct(const IMultiMap& map, float loadFactor = 0.75);
* @since 2.0
*
* @return An error code
- * @param[in] capacity The initial capacity @n
- * If it is @c 0, the default capacity (16) is used.
- * @param[in] loadFactor The maximum ratio of elements to buckets @n
- * If it is @c 0, the default load factor (0.75) is used.
- * @param[in] provider An instance of the IHashCodeProvider derived class that supplies the hash codes
- * for all keys in this map
- * @param[in] comparer An instance of the IComparer derived class to use when comparing keys
+ * @param[in] capacity The initial capacity @n
+ * If it is @c 0, the default capacity (16) is used.
+ * @param[in] loadFactor The maximum ratio of elements to buckets @n
+ * If it is @c 0, the default load factor (0.75) is used.
+ * @param[in] provider An instance of the IHashCodeProvider derived class that supplies the hash codes
+ * for all the keys in this map
+ * @param[in] comparer An instance of the IComparer derived class to use when comparing the keys
* @exception E_SUCCESS The method is successful.
- * @exception E_INVALID_ARG A specified input parameter is invalid, or
- * the @c capacity or the @c loadFactor is negative.
- * @remarks The instances of hash code provider and comparer will not be deallocated later from this map.
+ * @exception E_INVALID_ARG Either of the following conditions has occurred:
+ * - A specified input parameter is invalid.
+ * - The specfied @c capacity or the specified @c loadFactor is negative.
+ * @remarks The instances of the hash code provider and the comparer are not deallocated later from this map.
* @see MultiHashMap()
*/
result Construct(int capacity, float loadFactor, const IHashCodeProvider& provider, const IComparer& comparer);
* @since 2.0
*
* @return An error code
- * @param[in] map A map to copy
- * @param[in] loadFactor The maximum ratio of elements to buckets @n
- * If it is @c 0, the default load factor (0.75) is used.
- * @param[in] provider An instance of the IHashCodeProvider derived class that supplies the hash codes
- * for all keys in this map
- * @param[in] comparer An instance of the IComparer derived class to use when comparing keys
+ * @param[in] map A map to copy
+ * @param[in] loadFactor The maximum ratio of elements to buckets @n
+ * If it is @c 0, the default load factor (0.75) is used.
+ * @param[in] provider An instance of the IHashCodeProvider derived class that supplies the hash codes
+ * for all the keys in this map
+ * @param[in] comparer An instance of the IComparer derived class to use when comparing the keys
* @exception E_SUCCESS The method is successful.
- * @exception E_INVALID_ARG A specified input parameter is invalid, or
- * the @c loadFactor is negative.
- * @exception E_INVALID_OPERATION The current state of the instance prohibits the execution of the specified operation, or
- * the @c map is modified during the operation of this method.
- * @remarks This method performs a shallow copy. It copies just the pointer; not the element itself.
- * The instances of hash code provider and comparer will not be deallocated later from this map.
+ * @exception E_INVALID_ARG Either of the following conditions has occurred:
+ * - A specified input parameter is invalid.
+ * - The specified @c loadFactor is negative.
+ * @exception E_INVALID_OPERATION Either of the following conditions has occurred:
+ * - The current state of the instance prohibits the execution of the specified operation.
+ * - The specified @c map is modified during the operation of this method.
+ * @remarks
+ * - This method performs a shallow copy. It copies just the pointer and not the element itself.
+ * - The instances of the hash code provider and the comparer are not deallocated later from this map.
* @see MultiHashMap()
*/
result Construct(const IMultiMap& map, float loadFactor, const IHashCodeProvider& provider, const IComparer& comparer);
* @since 2.0
*
* @return An error code
- * @param[in] pKey The pointer to key to add
- * @param[in] pValue The pointer to corresponding value to add
+ * @param[in] pKey A pointer to the key to add
+ * @param[in] pValue A pointer to the corresponding value to add
* @exception E_SUCCESS The method is successful.
* @exception E_OBJ_ALREADY_EXIST The specified pair of @c pKey and @c pValue already exists.
- * @exception E_INVALID_ARG A specified input parameter is invalid, or
- * the comparer has failed to compare the keys.
- * @remarks This method performs a shallow copy. It adds just the pointer; not the element itself.
+ * @exception E_INVALID_ARG Either of the following conditions has occurred:
+ * - A specified input parameter is invalid.
+ * - The comparer has failed to compare the keys.
+ * @remarks This method performs a shallow copy. It adds just the pointer and not the element itself.
* @see Remove()
*/
virtual result Add(Object* pKey, Object* pValue);
/**
- * Gets an enumerator of this map.
+ * Gets the enumerator of this map.
*
* @since 2.0
*
- * @return An enumerator (an instance of the IEnumerator derived class) of this map, @n
- * else @c null if some exception occurs
- * @remarks If the key has multiple values, the enumeration proceeds as follows: {A: a}, {B: b}, {B: c}, {B, d}, {C: e}, ...
- * The specific error code can be accessed using the GetLastResult() method.
- * @see IMapEnumerator
+ * @return The enumerator (an instance of the IEnumerator derived class) of this map, @n
+ * else @c null if an exception occurs
+ * @remarks
+ * - If the key has multiple values, the enumeration proceeds as follows:
+ * {A: a}, {B: b}, {B: c}, {B, d}, {C: e}, ...
+ * - The specific error code can be accessed using the GetLastResult() method.
+ * @see IMapEnumerator()
*/
virtual IEnumerator* GetEnumeratorN(void) const;
/**
- * Gets an enumerator of this map.
+ * Gets the enumerator of this map.
*
* @since 2.0
*
- * @return An enumerator (an instance of the IMapEnumerator derived class) of this map, @n
- * else @c null if some exception occurs
- * @remarks If the key has multiple values, the enumeration proceeds as follows: {A: a}, {B: b}, {B: c}, {B, d}, {C: e}, ...
- * The specific error code can be accessed using the GetLastResult() method.
- * @see IEnumerator
+ * @return The enumerator (an instance of the IMapEnumerator derived class) of this map, @n
+ * else @c null if an exception occurs
+ * @remarks
+ * - If the key has multiple values, the enumeration proceeds as follows:
+ * {A: a}, {B: b}, {B: c}, {B, d}, {C: e}, ...
+ * - The specific error code can be accessed using the GetLastResult() method.
+ * @see IEnumerator()
*/
virtual IMapEnumerator* GetMapEnumeratorN(void) const;
/**
- * Gets an enumerator of the values associated with the specified key.
+ * Gets the enumerator of the values associated with the specified key.
*
* @since 2.0
*
- * @return An enumerator (an instance of the IEnumerator derived class) of the values associated with the specified key, @n
- * else @c null if some exception occurs
- * @param[in] key A key to locate
+ * @return The enumerator (an instance of the IEnumerator derived class) of the values associated with the specified key, @n
+ * else @c null if an exception occurs
+ * @param[in] key The key to locate
* @exception E_SUCCESS The method is successful.
- * @exception E_INVALID_ARG A specified input parameter is invalid, or
- * the comparer has failed to compare the keys.
- * @exception E_OBJ_NOT_FOUND The specified @c key is not found in the map.
+ * @exception E_INVALID_ARG Either of the following conditions has occurred:
+ * - A specified input parameter is invalid.
+ * - The comparer has failed to compare the keys.
+ * @exception E_OBJ_NOT_FOUND The specified @c key has not been found in the map.
* @remarks The specific error code can be accessed using the GetLastResult() method.
* @see SetValue()
*/
virtual IEnumerator* GetValuesN(const Object& key) const;
/**
- * Gets a list of all unique keys in this map.
+ * Gets a list of all the unique keys in this map.
*
* @since 2.0
*
- * @return A list of all unique keys in this map
- * @remarks The %IList stores just the pointers to the elements in the map, not the elements themselves.
- * The specific error code can be accessed using the GetLastResult() method.
+ * @return The list of all the unique keys in this map
+ * @remarks
+ * - The IList stores just the pointers to the elements in the map and not the elements themselves.
+ * - The specific error code can be accessed using the GetLastResult() method.
* @see GetValuesN()
*/
virtual IList* GetKeysN(void) const;
/**
- * Gets a list of all the values in this map.
+ * Gets the list of all the values in this map.
*
* @since 2.0
*
- * @return A list of all the values in this map
- * @remarks The IList stores just the pointers to the elements in the map, not the elements themselves.
- * The specific error code can be accessed using the GetLastResult() method.
+ * @return The list of all the values in this map
+ * @remarks
+ * - The IList stores just the pointers to the elements in the map and not the elements themselves.
+ * - The specific error code can be accessed using the GetLastResult() method.
* @see GetKeysN()
*/
virtual IList* GetValuesN(void) const;
* @return An error code
* @param[in] key The key to remove
* @exception E_SUCCESS The method is successful.
- * @exception E_INVALID_ARG A specified input parameter is invalid, or
- * the comparer has failed to compare keys.
- * @exception E_OBJ_NOT_FOUND The specified @c key is not found in the map.
+ * @exception E_INVALID_ARG Either of the following conditions has occurred:
+ * - The specified input parameter is invalid.
+ * - The comparer has failed to compare the keys.
+ * @exception E_OBJ_NOT_FOUND The specified @c key has not been found in the map.
* @see Add()
*/
virtual result Remove(const Object& key);
* @since 2.0
*
* @return An error code
- * @param[in] key The key whose mapping is to remove from the map
- * @param[in] value The value to remove
+ * @param[in] key The key whose mapping is removed from the map
+ * @param[in] value The value to remove
* @exception E_SUCCESS The method is successful.
- * @exception E_INVALID_ARG A specified input parameter is invalid, or
- * the comparer has failed to compare the keys.
- * @exception E_OBJ_NOT_FOUND The specified @c key and @c value pair is not found in the map.
+ * @exception E_INVALID_ARG Either of the following conditions has occurred:
+ * - A specified input parameter is invalid.
+ * - The comparer has failed to compare the keys.
+ * @exception E_OBJ_NOT_FOUND The specified @c key and @c value pair has not been found in the map.
* @remarks The specified key is also removed if there are no more values associated with it.
* @see Add()
*/
virtual result Remove(const Object& key, const Object& value);
/**
- * Removes all the object pointers in the @c collection. @n
+ * Removes all the object pointers in the collection. @n
*
* @since 2.0
*
- * @remarks This method can be called before deleting @c collection.
+ * @remarks This method can be called before deleting the collection.
*/
virtual void RemoveAll(void);
/**
- * Sets the value associated with the given key with a new value.
+ * Sets the value associated with the given key to a new value.
*
* @since 2.0
*
* @return An error code
- * @param[in] key The key for which the associated value needs to replace
- * @param[in] value The value to replace
- * @param[in] pNewValue The pointer to new value to replace the existing value
+ * @param[in] key The key for which the associated value is replaced
+ * @param[in] value The value to replace
+ * @param[in] pNewValue A pointer to the new value that replaces the existing value
* @exception E_SUCCESS The method is successful.
- * @exception E_INVALID_ARG A specified input parameter is invalid, or
- * the comparer has failed to compare the keys.
- * @exception E_OBJ_NOT_FOUND The specified @c key and @c value pair is not found in the map.
+ * @exception E_INVALID_ARG Either of the following conditions has occurred:
+ * - A specified input parameter is invalid.
+ * - The comparer has failed to compare the keys.
+ * @exception E_OBJ_NOT_FOUND The specified @c key and @c value pair has not been found in the map.
* @remarks To add a new key-value pair, use the Add() method.
* @see Add()
* @see GetValuesN()
virtual int GetCount(void) const;
/**
- * Gets the number of values whose key matches the key.
+ * Gets the number of values whose key matches the given key.
*
* @since 2.0
*
* @return An error code
- * @param[in] key A key to locate
- * @param[out] count The number of values whose key is the @c key
+ * @param[in] key A key to locate
+ * @param[out] count The number of values whose key matches the given key
* @exception E_SUCCESS The method is successful.
- * @exception E_INVALID_ARG A specified input parameter is invalid, or
- * the comparer has failed to compare the keys.
- * @exception E_OBJ_NOT_FOUND The specified @c key is not found in the map.
+ * @exception E_INVALID_ARG Either of the following conditions has occurred:
+ * - A specified input parameter is invalid.
+ * - The comparer has failed to compare the keys.
+ * @exception E_OBJ_NOT_FOUND The specified @c key has not been found in the map.
*/
virtual result GetCount(const Object& key, int& count) const;
/**
- * Checks whether the map contains the specified key and value.
+ * Checks whether the map contains the specified key and value pair.
*
* @since 2.0
*
* @return @c true if the map contains the specified key and value pair, @n
* else @c false
- * @param[in] key The key to locate
- * @param[in] value The value to locate
+ * @param[in] key The key to locate
+ * @param[in] value The value to locate
* @exception E_SUCCESS The method is successful.
- * @exception E_INVALID_ARG A specified input parameter is invalid, or
- * the comparer has failed to compare the keys.
+ * @exception E_INVALID_ARG Either of the following conditions has occurred:
+ * - A specified input parameter is invalid.
+ * - The comparer has failed to compare the keys.
* @remarks The specific error code can be accessed using the GetLastResult() method.
* @see ContainsKey()
* @see ContainsValue()
* else @c false
* @param[in] key The key to locate
* @exception E_SUCCESS The method is successful.
- * @exception E_INVALID_ARG A specified input parameter is invalid, or
- * the comparer has failed to compare the keys.
+ * @exception E_INVALID_ARG Either of the following conditions has occurred:
+ * - A specified input parameter is invalid.
+ * - The comparer has failed to compare the keys.
* @remarks The specific error code can be accessed using the GetLastResult() method.
* @see ContainsValue()
* @see Contains()
* @return @c true if the two instances are equal, @n
* @c false
* @param[in] obj The object to compare with the current instance
- * @remarks This method returns @c true only if the specified object is also an instance of %MultiHashMap class,
- * both maps have the same number of elements, and both maps contain the same elements.
+ * @remarks This method returns @c true only if the specified object is also an instance of the %MultiHashMap class,
+ * both the maps have the same number of elements, and both the maps contain the same elements.
*/
virtual bool Equals(const Object& obj) const;
* @since 2.0
*
* @return The hash value of the current instance
- * @remarks The two Tizen::Base::Object::Equals() instances must return the same hash value. For better performance, @n
- * the used hash function must generate a random distribution for all inputs.
+ * @remarks The two Tizen::Base::Object::Equals() instances must return the same hash value. @n
+ * For better performance, the used hash function must generate a random distribution for all the inputs.
*/
virtual int GetHashCode(void) const;
/**
* @class MultiHashMapT
- * @brief This class represents a template-based collection of associated keys and values that are organized based on the hash code of the key.
+ * @brief This class represents a template-based collection of associated keys and values that are organized based on the hash code of a key.
*
* @since 2.0
*
- * The %MultiHashMapT class represents a template-based collection of associated keys and values that are organized based on the hash code of the key.
- * There is no limit on the number of elements with the same key, but duplicated elements with the same key are not allowed.
- * The key and value cannot be null. Several methods in the %MultiHashMapT class need an assignment(=) operator of KeyType, and assignment(=) and equivalent(==) operators of ValueType.
+ * The %MultiHashMapT class represents a template-based collection of associated keys and values that are organized based on the hash code of a key.
+ * There is no limit on the number of elements having the same key, but duplicate elements with the same key are not allowed.
+ * The key and value cannot be @c null. Several methods in the %MultiHashMapT class need an assignment(=) operator of KeyType, as well as assignment(=) and equivalent(==) operators of ValueType.
* @n
* For more information on the class features, see <a href="../org.tizen.native.appprogramming/html/guide/base/hashmap_multihashmap.htm">HashMap and MultiHashMap</a>.
*
* @since 2.0
*
* @return An error code
- * @param[in] capacity The initial capacity
- * @param[in] loadFactor The maximum ratio of elements to buckets
- * @exception E_SUCCESS The method is successful.
- * @exception E_INVALID_ARG A specified input parameter is invalid, or
- * the specified @c capacity or the @c loadFactor is negative.
+ * @param[in] capacity The initial capacity
+ * @param[in] loadFactor The maximum ratio of elements to buckets
+ * @exception E_SUCCESS The method is successful.
+ * @exception E_INVALID_ARG Either of the following conditions has occurred:
+ * - A specified input parameter is invalid.
+ * - The specified @c capacity or the specified @c loadFactor is negative.
* @remarks The key type must be a primitive data type.
* @see MultiHashMapT()
*/
* @since 2.0
*
* @return An error code
- * @param[in] map A map to copy
- * @param[in] loadFactor The maximum ratio of elements to buckets @n
- * If it is @c 0, the default load factor(0.75) is used.
+ * @param[in] map The map to copy
+ * @param[in] loadFactor The maximum ratio of elements to buckets @n
+ * If it is @c 0, the default load factor(0.75) is used.
* @exception E_SUCCESS The method is successful.
- * @exception E_INVALID_ARG A specified input parameter is invalid, or
- * the specified @c loadFactor is negative.
- * @exception E_INVALID_OPERATION The current state of the instance prohibits the execution of the specified operation, or
- * the @c map is modified during the operation of this method.
+ * @exception E_INVALID_ARG Either of the following conditions has occurred:
+ * - A specified input parameter is invalid
+ * - The specified @c loadFactor is negative.
+ * @exception E_INVALID_OPERATION Either of the following conditions has occurred:
+ * - The current state of the instance prohibits the execution of the specified operation.
+ * - The specified @c map is modified during the operation of this method.
* @see MultiHashMapT()
*/
result Construct(const IMultiMapT< KeyType, ValueType >& map, float loadFactor = 0.75)
* @since 2.0
*
* @return An error code
- * @param[in] capacity The initial capacity @n
- * If it is @c 0, the default capacity(16) is used.
- * @param[in] loadFactor The maximum ratio of elements to buckets @n
- * If it is @c 0, the default load factor(0.75) is used.
- * @param[in] provider An instance of the IHashCodeProvider derived class that supplies the hash codes
- * for all keys in this map
- * @param[in] comparer An instance of the IComparer derived class to use when comparing keys
+ * @param[in] capacity The initial capacity @n
+ * If it is @c 0, the default capacity(16) is used.
+ * @param[in] loadFactor The maximum ratio of elements to buckets @n
+ * If it is @c 0, the default load factor(0.75) is used.
+ * @param[in] provider An instance of the IHashCodeProvider derived class that supplies the hash codes
+ * for all the keys in this map
+ * @param[in] comparer An instance of the IComparer derived class to use when comparing the keys
* @exception E_SUCCESS The method is successful.
- * @exception E_INVALID_ARG A specified input parameter is invalid, or
- * the specified @c capacity or the @c loadFactor is negative.
- * @remarks The instances of hash code provider and comparer will not be deallocated later from this map.
+ * @exception E_INVALID_ARG Either of the following conditions has occurred:
+ * - A specified input parameter is invalid.
+ * - The specified @c capacity or the specified @c loadFactor is negative.
+ * @remarks The instances of hash code provider and the comparer are not deallocated later from this map.
* @see MultiHashMapT()
*/
result Construct(int capacity, float loadFactor, const IHashCodeProviderT< KeyType >& provider,
* @since 2.0
*
* @return An error code
- * @param[in] map A map to copy
- * @param[in] loadFactor The maximum ratio of elements to buckets @n
- * If it is @c 0, the default load factor(0.75) is used.
- * @param[in] provider An instance of the IHashCodeProvider derived class that supplies the hash codes
- * for all keys in this map
- * @param[in] comparer An instance of the IComparer derived class to use when comparing keys
+ * @param[in] map The map to copy
+ * @param[in] loadFactor The maximum ratio of elements to buckets @n
+ * If it is @c 0, the default load factor(0.75) is used.
+ * @param[in] provider An instance of the IHashCodeProvider derived class that supplies the hash codes
+ * for all the keys in this map
+ * @param[in] comparer An instance of the IComparer derived class to use when comparing the keys
* @exception E_SUCCESS The method is successful.
- * @exception E_INVALID_ARG A specified input parameter is invalid, or
- * the specified @c loadFactor is negative.
- * @exception E_INVALID_OPERATION The current state of the instance prohibits the execution of the specified operation, or
- * the @c map is modified during the operation of this method.
- * @remarks The instances of hash code provider and comparer will not be deallocated later from this map.
+ * @exception E_INVALID_ARG Either of the following conditions has occurred:
+ * - A specified input parameter is invalid.
+ * - The specified @c loadFactor is negative.
+ * @exception E_INVALID_OPERATION Either of the following conditions has occurred:
+ * - The current state of the instance prohibits the execution of the specified operation.
+ * - The specified @c map is modified during the operation of this method.
+ * @remarks The instances of the hash code provider and the comparer are not deallocated later from this map.
* @see MultiHashMapT()
*/
result Construct(const IMultiMapT< KeyType, ValueType >& map, float loadFactor, const IHashCodeProviderT< KeyType >& provider,
* @since 2.0
*
* @return An error code
- * @param[in] key A key of the value to add
- * @param[in] value A value to add
+ * @param[in] key The key of the value to add
+ * @param[in] value The value to add
* @exception E_SUCCESS The method is successful.
- * @exception E_OBJ_ALREADY_EXIST The specified pair of @c key and @c value already exists.
- * @exception E_INVALID_ARG A specified input parameter is invalid, or
- * the comparer has failed to compare the keys.
- * @remarks SetItem() can be used to set value to a key that does not already exist.
- * However, setting a value to a key that already exists overwrites the value.
+ * @exception E_OBJ_ALREADY_EXIST The specified @c key and @c value pair already exists.
+ * @exception E_INVALID_ARG Either of the following conditions has occurred:
+ * - A specified input parameter is invalid.
+ * - The comparer has failed to compare the keys.
+ * @remarks SetItem() can be used to set a value to a key that does not already exist. @n
+ * However, setting a value to a key that already exists overwrites this value.
* @see Remove()
* @see SetValue()
*/
}
/**
- * Gets an enumerator of this map.
+ * Gets the enumerator of this map.
*
* @since 2.0
*
- * @return An enumerator (an instance of the %IMapEnumeratorT derived class) of this map, @n
+ * @return The enumerator (an instance of the IMapEnumeratorT derived class) of this map, @n
* else @c null if an exception occurs
* @exception E_SUCCESS The method is successful.
* @exception E_OUT_OF_MEMORY The memory is insufficient.
- * @remarks If the key has multiple values, the Enumeration proceeds as follows: {A: a}, {B: b}, {B: c}, {B, d}, {C: e}, ...
- * The specific error code can be accessed using the GetLastResult() method.
+ * @remarks
+ * - If the key has multiple values, the enumeration proceeds as follows: @n
+ * {A: a}, {B: b}, {B: c}, {B, d}, {C: e}, ...
+ * - The specific error code can be accessed using the GetLastResult() method.
* @see Tizen::Base::Collection::IEnumerator
* @see Tizen::Base::Collection::IMapEnumerator
*/
}
/**
- * Gets an IMapEnumerator of this map.
+ * Gets the IMapEnumerator of this map.
*
* @since 2.0
*
- * @return An enumerator (an instance of the %IMapEnumeratorT derived class) of this map, @n
+ * @return The enumerator (an instance of the IMapEnumeratorT derived class) of this map, @n
* else @c null if an exception occurs
- * @exception E_SUCCESS The method is successful.
- * @exception E_OUT_OF_MEMORY The memory is insufficient.
- * @remarks If the key has multiple values, the Enumeration proceeds like this: {A: a}, {B: b}, {B: c}, {B, d}, {C: e}, ...
- * @remarks The specific error code can be accessed using the GetLastResult() method.
+ * @exception E_SUCCESS The method is successful.
+ * @exception E_OUT_OF_MEMORY The memory is insufficient.
+ * @remarks
+ * - If the key has multiple values, the enumeration proceeds like this: @n
+ * {A: a}, {B: b}, {B: c}, {B, d}, {C: e}, ...
+ * - The specific error code can be accessed using the GetLastResult() method.
* @see Tizen::Base::Collection::IEnumerator
* @see Tizen::Base::Collection::IMapEnumerator
*/
}
/**
- * Gets an enumerator of the values associated with the specified key.
+ * Gets the enumerator of the values associated with the specified key.
*
* @since 2.0
*
- * @return An enumerator (an instance of the IEnumeratorT derived class) of the values associated with the specified key, @n
+ * @return The enumerator (an instance of the IEnumeratorT derived class) of the values associated with the specified key, @n
* else @c null if an exception occurs
- * @param[in] key A key to locate
+ * @param[in] key The key to locate
* @exception E_SUCCESS The method is successful.
- * @exception E_INVALID_ARG A specified input parameter is invalid, or
- * the comparer has failed to compare the keys.
- * @exception E_OBJ_NOT_FOUND The specified @c key is not found in the map.
+ * @exception E_INVALID_ARG Either of the following conditions has occurred:
+ * - A specified input parameter is invalid.
+ * - The comparer has failed to compare the keys.
+ * @exception E_OBJ_NOT_FOUND The specified @c key has not been found in the map.
* @remarks The specific error code can be accessed using the GetLastResult() method.
* @see SetValue()
*/
}
/**
- * Gets a list of all unique keys in this map.
+ * Gets a list of all the unique keys in this map.
*
* @since 2.0
*
- * @return A list of all unique keys in this map, @n
+ * @return The list of all the unique keys in this map, @n
* else @c null if an exception occurs
* @exception E_SUCCESS The method is successful.
* @exception E_OUT_OF_MEMORY The memory is insufficient.
*
* @since 2.0
*
- * @return A list of all the values in this map, @n
+ * @return The list of all the values in this map, @n
* else @c null if an exception occurs
* @exception E_SUCCESS The method is successful.
* @exception E_OUT_OF_MEMORY The memory is insufficient.
* @return An error code
* @param[in] key The key to remove
* @exception E_SUCCESS The method is successful.
- * @exception E_INVALID_ARG The specified input parameter is invalid, or
- * the comparer has failed to compare the keys.
- * @exception E_OBJ_NOT_FOUND The specified @c key is not found in the map.
+ * @exception E_INVALID_ARG Either of the following conditions has occurred:
+ * - The specified input parameter is invalid.
+ * - The comparer has failed to compare the keys.
+ * @exception E_OBJ_NOT_FOUND The specified @c key has not been found in the map.
* @see Add()
*/
virtual result Remove(const KeyType& key)
* @since 2.0
*
* @return An error code
- * @param[in] key The key whose mapping is to remove from the map
- * @param[in] value The value to remove
+ * @param[in] key The key whose mapping is removed from the map
+ * @param[in] value The value to remove
* @exception E_SUCCESS The method is successful.
- * @exception E_INVALID_ARG A specified input parameter is invalid, or
- * the comparer has failed to compare the keys.
+ * @exception E_INVALID_ARG Either of the following conditions has occurred:
+ * - A specified input parameter is invalid.
+ * - The comparer has failed to compare the keys.
* @exception E_OBJ_NOT_FOUND The specified @c key and @c value pair is not found in the map.
* @see Add()
*/
}
/**
- * Removes all key-value pairs in this map.
+ * Removes all the key-value pairs in this map.
*
* @since 2.0
*/
}
/**
- * Replaces the value associated with the key with the specified @c newValue.
+ * Replaces the value associated with the key, with the specified @c newValue.
*
* @since 2.0
*
* @return An error code
- * @param[in] key A key
- * @param[in] value A value to replace
- * @param[in] newValue A new value to replace the existing value
+ * @param[in] key The key
+ * @param[in] value The value to replace
+ * @param[in] newValue The new value to replace the existing value
* @exception E_SUCCESS The method is successful.
- * @exception E_INVALID_ARG A specified input parameter is invalid, or
- * the comparer has failed to compare the keys.
+ * @exception E_INVALID_ARG Either of the following conditions has occurred:
+ * - The specified input parameter is invalid.
+ * - The comparer has failed to compare the keys.
* @exception E_OBJ_NOT_FOUND The specified @c key and @c value pair is not found in the map.
* @remarks To add a new key-value pair, use the Add() method.
- * @see Add()
* @see GetValuesN()
*/
virtual result SetValue(const KeyType& key, const ValueType& value, const ValueType& newValue)
* @since 2.0
*
* @return An error code
- * @param[in] key A key to locate
- * @param[out] count The number of values whose key is @c key
+ * @param[in] key The key to locate
+ * @param[out] count The number of values whose key is @c key
* @exception E_SUCCESS The method is successful.
- * @exception E_INVALID_ARG A specified input parameter is invalid, or
- * the comparer has failed to compare the keys.
+ * @exception E_INVALID_ARG Either of the following conditions has occurred:
+ * - A specified input parameter is invalid.
+ * - The comparer has failed to compare the keys.
* @exception E_OBJ_NOT_FOUND The specified @c key is not found in the map.
*/
virtual result GetCount(const KeyType& key, int& count) const
* @since 2.0
*
* @return An error code
- * @param[in] key The key to locate
- * @param[in] value The value to locate
- * @param[out] out Set to @c true if the map contains the specified key and value pair, @n
- * else @c false
+ * @param[in] key The key to locate
+ * @param[in] value The value to locate
+ * @param[out] out Set to @c true if the map contains the specified key and value pair, @n
+ * else @c false
* @exception E_SUCCESS The method is successful.
- * @exception E_INVALID_ARG The current state of the instance prohibits the execution of the specified operation, or
- * the comparer has failed to compare the keys.
+ * @exception E_INVALID_ARG Either of the following conditions has occurred:
+ * - The current state of the instance prohibits the execution of the specified operation.
+ * - The comparer has failed to compare the keys.
* @see ContainsKey()
* @see ContainsValue()
*/
* @since 2.0
*
* @return An error code
- * @param[in] key The key to locate
- * @param[out] out Set to @c true if the map contains the specified key, @n
- * else @c false
+ * @param[in] key The key to locate
+ * @param[out] out Set to @c true if the map contains the specified key, @n
+ * else @c false
* @exception E_SUCCESS The method is successful.
- * @exception E_INVALID_ARG A specified input parameter is invalid, or
- * the comparer has failed to compare the keys.
+ * @exception E_INVALID_ARG Either of the following conditions has occurred:
+ * - A specified input parameter is invalid.
+ * - The comparer has failed to compare the keys.
* @see ContainsValue()
* @see Contains()
*/
* else @c false
* @param[in] obj The object to compare with the current instance
* @remarks This method returns @c true only if the specified object is also an instance of the %MultiHashMapT class,
- * both maps have the same number of elements, and both maps contain the same elements.
+ * both the maps have the same number of elements, and both the maps contain the same elements.
*/
virtual bool Equals(const Object& obj) const
{
* @since 2.0
*
* @return The hash value of the current instance
- * @remarks The two Tizen::Base::Object::Equals() instances must return the same hash value. For better performance, @n
- * the used hash function must generate a random distribution for all inputs.
+ * @remarks The two Tizen::Base::Object::Equals() instances must return the same hash value. @n
+ * For better performance, the used hash function must generate a random distribution for all the inputs.
*/
virtual int GetHashCode(void) const
{
*
* @since 2.0
*
- * @param[in] v An object to include in this node
+ * @param[in] v The object to include in this node
*/
__ValueNodeT(const ValueType& v)
: pNext(null)
*
* @since 2.0
*
- * @param[in] keyType A key to include in this entry
- * @param[in] list A list of values whose key is specified @n
+ * @param[in] keyType The key to include in this entry
+ * @param[in] list The list of values whose key is specified @n
* It cannot be @c null.
* @param[in] next A pointer to the next entry
- * @param[in] h An hash value of the key
+ * @param[in] h The hash value of the key
*/
__MultiHashMapEntryT(const KeyType& keyType, __ValueNodeT< ValueType >* list, __MultiHashMapEntryT< KeyType, ValueType >* next, int h)
: key(keyType)
*
* @since 2.0
*
- * @param[in] map A map to enumerate
+ * @param[in] map The map to enumerate
* @param[in] modCount The modification count to detect the change in the map
*/
__MultiHashMapEnumeratorT(const MultiHashMapT< KeyType, ValueType >& map, int modCount)
*
* @return An error code
* @param[out] obj The current object
- * @exception E_INVALID_OPERATION Either of the following conditions has occurred: @n
+ * @exception E_INVALID_OPERATION Either of the following conditions has occurred:
* - The current state of the instance prohibits the execution of the specified operation. @n
* - This enumerator is currently positioned before the first element or
- * past the last element. @n
+ * past the last element.
* - The map is modified after this enumerator is created.
* @exception E_SUCCESS The method is successful.
*/
/**
* Moves this enumerator to the next element of the map. @n
* After the enumerator is first created or reset using the Reset() method,
- * the first call to this method positions the enumerator to the first element in the @c collection.
+ * the first call to this method positions the enumerator to the first element in the collection.
*
* @since 2.0
*
* @return An error code
* @exception E_SUCCESS The method is successful.
- * @exception E_INVALID_OPERATION The current state of the instance prohibits the execution of the specified operation, or
- * the map is modified after this enumerator is created.
+ * @exception E_INVALID_OPERATION Either of the following conditions has occurred:
+ * - The current state of the instance prohibits the execution of the specified operation.
+ * - The map is modified after this enumerator is created.
* @exception E_OUT_OF_RANGE The enumerator has passed the end of the map.
* @see Reset()
*/
*
* @return An error code
* @exception E_SUCCESS The method is successful.
- * @exception E_INVALID_OPERATION The current state of the instance prohibits the execution of the specified operation, or
- * the map is modified after this enumerator is created.
+ * @exception E_INVALID_OPERATION Either of the following conditions has occurred:
+ * - The current state of the instance prohibits the execution of the specified operation.
+ * - The map is modified after this enumerator is created.
*/
result Reset(void)
{
*
* @return An error code
* @param[out] key The current key
- * @exception E_INVALID_OPERATION Either of the following conditions has occurred: @n
+ * @exception E_INVALID_OPERATION Either of the following conditions has occurred:
* - The current state of the instance prohibits the execution of the specified operation. @n
* - This enumerator is currently positioned before the first element or
- * past the last element. @n
- * - The map is modified after this enumerator is created.
+ * past the last element. @n
+ * - The map is modified after this enumerator is created.
* @exception E_SUCCESS The method is successful.
*/
result GetKey(KeyType& key) const
*
* @return An error code
* @param[out] value The current value
- * @exception E_INVALID_OPERATION Either of the following conditions has occurred: @n
+ * @exception E_INVALID_OPERATION Either of the following conditions has occurred:
* - The current state of the instance prohibits the execution of the specified operation. @n
* - This enumerator is currently positioned before the first element or
- * past the last element. @n
+ * past the last element. @n
* - The map is modified after the enumerator is created.
* @exception E_SUCCESS The method is successful.
*/
*
* @since 2.0
*
- * @param[in] entry An entry to enumerate
+ * @param[in] entry The entry to enumerate
* @param[in] modCount The modification count to detect the change in the entry
*/
__EntryValueEnumeratorT(const __MultiHashMapEntryT< KeyType, ValueType >& entry, int modCount)
*
* @return An error code
* @param[out] obj The current value
- * @exception E_INVALID_OPERATION Either of the following conditions has occurred: @n
+ * @exception E_INVALID_OPERATION Either of the following conditions has occurred:
* - The current state of the instance prohibits the execution of the specified operation. @n
* - This enumerator is currently positioned before the first element or
- * past the last element. @n
+ * past the last element.
* - The entry is modified after this enumerator is created.
* @exception E_SUCCESS The method is successful.
*/
*
* @return An error code
* @exception E_SUCCESS The method is successful.
- * @exception E_INVALID_OPERATION The current state of the instance prohibits the execution of the specified operation, or
- * the entry is modified after this enumerator is created.
+ * @exception E_INVALID_OPERATION Either of the following conditions has occurred:
+ * - The current state of the instance prohibits the execution of the specified operation.
+ * - The entry is modified after this enumerator is created.
* @exception E_OUT_OF_RANGE The enumerator has passed the end of the entry.
* @see Reset()
*/
*
* @return An error code
* @exception E_SUCCESS The method is successful.
- * @exception E_INVALID_OPERATION The current state of the instance prohibits the execution of the specified operation, or
- * the entry is modified after this enumerator is created.
+ * @exception E_INVALID_OPERATION Either of the following conditions has occurred:
+ * - The current state of the instance prohibits the execution of the specified operation.
+ * - The entry is modified after this enumerator is created.
*/
result Reset(void)
{
*
* @since 2.1
*
- * @remarks The %PairIteratorT class satisfies only requirements of C++ standard library InputIterator concept due to limitations of %Tizen Collection.
- * So, this class can be used with C++ standard library algorithms which requires only InputIterator concept for their arguments.
+ * @remarks The %PairIteratorT class satisfies only requirements of the C++ standard library InputIterator concept due to the limitations of the %Tizen Collection. @n
+ * This class can be used with the C++ standard library algorithms which require only the InputIterator concept for their arguments.
*
* The %PairIteratorT class provides an iterator that is used to convert IMap or IMultiMap to STL containers.
* StlConverter provides static methods to get this iterator from IMap or IMultiMap.
{
public:
/**
- * Initializes this instance of %PairIteratorT class.
+ * Initializes this instance of the %PairIteratorT class.
*
* @since 2.1
*
* @param[in] map A reference to the IMap instance to convert
- * @param[in] isPostEnd A boolean value to check the end
+ * @param[in] isPostEnd The boolean value to check the end of the @c map
*/
explicit PairIteratorT(const IMap& map, bool isPostEnd = false)
: __pMap(&map)
}
/**
- * Initializes this instance of %PairIteratorT class.
+ * Initializes this instance of the %PairIteratorT class.
*
* @since 2.1
*
* @param[in] multiMap A reference to the IMultiMap instance to convert
- * @param[in] isPostEnd A boolean value to check the end
+ * @param[in] isPostEnd The boolean value to check the end of the @c multiMap
*/
PairIteratorT(const IMultiMap& multiMap, bool isPostEnd = false)
: __pMap(null)
* @param[in] rhs A reference to the %PairIteratorT instance
* @exception E_SUCCESS The method is successful.
* @exception E_INVALID_ARG Both @c __pMap and @c __pMultiMap are @c null.
- * @exception E_INVALID_OPERATION The current state of the instance prohibits the execution of the specified operation, or
- * the collection is modified after the enumerator is created.
+ * @exception E_INVALID_OPERATION Either of the following conditions has occurred:
+ * - The current state of the instance prohibits the execution of the specified operation.
+ * - The collection is modified after the enumerator is created.
* @remarks The specific error code can be accessed using GetLastResult() method.
*/
PairIteratorT(const PairIteratorT< K, V >& rhs)
}
/**
- * This is assignment operator of the %PairIteratorT class.
+ * This is the assignment operator of the %PairIteratorT class.
*
* @since 2.1
*
* @param[in] rhs A reference to the %PairIteratorT instance on the right-hand side of the operator
* @exception E_SUCCESS The method is successful.
* @exception E_INVALID_ARG Both @c __pMap and @c __pMultiMap are @c null.
- * @exception E_INVALID_OPERATION The current state of the instance prohibits the execution of the specified operation, or
- * the collection is modified after the enumerator is created.
+ * @exception E_INVALID_OPERATION Either of the following conditions has occurred:
+ * - The current state of the instance prohibits the execution of the specified operation.
+ * - The collection is modified after the enumerator is created.
* @remarks The specific error code can be accessed using GetLastResult() method.
*/
PairIteratorT< K, V >& operator =(const PairIteratorT< K, V >& rhs)
*
* @since 2.1
*
- * @return A std::pair type reference with K and V type
+ * @return A std::pair type reference with K and V types
*/
std::pair< K, V >& operator *(void) const
{
}
/**
- * This is the const version structure dereference operator for the %PairIteratorT class.
+ * This is the constant version structure dereference operator for the %PairIteratorT class.
*
* @since 2.1
*
* @return A reference to the %PairIteratorT instance
* @exception E_SUCCESS The method is successful.
* @exception E_OUT_OF_RANGE The enumerator has passed the end of the collection.
- * @exception E_INVALID_OPERATION The current state of the instance prohibits the execution of the specified operation, or
- * the collection is modified after the enumerator is created.
+ * @exception E_INVALID_OPERATION Either of the following conditions has occurred:
+ * - The current state of the instance prohibits the execution of the specified operation.
+ * - The collection is modified after the enumerator is created.
* @remarks The specific error code can be accessed using GetLastResult() method.
*/
PairIteratorT< K, V >& operator ++(void)
* @return A %PairIteratorT instance
* @exception E_SUCCESS The method is successful.
* @exception E_OUT_OF_RANGE The enumerator has passed the end of the collection.
- * @exception E_INVALID_OPERATION The current state of the instance prohibits the execution of the specified operation, or
- * the collection is modified after the enumerator is created.
+ * @exception E_INVALID_OPERATION Either of the following conditions has occurred:
+ * - The current state of the instance prohibits the execution of the specified operation.
+ * - The collection is modified after the enumerator is created.
* @remarks The specific error code can be accessed using GetLastResult() method.
*/
PairIteratorT< K, V > operator ++(int)
* @param[in] capacity The number of elements in the queue @n
* The default capacity is @c 10.
* @exception E_SUCCESS The method is successful.
- * @exception E_INVALID_ARG The specified input parameter is invalid, or
- * the specified @c capacity is negative.
- * @remarks If the number of elements added to the queue reaches the current capacity,
- * the capacity is automatically increased by memory reallocation.
+ * @exception E_INVALID_ARG Either of the following conditions has occurred:
+ * - The specified input parameter is invalid.
+ * - The specified @c capacity is negative.
+ * @remarks If the number of elements added to the queue reaches the current capacity,
+ * the capacity is automatically increased by memory reallocation. @n
* Therefore, if the size of the queue can be estimated,
* specifying the initial capacity eliminates the need to perform a number of
* resizing operations while adding elements to the queue.
* @return An error code
* @param[in] collection The collection to copy elements from
* @exception E_SUCCESS The method is successful.
- * @exception E_INVALID_OPERATION The current state of the instance prohibits the execution of the specified operation, or
- * the @c collection is modified during the operation of this method.
- * @remarks This method performs a shallow copy. It copies just the pointer; not the element itself.
+ * @exception E_INVALID_OPERATION Either of the following conditions has occurred:
+ * - The current state of the instance prohibits the execution of the specified operation.
+ * - The @c collection is modified during the operation of this method.
+ * @remarks This method performs a shallow copy. It copies just the pointer and not the element itself.
* @see Queue()
*/
result Construct(const ICollection& collection);
* @return The element at the beginning of this queue, @n
* else @c null if this queue is empty
* @exception E_SUCCESS The method is successful.
- * @exception E_UNDERFLOW The operation (arithmetic/casting/conversion) has caused an underflow, or
- * this queue is empty.
+ * @exception E_UNDERFLOW Either of the following conditions has occurred:
+ * - The operation (arithmetic/casting/conversion) has caused an underflow.
+ * - The queue is empty.
* @remarks The specific error code can be accessed using the GetLastResult() method.
* @see Enqueue(Object*)
*/
* Inserts an object at the end of this queue.
*
* @brief <i> [Deprecated] </i>
- * @deprecated This method is deprecated because it has a problem of const reference argument.
+ * @deprecated This method is deprecated because it has a problem of constant reference argument.
* Instead of using this method, use Enqueue(Object* pObj).
* @since 2.0
*
* @param[in] obj The object to add to this queue
* @exception E_SUCCESS The method is successful.
* @exception E_OUT_OF_MEMORY The memory is insufficient.
- * @remarks This method performs a shallow copy. It inserts just the pointer; not the element itself.
+ * @remarks This method performs a shallow copy. It inserts just the pointer and not the element itself.
* @see Dequeue()
* @endif
*/
* @since 2.0
*
* @return An error code
- * @param[in] pObj The pointer to object to add to this queue
+ * @param[in] pObj A pointer to the object to add to this queue
* @exception E_SUCCESS The method is successful.
* @exception E_INVALID_ARG The specified input parameter is invalid.
- * @remarks This method performs a shallow copy. It inserts just the pointer; not the element itself.
+ * @remarks This method performs a shallow copy. It inserts just the pointer and not the element itself.
* @see Dequeue()
*/
virtual result Enqueue(Object* pObj);
/**
- * Gets an enumerator of this queue.
+ * Gets the enumerator of this queue.
*
* @since 2.0
*
- * @return An enumerator (an instance of the IEnumerator derived class) of this queue, @n
+ * @return The enumerator (an instance of the IEnumerator derived class) of this queue, @n
* else @c null if an exception occurs
* @remarks The specific error code can be accessed using the GetLastResult() method.
- * @see IEnumerator
*/
virtual IEnumerator* GetEnumeratorN(void) const;
/**
- * Gets the element at the front of this queue without removing it.
+ * Gets the element at the beginning of this queue without removing it.
*
* @since 2.0
*
* @return The element at the beginning of this queue, @n
* else @c null if this queue is empty
* @exception E_SUCCESS The method is successful.
- * @exception E_UNDERFLOW The operation (arithmetic/casting/conversion) has caused an underflow, or
- * this queue is empty.
+ * @exception E_UNDERFLOW Either of the following conditions has occurred:
+ * - The operation (arithmetic/casting/conversion) has caused an underflow.
+ * - The queue is empty.
* @remarks The specific error code can be accessed using the GetLastResult() method.
*/
virtual const Object* Peek(void) const;
/**
- * Removes all objects and their pointers in collection, when the @c deallocate parameter is set to @c true.
+ * Removes all the objects and their pointers from the collection, when the @c deallocate parameter is set to @c true.
*
* @since 2.0
*
* Checks whether this queue contains all the elements in the specified collection.
*
* @brief <i> [Deprecated] </i>
- * @deprecated This method is deprecated because it transfers a result of comparison in out-parameter form.
- * The return type will be changed into boolean type and this method will return the result.
+ * @deprecated This method is deprecated because it transfers the result of the comparison in an out-parameter form.
+ * The return type is changed to boolean and this method returns the result.
* Instead of using this method, use bool ContainsAll(const ICollection& collection).
* @since 2.0
*
* @return An error code
- * @param[in] collection The collection to locate
- * @param[out] out Set to @c true if this queue contains all the elements in the specified collection, @n
- * else @c false
+ * @param[in] collection The collection to locate
+ * @param[out] out Set to @c true if this queue contains all the elements in the specified collection, @n
+ * else @c false
* @exception E_SUCCESS The method is successful.
- * @exception E_INVALID_OPERATION The current state of the instance prohibits the execution of the specified operation, or
- * the @c collection is modified during the operation of this method.
+ * @exception E_INVALID_OPERATION Either of the following conditions has occurred:
+ * - The current state of the instance prohibits the execution of the specified operation.
+ * - The @c collection is modified during the operation of this method.
* @endif
*/
result ContainsAll(const ICollection& collection, bool& out) const
* else @c false
* @param[in] collection The collection to locate
* @exception E_SUCCESS The method is successful.
- * @exception E_INVALID_OPERATION The current state of the instance prohibits the execution of the specified operation, or
- * the @c collection is modified during the operation of this method.
+ * @exception E_INVALID_OPERATION Either of the following conditions has occurred:
+ * - The current state of the instance prohibits the execution of the specified operation.
+ * - The @c collection is modified during the operation of this method.
* @remarks The specific error code can be accessed using the GetLastResult() method.
*/
virtual bool ContainsAll(const ICollection& collection) const;
* @return @c true if the specified instance equals the current instance, @n
* else @c false
* @param[in] obj The object to compare with the current instance
- * @remarks This method returns @c true if and only if the specified object is also an instance of %Queue class,
- * both queues have the same size, and all corresponding pairs of elements in the two queues are equal.
+ * @remarks This method returns @c true if and only if the specified object is also an instance of the %Queue class,
+ * both queues have the same size, and all the corresponding pairs of elements in the two queues are equal. @n
* In other words, two queues are equal if they contain the same elements in the same order.
*/
virtual bool Equals(const Object& obj) const;
* @since 2.0
*
* @return The hash value of the current instance
- * @remarks The two Tizen::Base::Object::Equals() instances must return the same hash value. For better performance, @n
- * the used hash function must generate a random distribution for all inputs.
+ * @remarks The two Tizen::Base::Object::Equals() instances must return the same hash value. @n
+ * For better performance, the used hash function must generate a random distribution for all the inputs.
*/
virtual int GetHashCode(void) const;
/**
* @class QueueT
- * @brief This represents a template-based queue (a first-in-first-out collection of objects).
+ * @brief This class represents a template-based queue (a first-in-first-out collection of objects).
*
* @since 2.0
*
* The default capacity is @c 10.
* @exception E_SUCCESS The method is successful.
* @exception E_OUT_OF_MEMORY The memory is insufficient.
- * @exception E_INVALID_ARG The specified input parameter is invalid, or
- * the specified @c capacity is negative.
+ * @exception E_INVALID_ARG Either of the following conditions has occurred:
+ * - The specified input parameter is invalid.
+ * - The specified @c capacity is negative.
*/
result Construct(int capacity = DEFAULT_CAPACITY)
{
* @param[in] collection The collection to copy the elements from
* @exception E_SUCCESS The method is successful.
* @exception E_OUT_OF_MEMORY The memory is insufficient.
- * @exception E_INVALID_OPERATION The current state of the instance prohibits the execution of the specified operation, or
- * the @c collection is modified during the operation of this method.
+ * @exception E_INVALID_OPERATION Either of the following conditions has occurred:
+ * - The current state of the instance prohibits the execution of the specified operation.
+ * - The specified @c collection is modified during the operation of this method.
* @see QueueT()
*/
result Construct(const ICollectionT< Type >& collection)
* @return An error code
* @param[out] obj The element at the beginning of this queue
* @exception E_SUCCESS The method is successful.
- * @exception E_UNDERFLOW The operation (arithmetic/casting/conversion) has caused an underflow, or
- * this queue is empty.
+ * @exception E_UNDERFLOW Either of the following conditions has occurred:
+ * - The operation (arithmetic/casting/conversion) has caused an underflow.
+ * - The queue is empty.
* @see Enqueue()
*/
virtual result Dequeue(Type& obj)
}
/**
- * Removes all the elements in this queue.
+ * Removes all the elements from this queue.
*
* @since 2.0
*/
}
/**
- * Gets an enumerator of this queue.
+ * Gets the enumerator of this queue.
*
* @since 2.0
*
- * @return An enumerator (an instance of the IEnumeratorT derived class) of this queue, @n
+ * @return The enumerator (an instance of the IEnumeratorT derived class) of this queue, @n
* else @c null if an exception occurs
* @exception E_SUCCESS The method is successful.
* @exception E_OUT_OF_MEMORY The memory is insufficient.
* @remarks The specific error code can be accessed using the GetLastResult() method.
- * @see Tizen::Base::Collection::IEnumeratorT
*/
virtual IEnumeratorT< Type >* GetEnumeratorN(void) const
{
* @return An error code
* @param[out] obj The element at the beginning of this queue
* @exception E_SUCCESS The method is successful.
- * @exception E_UNDERFLOW The operation (arithmetic/casting/conversion) has caused an underflow, or
- * this queue is empty.
+ * @exception E_UNDERFLOW Either of the following conditions has occurred:
+ * - The operation (arithmetic/casting/conversion) has caused an underflow.
+ * - The queue is empty.
*/
virtual result Peek(Type& obj) const
{
* @param[out] out Set to @c true if this queue contains all of the elements in the specified collection, @n
* else @c false
* @exception E_SUCCESS The method is successful.
- * @exception E_INVALID_OPERATION The current state of the instance prohibits the execution of the specified operation, or
- * the specified @c collection is modified during the operation of this method.
+ * @exception E_INVALID_OPERATION Either of the following conditions has occurred:
+ * - The current state of the instance prohibits the execution of the specified operation.
+ * - The specified @c collection is modified during the operation of this method.
* @exception E_OUT_OF_MEMORY The memory is insufficient.
*/
virtual result ContainsAll(const ICollectionT< Type >& collection, bool& out) const
* @return @c true if the specified instance equals the current instance, @n
* else @c false
* @param[in] obj The object to compare with the current instance
- * @remarks This method returns @c true if and only if the specified object is also an instance of %QueueT class,
- * both queues have the same size, and all corresponding pairs of elements in the two queues are equal.
+ * @remarks This method returns @c true if and only if the specified object is also an instance of the %QueueT class,
+ * both queues have the same size, and all the corresponding pairs of elements in the two queues are equal. @n
* In other words, two queues are equal if they contain the same elements in the same order.
*/
virtual bool Equals(const Object& obj) const
* @since 2.0
*
* @return The hash value of the current instance
- * @remarks The two Tizen::Base::Object::Equals() instances must return the same hash value. For better performance, @n
- * the used hash function must generate a random distribution for all inputs.
+ * @remarks The two Tizen::Base::Object::Equals() instances must return the same hash value. @n
+ * For better performance, the used hash function must generate a random distribution for all the inputs.
*/
virtual int GetHashCode(void) const
{
*
* @since 2.0
*
- * @param[in] queue A queue to enumerate
+ * @param[in] queue The queue to enumerate
* @param[in] modeCount The modification count to detect the change in the queue
*/
__QueueEnumeratorT(const QueueT< Type >& queue, int modeCount)
*
* @return An error code
* @param[out] obj The current object
- * @exception E_INVALID_OPERATION Either of the following conditions has occurred: @n
+ * @exception E_INVALID_OPERATION Either of the following conditions has occurred:
* - The current state of the instance prohibits the execution of the specified operation. @n
* - This enumerator is currently positioned before the first element or
- * past the last element. @n
+ * past the last element.
* - The queue is modified after this enumerator is created.
* @exception E_SUCCESS The method is successful.
*/
*
* @return An error code
* @exception E_SUCCESS The method is successful.
- * @exception E_INVALID_OPERATION The current state of the instance prohibits the execution of the specified operation, or
- * the queue is modified after this enumerator is created.
+ * @exception E_INVALID_OPERATION Either of the following conditions has occurred:
+ * - The current state of the instance prohibits the execution of the specified operation.
+ * - The queue is modified after this enumerator is created.
* @exception E_OUT_OF_RANGE The enumerator has passed the end of the queue.
* @see Reset()
*/
*
* @return An error code
* @exception E_SUCCESS The method is successful.
- * @exception E_INVALID_OPERATION The current state of the instance prohibits the execution of the specified operation, or
- * the queue is modified after this enumerator is created.
+ * @exception E_INVALID_OPERATION Either of the following conditions has occurred:
+ * - The current state of the instance prohibits the execution of the specified operation.
+ * - The queue is modified after this enumerator is created.
*/
result Reset(void)
{
/**
* @class RandomIteratorT
* @brief This class provides a random iterator that is used to convert %IList to STL containers. @n
- * %StlConverter provides static methods to get this random iterator from %IList.
+ * %StlConverter provides static methods to get this random iterator from IList.
*
* @since 2.1
*
- * @remarks The %RandomIteratorT class satisfies only requirements of C++ standard library InputIterator concept due to limitations of %Tizen collection.
- * So, this class can be used with C++ standard library algorithms which requires only InputIterator concept for their arguments.
+ * @remarks The %RandomIteratorT class satisfies only the requirements of the C++ standard library InputIterator concept due to the limitations of the %Tizen collection. @n
+ * This class can be used with the C++ standard library algorithms which require only the InputIterator concept for their arguments.
*
* The %RandomIteratorT class provides a random iterator that is used to convert IList to STL containers.
* StlConverter provides static methods to get this random iterator from IList.
* @since 2.1
*
* @param[in] list A reference to the IList instance to convert
- * @param[in] index A start index
- * @remarks %RandomIteratorT only supports random accessible collection for performance.
+ * @param[in] index The starting index
+ * @remarks %RandomIteratorT only supports random accessible collection for its performance.
* @see Tizen::Base::Collection::IList::IsRandomAccessible()
*/
explicit RandomIteratorT(const IList& list, int index = 0)
*
* @return A reference to the %RandomIteratorT instance
* @exception E_SUCCESS The method is successful.
- * @exception E_OUT_OF_RANGE The specified index is outside the bounds of the data structure,
- * or the specified index is either equal to or greater than the number of elements in the list or less than 0.
+ * @exception E_OUT_OF_RANGE Either of the following conditions has occurred:
+ * - The specified @c index is outside the bounds of the data structure.
+ * - The specified @c index is either greater than or equal to the number of elements in the list.
+ * - The specified @c index is less than @c 0.
* @remarks The specific error code can be accessed using GetLastResult() method.
*/
RandomIteratorT< T >& operator ++(void)
*
* @return A %RandomIteratorT instance
* @exception E_SUCCESS The method is successful.
- * @exception E_OUT_OF_RANGE The specified index is outside the bounds of the data structure,
- * or the specified index is either equal to or greater than the number of elements in the list or less than 0.
+ * @exception E_OUT_OF_RANGE Either of the following conditions has occurred:
+ * - The specified @c index is outside the bounds of the data structure.
+ * - The specified @c index is either greater than or equal to the number of elements in the list.
+ * - The specified @c index is less than @c 0.
* @remarks The specific error code can be accessed using GetLastResult() method.
*/
RandomIteratorT< T > operator ++(int)
}
/**
- * Decrease __index by 1.
+ * Decreases __index by 1.
*
* @since 2.1
*
* @return A reference to the %RandomIteratorT instance
* @exception E_SUCCESS The method is successful.
- * @exception E_OUT_OF_RANGE The specified index is outside the bounds of the data structure,
- * or the specified index is either equal to or greater than the number of elements in the list or less than 0.
+ * @exception E_OUT_OF_RANGE Either of the following conditions has occurred:
+ * - The specified @c index is outside the bounds of the data structure.
+ * - The specified @c index is either greater than or equal to the number of elements in the list.
+ * - The specified @c index is less than @c 0.
* @remarks The specific error code can be accessed using GetLastResult() method.
*/
RandomIteratorT< T >& operator --(void)
}
/**
- * Decrease __index by 1 and returns the previous state.
+ * Decreases __index by 1 and returns the previous state.
*
* @since 2.1
*
* @return A %RandomIteratorT instance
* @exception E_SUCCESS The method is successful.
- * @exception E_OUT_OF_RANGE The specified index is outside the bounds of the data structure,
- * or the specified index is either equal to or greater than the number of elements in the list or less than 0.
+ * @exception E_OUT_OF_RANGE Either of the following conditions has occurred:
+ * - The specified @c index is outside the bounds of the data structure.
+ * - The specified @c index is either greater than or equal to the number of elements in the list.
+ * - The specified @c index is less than @c 0.
* @remarks The specific error code can be accessed using GetLastResult() method.
*/
RandomIteratorT< T > operator --(int)
}
/**
- * Checks l-value is less than r-value.
+ * Checks whether the l-value is less than the r-value.
*
* @since 2.1
*
- * @return @c true if l-value of the specified %RandomIteratorT instance is less than the calling instance's members, @n
+ * @return @c true if the l-value of the specified %RandomIteratorT instance is less than the calling instance's members, @n
* else @c false
* @param[in] rhs A reference to the %RandomIteratorT instance on the right-hand side of the operator
*/
}
/**
- * Checks whether l-value is greater than r-value.
+ * Checks whether the l-value is greater than the r-value.
*
* @since 2.1
*
- * @return @c true if l-value of the specified %RandomIteratorT instance is greater than the calling instance's members, @n
+ * @return @c true if the l-value of the specified %RandomIteratorT instance is greater than the calling instance's members, @n
* else @c false
* @param[in] rhs A reference to the %RandomIteratorT instance on the right-hand side of the operator
*/
}
/**
- * Increases __index as specified by the diff parameter.
+ * Increases __index as specified by the @c diff parameter.
*
* @since 2.1
*
* @return A %RandomIteratorT instance
* @param[in] diff The length to move forward
* @exception E_SUCCESS The method is successful.
- * @exception E_OUT_OF_RANGE The specified index is outside the bounds of the data structure,
- * or the specified index is either equal to or greater than the number of elements in the list or less than 0.
+ * @exception E_OUT_OF_RANGE Either of the following conditions has occurred:
+ * - The specified @c index is outside the bounds of the data structure.
+ * - The specified @c index is either greater than or equal to the number of elements in the list.
+ * - The specified @c index is less than @c 0.
* @remarks The specific error code can be accessed using GetLastResult() method.
*/
RandomIteratorT< T > operator +(int diff)
}
/**
- * Decrease __index as specified by the diff parameter.
+ * Decreases __index as specified by the @c diff parameter.
*
* @since 2.1
*
* @return A %RandomIteratorT instance
* @param[in] diff The length to move backward
* @exception E_SUCCESS The method is successful.
- * @exception E_OUT_OF_RANGE The specified index is outside the bounds of the data structure,
- * or the specified index is either equal to or greater than the number of elements in the list or less than 0.
+ * @exception E_OUT_OF_RANGE Either of the following conditions has occurred:
+ * - The specified @c index is outside the bounds of the data structure.
+ * - The specified @c index is either greater than or equal to the number of elements in the list.
+ * - The specified @c index is less than @c 0.
* @remarks The specific error code can be accessed using GetLastResult() method.
*/
RandomIteratorT< T > operator -(int diff)
* @since 2.1
*
* @return A reference to the T type instance
- * @param[in] index An index to reach
+ * @param[in] index The index to reach
* @exception E_SUCCESS The method is successful.
- * @exception E_OUT_OF_RANGE The specified index is outside the bounds of the data structure,
- * or the specified index is either equal to or greater than the number of elements in the list or less than 0.
+ * @exception E_OUT_OF_RANGE Either of the following conditions has occurred:
+ * - The specified @c index is outside the bounds of the data structure.
+ * - The specified @c index is either greater than or equal to the number of elements in the list.
+ * - The specified @c index is less than @c 0.
* @remarks The specific error code can be accessed using GetLastResult() method.
*/
T& operator [](int index) const
}
/**
- * Swaps values of the two %RandomIteratorT instances.
+ * Swaps the values of the two %RandomIteratorT instances.
*
* @since 2.1
*
* @param[in] capacity The number of elements @n
* The default capacity is @c 10.
* @exception E_SUCCESS The method is successful.
- * @exception E_INVALID_ARG The specified input parameter is invalid, or
- * the specified @c capacity is negative.
- * @remarks If the number of elements added to the stack reaches the current capacity,
+ * @exception E_INVALID_ARG Either of the following conditions has occurred:
+ * - The specified input parameter is invalid.
+ * - The specified @c capacity is negative.
+ * @remarks If the number of elements added to the stack reaches the current capacity,
* the capacity is automatically increased by memory reallocation. @n
* Therefore, if the size of the stack can be estimated,
* specifying the initial capacity eliminates the need to perform a number of
* @return An error code
* @param[in] collection The collection to copy elements from
* @exception E_SUCCESS The method is successful.
- * @exception E_INVALID_OPERATION The current state of the instance prohibits the execution of the specified operation, or
- * the @c collection is modified during the operation of this method.
- * @remarks This method performs a shallow copy. It copies just the pointer; not the element itself.
+ * @exception E_INVALID_OPERATION Either of the following conditions has occurred:
+ * - The current state of the instance prohibits the execution of the specified operation.
+ * - The specified @c collection is modified during the operation of this method.
+ * @remarks This method performs a shallow copy. It copies just the pointer and not the element itself.
* @see Stack()
*/
result Construct(const ICollection& collection);
/**
- * Gets an enumerator of this stack.
+ * Gets the enumerator of this stack.
*
* @since 2.0
*
- * @return An enumerator (an instance of the IEnumerator derived class) of this stack, @n
+ * @return The enumerator (an instance of the IEnumerator derived class) of this stack, @n
* else @c null if an exception occurs
* @remarks The specific error code can be accessed using the GetLastResult() method.
- * @see IEnumerator
*/
virtual IEnumerator* GetEnumeratorN(void) const;
* @return The element at the top of this stack, @n
* else @c null if this stack is empty
* @exception E_SUCCESS The method is successful.
- * @exception E_UNDERFLOW The operation (arithmetic/casting/conversion) has caused an underflow, or
- * this stack is empty.
+ * @exception E_UNDERFLOW Either of the following conditions has occurred:
+ * - The operation (arithmetic/casting/conversion) has caused an underflow.
+ * - The stack is empty.
* @remarks The specific error code can be accessed using the GetLastResult() method.
*/
virtual const Object* Peek(void) const;
* @return The element at the top of this stack, @n
* else @c null if this stack is empty
* @exception E_SUCCESS The method is successful.
- * @exception E_UNDERFLOW The operation (arithmetic/casting/conversion) has caused an underflow, or
- * this stack is empty.
+ * @exception E_UNDERFLOW Either of the following conditions has occurred:
+ * - The operation (arithmetic/casting/conversion) has caused an underflow.
+ * - The stack is empty.
* @remarks The specific error code can be accessed using the GetLastResult() method.
* @see Push(Object*)
*/
* Pushes an object to the top of this stack.
*
* @brief <i> [Deprecated] </i>
- * @deprecated This method is deprecated because it has a problem of const reference argument.
+ * @deprecated This method is deprecated because it has a problem of constant reference argument.
* Instead of using this method, use Push(Object* pObj).
* @since 2.0
*
* @param[in] obj The object to add to this stack
* @exception E_SUCCESS The method is successful.
* @exception E_OUT_OF_MEMORY The memory is insufficient.
- * @remarks This method performs a shallow copy. It inserts just the pointer; not the element itself.
+ * @remarks This method performs a shallow copy. It inserts just the pointer and not the element itself.
* @see Pop()
* @endif
*/
* @since 2.0
*
* @return An error code
- * @param[in] pObj The pointer to object to add to this stack
+ * @param[in] pObj A pointer to the object to add to this stack
* @exception E_SUCCESS The method is successful.
* @exception E_INVALID_ARG The specified input parameter is invalid.
- * @remarks This method performs a shallow copy. It inserts just the pointer; not the element itself.
+ * @remarks This method performs a shallow copy. It inserts just the pointer and not the element itself.
* @see Pop()
*/
virtual result Push(Object* pObj);
/**
- * Removes all objects and their pointers in collection, when the @c deallocate parameter is set to @c true. @n
+ * Removes all the objects and their pointers from the collection, when the @c deallocate parameter is set to @c true. @n
* This method can be called before deleting the objects in a collection.
*
* @since 2.0
* Checks whether this stack contains all of the elements in the specified collection.
*
* @brief <i> [Deprecated] </i>
- * @deprecated This method is deprecated because it transfers a result of comparison in out-parameter form.
- * The return type will be changed into boolean type and this method will return the result.
+ * @deprecated This method is deprecated because it transfers the result of the comparison in an out-parameter form.
+ * The return type is changed to boolean and this method returns the result.
* Instead of using this method, use bool Contains(const ICollection& collection).
* @since 2.0
*
* @return An error code
- * @param[in] collection The collection to locate
- * @param[out] out Set to @c true if this stack contains all the elements in the specified collection, @n
- * else @c false
+ * @param[in] collection The collection to locate
+ * @param[out] out Set to @c true if this stack contains all the elements in the specified collection, @n
+ * else @c false
* @exception E_SUCCESS The method is successful.
- * @exception E_INVALID_OPERATION The current state of the instance prohibits the execution of the specified operation, or
- * the @c collection is modified during the operation of this method.
+ * @exception E_INVALID_OPERATION Either of the following conditions has occurred:
+ * - The current state of the instance prohibits the execution of the specified operation.
+ * - The specified @c collection is modified during the operation of this method.
* @endif
*/
result ContainsAll(const ICollection& collection, bool& out) const
}
/**
- * Checks whether this stack contains all of the elements in the specified collection.
+ * Checks whether this stack contains all the elements in the specified collection.
*
* @since 2.0
*
* else @c false
* @param[in] collection The collection to locate
* @exception E_SUCCESS The method is successful.
- * @exception E_INVALID_OPERATION The current state of the instance prohibits the execution of the specified operation, or
- * the @c collection is modified during the operation of this method.
+ * @exception E_INVALID_OPERATION Either of the following conditions has occurred:
+ * - The current state of the instance prohibits the execution of the specified operation.
+ * - The specified @c collection is modified during the operation of this method.
* @remarks The specific error code can be accessed using the GetLastResult() method.
*/
virtual bool ContainsAll(const ICollection& collection) const;
*
* @return @c true if the specified instance equals the current instance, @n
* else @c false
- * @param[in] obj The object to compare with the current instance
- * @remarks This method returns @c true only if the specified object is also an instance of %Stack class,
- * both stacks have the same size, and all corresponding pairs of elements in the two stacks are equal.
+ * @param[in] obj The object to compare with the current instance
+ * @remarks This method returns @c true only if the specified object is also an instance of the %Stack class,
+ * both stacks have the same size, and all the corresponding pairs of the elements in the two stacks are equal. @n
* In other words, two stacks are equal if they contain the same elements in the same order.
*/
virtual bool Equals(const Object& obj) const;
* @since 2.0
*
* @return The hash value of the current instance
- * @remarks The two Tizen::Base::Object::Equals() instances must return the same hash value. For better performance, @n
- * the used hash function must generate a random distribution for all inputs.
+ * @remarks The two Tizen::Base::Object::Equals() instances must return the same hash value. @n
+ * For better performance, the used hash function must generate a random distribution for all the inputs.
*/
virtual int GetHashCode(void) const;
* @param[in] capacity The number of elements @n
* The default capacity is @c 10.
* @exception E_SUCCESS The method is successful.
- * @exception E_INVALID_ARG The specified input parameter is invalid, or
- * the specified @c capacity is negative.
+ * @exception E_INVALID_ARG Either of the following conditions has occurred:
+ * - The specified input parameter is invalid.
+ * - The specified @c capacity is negative.
*/
result Construct(int capacity = DEFAULT_CAPACITY)
{
* @return An error code
* @param[in] collection The collection to copy elements from
* @exception E_SUCCESS The method is successful.
- * @exception E_INVALID_OPERATION The current state of the instance prohibits the execution of the specified operation, or
- * the specified @c collection is modified during the operation of this method.
+ * @exception E_INVALID_OPERATION Either of the following conditions has occurred:
+ * - The current state of the instance prohibits the execution of the specified operation.
+ * - The specified @c collection is modified during the operation of this method.
* @see StackT()
*/
result Construct(const ICollectionT< Type >& collection)
}
/**
- * Gets an enumerator of this stack.
+ * Gets the enumerator of this stack.
*
* @since 2.0
*
- * @return An enumerator (an instance of the IEnumeratorT derived class) of this stack, @n
+ * @return The enumerator (an instance of the IEnumeratorT derived class) of this stack, @n
* else @c null if an exception occurs
* @exception E_SUCCESS The method is successful.
* @exception E_OUT_OF_MEMORY The memory is insufficient.
* @remarks The specific error code can be accessed using the GetLastResult() method.
- * @see Tizen::Base::Collection::IEnumeratorT
*/
virtual IEnumeratorT< Type >* GetEnumeratorN(void) const
{
* @return An error code
* @param[out] obj The element at the beginning of this stack
* @exception E_SUCCESS The method is successful.
- * @exception E_UNDERFLOW The operation (arithmetic/casting/conversion) has caused an underflow, or
- * this stack is empty.
+ * @exception E_UNDERFLOW Either of the following conditions has occurred:
+ * - The operation (arithmetic/casting/conversion) has caused an underflow.
+ * - The stack is empty.
*/
virtual result Peek(Type& obj) const
{
* @return An error code
* @param[out] obj The element at the beginning of this stack
* @exception E_SUCCESS The method is successful.
- * @exception E_UNDERFLOW The operation (arithmetic/casting/conversion) has caused an underflow, or
- * this stack is empty.
+ * @exception E_UNDERFLOW Either of the following conditions has occurred:
+ * - The operation (arithmetic/casting/conversion) has caused an underflow.
+ * - The stack is empty.
* @see Push()
*/
virtual result Pop(Type& obj)
}
/**
- * Pushes an object at the top of this stack.
+ * Pushes an object to the top of this stack.
*
* @since 2.0
*
}
/**
- * Removes all elements in this stack.
+ * Removes all the elements from this stack.
*
* @since 2.0
*/
}
/**
- * Checks whether this stack contains all of the elements in the specified @c collection.
+ * Checks whether this stack contains all the elements in the specified @c collection.
*
* @since 2.0
*
* @return An error code
- * @param[in] collection The collection to locate
- * @param[out] out Set to @c true if this stack contains all of the elements in the specified @c collection, @n
- * else @c false
+ * @param[in] collection The collection to locate
+ * @param[out] out The boolean value that indicates if this stack contains all the elements in the specified @c collection
* @exception E_SUCCESS The method is successful.
- * @exception E_INVALID_OPERATION The current state of the instance prohibits the execution of the specified operation, or
- * the specified @c collection is modified during the operation of this method.
+ * @exception E_INVALID_OPERATION Either of the following conditions has occurred:
+ * - The current state of the instance prohibits the execution of the specified operation.
+ * - The specified @c collection is modified during the operation of this method.
*/
virtual result ContainsAll(const ICollectionT< Type >& collection, bool& out) const
{
* @return @c true if the specified instance equals the current instance, @n
* else @c false
* @param[in] obj The object to compare with the current instance
- * @remarks This method returns @c true only if the specified object is also an instance of the Stack class,
- * both stacks have the same size, and all the corresponding pairs of elements in the two stacks are equal.
+ * @remarks This method returns @c true only if the specified object is also an instance of the Stack class,
+ * both the stacks have the same size, and all the corresponding pairs of elements in the two stacks are equal. @n
* In other words, two stacks are equal if they contain the same elements in the same order.
*/
virtual bool Equals(const Object& obj) const
* @since 2.0
*
* @return The hash value of the current instance
- * @remarks The two Tizen::Base::Object::Equals() instances must return the same hash value. For better performance, @n
- * the used hash function must generate a random distribution for all inputs.
+ * @remarks The two Tizen::Base::Object::Equals() instances must return the same hash value.@n
+ * For better performance, the used hash function must generate a random distribution for all the inputs.
*/
virtual int GetHashCode(void) const
{
*
* @return An error code
* @param[out] obj The current object
- * @exception E_INVALID_OPERATION Either of the following conditions has occurred: @n
- * - The current state of the instance prohibits the execution of the specified operation. @n
+ * @exception E_INVALID_OPERATION Either of the following conditions has occurred:
+ * - The current state of the instance prohibits the execution of the specified operation.
* - This enumerator is currently positioned before the first element or
- * past the last element. @n
+ * past the last element.
* - The stack is modified after this enumerator is created.
* @exception E_SUCCESS The method is successful.
*/
}
/**
- * Gets an ArrayList instance from the begin and end iterators of STL container.
+ * Gets an ArrayList instance from the begin and end iterators of the STL container.
*
* @since 2.1
*
* @return A std::unique_ptr to the ArrayList instance, @n
- * else @c std::unique_ptr< ArrayList >() if error occurs
- * @param[in] begin begin() of STL container
- * @param[in] end end() of STL container
- * @param[in] deleter The function pointer to type of the element deleter
+ * else @c std::unique_ptr< ArrayList >() if an error occurs
+ * @param[in] begin begin() of the STL container
+ * @param[in] end end() of the STL container
+ * @param[in] deleter A function pointer to the type of the element deleter
* @exception E_SUCCESS The method is successful.
* @exception E_INVALID_ARG A specified input parameter is invalid.
- * @remarks To create an owning collection, set the element deleter value as @c SingleObjectDeleter.
- * This gives the collection the ownership of elements and the collection can destroy elements. @n
- * On the other hand, to create a non-owning collection, you don't need to set the element deleter value,
- * as @c NoOpDeleter is the default element deleter.
- * That implies transfer of the ownership of elements to the collection is not required.
- * @remarks The specific error code can be accessed using GetLastResult() method.
+ * @remarks
+ * - To create an owning collection, set the element deleter value as @c SingleObjectDeleter. @n
+ * This gives the collection the ownership of the elements and the collection can destroy the elements. @n
+ * On the other hand, to create a non-owning collection, do not set the element deleter value,
+ * as @c NoOpDeleter is the default element deleter. @n
+ * This implies that the transfer of the ownership of the elements to the collection is not required.
+ * - The specific error code can be accessed using GetLastResult() method.
* @see NoOpDeleter()
* @see SingleObjectDeleter()
* @see ArrayDeleter()
}
/**
- * Gets a LinkedList instance from the begin and end iterators of STL container.
+ * Gets a LinkedList instance from the begin and end iterators of the STL container.
*
* @since 2.1
*
* @return A std::unique_ptr to the LinkedList instance @n
- * else @c std::unique_ptr< LinkedList >() if error occurs
- * @param[in] begin begin() of STL container
- * @param[in] end end() of STL container
- * @param[in] deleter The function pointer to type of the element deleter
+ * else @c std::unique_ptr< LinkedList >() if an error occurs
+ * @param[in] begin begin() of the STL container
+ * @param[in] end end() of the STL container
+ * @param[in] deleter A function pointer to the type of the element deleter
* @exception E_SUCCESS The method is successful.
* @exception E_INVALID_ARG A specified input parameter is invalid.
- * @remarks To create an owning collection, set the element deleter value as @c SingleObjectDeleter.
- * This gives the collection the ownership of elements and the collection will destroy elements. @n
- * On the other hand, to create a non-owning collection, you don't need to set the element deleter value,
- * as @c NoOpDeleter is the default element deleter.
- * That implies transfer of the ownership of elements to the collection is not required.
- * @remarks The specific error code can be accessed using GetLastResult() method.
+ * @remarks
+ * - To create an owning collection, set the element deleter value as @c SingleObjectDeleter. @n
+ * This gives the collection the ownership of the elements and the collection can destroy the elements. @n
+ * On the other hand, to create a non-owning collection, do not set the element deleter value,
+ * as @c NoOpDeleter is the default element deleter. @n
+ * This implies that the transfer of the ownership of the elements to the collection is not required.
+ * - The specific error code can be accessed using GetLastResult() method.
* @see NoOpDeleter()
* @see SingleObjectDeleter()
* @see ArrayDeleter()
}
/**
- * Gets a HashMap instance from the begin and end iterators of STL container.
+ * Gets a HashMap instance from the begin and end iterators of the STL container.
*
* @since 2.1
*
* @return A std::unique_ptr to the HashMap instance @n
- * else @c std::unique_ptr< HashMap >() if error occurs
- * @param[in] begin begin() of STL container
- * @param[in] end end() of STL container
- * @param[in] deleter The function pointer to type of the element deleter
+ * else @c std::unique_ptr< HashMap >() if an error occurs
+ * @param[in] begin begin() of the STL container
+ * @param[in] end end() of the STL container
+ * @param[in] deleter A function pointer to the type of the element deleter
* @exception E_SUCCESS The method is successful.
* @exception E_INVALID_ARG A specified input parameter is invalid.
- * @remarks To create an owning collection, set the element deleter value as @c SingleObjectDeleter.
- * This gives the collection the ownership of elements and the collection will destroy elements. @n
- * On the other hand, to create a non-owning collection, you don't need to set the element deleter value,
- * as @c NoOpDeleter is the default element deleter.
- * That implies transfer of the ownership of elements to the collection is not required.
- * @remarks The specific error code can be accessed using GetLastResult() method.
+ * @remarks
+ * - To create an owning collection, set the element deleter value as @c SingleObjectDeleter. @n
+ * This gives the collection the ownership of the elements and the collection can destroy the elements. @n
+ * On the other hand, to create a non-owning collection, do not set the element deleter value,
+ * as @c NoOpDeleter is the default element deleter. @n
+ * This implies that the transfer of the ownership of the elements to the collection is not required.
+ * - The specific error code can be accessed using GetLastResult() method.
* @see NoOpDeleter()
* @see SingleObjectDeleter()
* @see ArrayDeleter()
}
/**
- * Gets a MultiHashMap instance from the begin and end iterators of STL container.
+ * Gets a MultiHashMap instance from the begin and end iterators of the STL container.
*
* @since 2.1
*
* @return A std::unique_ptr to the MultiHashMap instance @n
- * else @c std::unique_ptr< MultiHashMap >() if error occurs
- * @param[in] begin begin() of STL container
- * @param[in] end end() of STL container
- * @param[in] deleter The function pointer to type of the element deleter
+ * else @c std::unique_ptr< MultiHashMap >() if an error occurs
+ * @param[in] begin begin() of the STL container
+ * @param[in] end end() of the STL container
+ * @param[in] deleter A function pointer to the type of the element deleter
* @exception E_SUCCESS The method is successful.
* @exception E_INVALID_ARG A specified input parameter is invalid.
- * @remarks To create an owning collection, set the element deleter value as @c SingleObjectDeleter.
- * This gives the collection the ownership of elements and the collection will destroy elements. @n
- * On the other hand, to create a non-owning collection, you don't need to set the element deleter value,
- * as @c NoOpDeleter is the default element deleter.
- * That implies transfer of the ownership of elements to the collection is not required.
- * @remarks The specific error code can be accessed using GetLastResult() method.
+ * @remarks
+ * - To create an owning collection, set the element deleter value as @c SingleObjectDeleter. @n
+ * This gives the collection the ownership of the elements and the collection can destroy the elements. @n
+ * On the other hand, to create a non-owning collection, do not set the element deleter value,
+ * as @c NoOpDeleter is the default element deleter. @n
+ * This implies that the transfer of the ownership of the elements to the collection is not required.
+ * - The specific error code can be accessed using GetLastResult() method.
* @see NoOpDeleter()
* @see SingleObjectDeleter()
* @see ArrayDeleter()
* @brief This is the header file for the element deleter.
*
* This header file contains the declarations of the element deleter.
- * Depending on the element deleter, collection decides whether to remove the object or not.
+ * Depending on the element deleter, the collection decides whether to remove the object or not.
*/
#ifndef _FBASE_COL_TYPES_H_
#define _FBASE_COL_TYPES_H_
typedef void (*DeleterFunctionType)(Object* pObj);
/**
- * This function does not remove the object.
+ * Does not remove the object.
*
* @since 2.0
*
- * @param[in] pObj The pointer to the object to remove
+ * @param[in] pObj A pointer to the object to remove
*/
_OSP_EXPORT_ void NoOpDeleter(Object* pObj);
/**
- * This function removes the single object.
+ * Removes the single object.
*
* @since 2.0
*
- * @param[in] pObj The pointer to the object to remove
+ * @param[in] pObj A pointer to the object to remove
*/
_OSP_EXPORT_ void SingleObjectDeleter(Object* pObj);
/**
- * This function removes the array object.
+ * Removes the array object.
*
* @since 2.0
*
- * @param[in] pObj The pointer to the object to remove
+ * @param[in] pObj A pointer to the object to remove
*/
_OSP_EXPORT_ void ArrayDeleter(Object* pObj);
/**
* @class ComparerT
*
- * @brief This class checks for equivalence between 2 values of the same primitive type.
+ * @brief This class checks for equivalence between two values of the same primitive type.
* @since 2.0
*
- * The %ComparerT class checks for equivalence between 2 values of the same primitive type.
+ * The %ComparerT class checks for equivalence between two values of the same primitive type.
*
* The following example demonstrates how to use the %ComparerT class.
*
* @since 2.0
*
* @return An error code
- * @param[in] obj1 The first object to compare
- * @param[in] obj2 The second object to compare
- * @param[out] cmp The result of comparison
+ * @param[in] obj1 The first object to compare
+ * @param[in] obj2 The second object to compare
+ * @param[out] cmp The result of the comparison
* @exception E_SUCCESS The method is successful.
* @exception E_INVALID_ARG The specified objects are not of the expected type.
* @remarks @c cmp can take one of the following values:
* @code
- * < 0 if the value of @c obj1 is less than the value of @c obj2
- * == 0 if the value of @c obj1 is equal to the value of @c obj2
- * > 0 if the value of @c obj1 is greater than the value of @c obj2
+ * < 0 if the value of obj1 is less than the value of obj2
+ * == 0 if the value of obj1 is equal to the value of obj2
+ * > 0 if the value of obj1 is greater than the value of obj2
* @endcode
*/
virtual result Compare(const Type& obj1, const Type& obj2, int& cmp) const
virtual ~ComparerT(void) { }
/**
- * Compare two String instances.
+ * Compares two String instances.
*
* @since 2.1
*
- * @return Always returns E_SUCCESS
+ * @return Always returns @c E_SUCCESS
* @param[in] str1 The String instance to compare
* @param[in] str2 The String instance to compare
- * @param[in] cmp An integer value for result
+ * @param[in] cmp The integer value for the result
*/
virtual result Compare(const Tizen::Base::String& str1, const Tizen::Base::String& str2, int& cmp) const
{
projects / platform / framework / native / appfw.git / commitdiff