ImageGear for Java
ImGearMetadataNodeList Class Members
Methods 

The following tables list the members exposed by ImGearMetadataNodeList.

Public Methods
 NameDescription
Public MethodaddOverloaded. Adds a node to the list.  
Public MethodaddAllOverloaded. Appends all of the elements in the specified collection to the end of this list, in the order that they are returned by the specified collection's iterator (optional operation). The behavior of this operation is undefined if the specified collection is modified while the operation is in progress. (Note that this will occur if the specified collection is this list, and it's nonempty.)  
Public MethodaddOrderedAdds a node to the list.  
Public MethodclearClears the list.  
Public MethodcloneClones the list.  
Public MethodcontainsChecks whether or not the list contains the specified node.  
Public MethodcontainsAllReturns true if this list contains all of the elements of the specified collection.  
Public MethodgetProvides access to single node within the node list.  
Public MethodindexOfReturns index of the node.  
Public MethodisEmptyReturns true if this list contains no elements.  
Public MethoditeratorReturns an iterator over the elements in this list in proper sequence.  
Public MethodlastIndexOfReturns the index of the last occurrence of the specified element in this list, or -1 if this list does not contain the element. More formally, returns the highest index i such that (o==null ? get(i)==null : o.equals(get(i))), or -1 if there is no such index.  
Public MethodlistIteratorOverloaded. Returns a list iterator over the elements in this list (in proper sequence).  
Public MethodlookUpOverloaded. Searches the node list for a node which Tag is equal to the specified tag ID.  
Public MethodlookUpLeafOverloaded. This method searches the node list recursively for a leaf, according to the path parameter. Length of the path should correspond to the metadata structure depth, at which the desired node is located.

If a leaf is not present, the method returns null.

The method does not search in the subtrees of the node list.

 
Public MethodrecursiveSortSorts the list items recursively so that items within each level are sorted.  
Public MethodremoveOverloaded. Removes the specified node.  
Public MethodremoveAllRemoves from this list all of its elements that are contained in the specified collection (optional operation).  
Public MethodremoveNameRemoves the node whose name is equal to the specified string value.  
Public MethodremoveTagRemoves the node with the specified ID.  
Public MethodretainAllRetains only the elements in this list that are contained in the specified collection (optional operation). In other words, removes from this list all the elements that are not contained in the specified collection.  
Public MethodsetReplaces the element at the specified position in this list with the specified element (optional operation).  
Public MethodsizeGets the number of elements contained in the List.

Any integer value.

 
Public MethodsortSorts the list items.  
Public MethodsubListReturns a view of the portion of this list between the specified fromIndex, inclusive, and toIndex, exclusive. (If fromIndex and toIndex are equal, the returned list is empty.) The returned list is backed by this list, so non-structural changes in the returned list are reflected in this list, and vice-versa. The returned list supports all of the optional list operations supported by this list.

This method eliminates the need for explicit range operations (of the sort that commonly exist for arrays). Any operation that expects a list can be used as a range operation by passing a subList view instead of a whole list. For example, the following idiom removes a range of elements from a list:

 list.subList(from, to).clear(); 
Similar idioms may be constructed for indexOf and lastIndexOf, and all of the algorithms in the Collections class can be applied to a subList.

The semantics of the list returned by this method become undefined if the backing list (i.e., this list) is structurally modified in any way other than via the returned list. (Structural modifications are those that change the size of this list, or otherwise perturb it in such a fashion that iterations in progress may yield incorrect results.)

 
Public MethodtoArrayOverloaded. Returns an array containing all of the elements in this list in proper sequence (from first to last element).

The returned array will be "safe" in that no references to it are maintained by this list. (In other words, this method must allocate a new array even if this list is backed by an array). The caller is thus free to modify the returned array.

This method acts as bridge between array-based and collection-based APIs.

 
Public MethodtoStringReturns a string representation of the object. In general, the toString method returns a string that "textually represents" this object. The result should be a concise but informative representation that is easy for a person to read. It is recommended that all subclasses override this method.

The toString method for class Object returns a string consisting of the name of the class of which the object is an instance, the at-sign character ' @', and the unsigned hexadecimal representation of the hash code of the object. In other words, this method returns a string equal to the value of:

 getClass().getName() + '@' + Integer.toHexString(hashCode()) 
 
Top
See Also

Reference

ImGearMetadataNodeList Class
com.accusoft.imagegear.core Package

 

 


©2016. Accusoft Corporation. All Rights Reserved.

Send Feedback