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