* @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
{
projects / platform / framework / native / appfw.git / blobdiff