dom4j 2.1.4 · org.dom4j.tree.ContentListFacade

Modifier and Type	Field and Description
private AbstractBranch	branch The `AbstractBranch` instance which owns the content
private List<T>	branchContent The content of the Branch which is modified if I am modified

Access	Constructor and Description
public	ContentListFacade(AbstractBranch branch, List<T> branchContent)

Method Summary

Modifier and Type	Method and Description
public boolean	add(T element to be appended to this list node) Overrides java.util.AbstractList.add. Implements java.util.List.add, java.util.Collection.add. Appends the specified element to the end of this list (optional operation).
public void	add(int index at which the specified element is to be inserted index, T element to be inserted node) Overrides java.util.AbstractList.add. Implements java.util.List.add. Inserts the specified element at the specified position in this list (optional operation).
public boolean	addAll(Collection<? extends T> collection containing elements to be added to this list collection) Overrides java.util.AbstractCollection.addAll. Implements java.util.List.addAll, java.util.Collection.addAll. 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).
public boolean	addAll(int index at which to insert the first element from the specified collection index, Collection<? extends T> collection containing elements to be added to this list collection) Overrides java.util.AbstractList.addAll. Implements java.util.List.addAll. Inserts all of the elements in the specified collection into this list at the specified position (optional operation).
protected Node	asNode(Object object)
public void	clear() Overrides java.util.AbstractList.clear. Implements java.util.List.clear, java.util.Collection.clear. Removes all of the elements from this list (optional operation).
public boolean	contains(Object element whose presence in this list is to be tested o) Overrides java.util.AbstractCollection.contains. Implements java.util.List.contains, java.util.Collection.contains. Returns `true` if this list contains the specified element.
public boolean	containsAll(Collection<?> collection to be checked for containment in this list c) Overrides java.util.AbstractCollection.containsAll. Implements java.util.List.containsAll, java.util.Collection.containsAll. Returns `true` if this list contains all of the elements of the specified collection.
public T	get(int index of the element to return index) Implements abstract java.util.AbstractList.get. Implements java.util.List.get. Returns the element at the specified position in this list.
protected List<T>	getBackingList()
public int	indexOf(Object element to search for o) Overrides java.util.AbstractList.indexOf. Implements java.util.List.indexOf. Returns the index of the first occurrence of the specified element in this list, or -1 if this list does not contain the element.
public boolean	isEmpty() Overrides java.util.AbstractCollection.isEmpty. Implements java.util.List.isEmpty, java.util.Collection.isEmpty. Returns `true` if this list contains no elements.
public int	lastIndexOf(Object element to search for o) Overrides java.util.AbstractList.lastIndexOf. Implements java.util.List.lastIndexOf. Returns the index of the last occurrence of the specified element in this list, or -1 if this list does not contain the element.
public boolean	remove(Object element to be removed from this list, if present object) Overrides java.util.AbstractCollection.remove. Implements java.util.List.remove, java.util.Collection.remove. Removes the first occurrence of the specified element from this list, if it is present (optional operation).
public T	remove(int the index of the element to be removed index) Overrides java.util.AbstractList.remove. Implements java.util.List.remove. Removes the element at the specified position in this list (optional operation).
public boolean	removeAll(Collection<?> collection containing elements to be removed from this list c) Overrides java.util.AbstractCollection.removeAll. Implements java.util.List.removeAll, java.util.Collection.removeAll. Removes from this list all of its elements that are contained in the specified collection (optional operation).
public T	set(int index of the element to replace index, T element to be stored at the specified position node) Overrides java.util.AbstractList.set. Implements java.util.List.set. Replaces the element at the specified position in this list with the specified element (optional operation).
public int	size() Implements abstract java.util.AbstractCollection.size. Implements java.util.List.size, java.util.Collection.size. Returns the number of elements in this list.
public Object[]	toArray() Overrides java.util.AbstractCollection.toArray. Implements java.util.List.toArray, java.util.Collection.toArray. Returns an array containing all of the elements in this list in proper sequence (from first to last element).
public Object[]	toArray(Object[] the array into which the elements of this list are to be stored, if it is big enough; otherwise, a new array of the same runtime type is allocated for this purpose. a) Overrides java.util.AbstractCollection.toArray. Implements java.util.List.toArray, java.util.Collection.toArray. Returns an array containing all of the elements in this list in proper sequence (from first to last element); the runtime type of the returned array is that of the specified array.

Inherited from java.util.AbstractList:: equals hashCode iterator listIterator listIterator removeRange subList

branch	back to summary
private AbstractBranch branch The `AbstractBranch` instance which owns the content

branchContent	back to summary
private List<T> branchContent The content of the Branch which is modified if I am modified

ContentListFacade	back to summary
public ContentListFacade(AbstractBranch branch, List<T> branchContent)

Method Detail

add back to summary

add	back to summary
public boolean add(T node) Overrides java.util.AbstractList.add. Implements java.util.List.add, java.util.Collection.add. Doc from java.util.AbstractList.add. Appends the specified element to the end of this list (optional operation). Lists that support this operation may place limitations on what elements may be added to this list. In particular, some lists will refuse to add null elements, and others will impose restrictions on the type of elements that may be added. List classes should clearly specify in their documentation any restrictions on what elements may be added. Parameters node:T element to be appended to this list Returns:boolean `true` (as specified by `Collection#add`) Annotations @Override

public boolean add(T node)

Overrides java.util.AbstractList.add.

Implements java.util.List.add, java.util.Collection.add.

Doc from java.util.AbstractList.add.

Appends the specified element to the end of this list (optional operation).

Lists that support this operation may place limitations on what elements may be added to this list. In particular, some lists will refuse to add null elements, and others will impose restrictions on the type of elements that may be added. List classes should clearly specify in their documentation any restrictions on what elements may be added.

Parameters

node:T: element to be appended to this list

Returns:boolean

true (as specified by Collection#add)

Annotations

@Override

add	back to summary
public void add(int index, T node) Overrides java.util.AbstractList.add. Implements java.util.List.add. Doc from java.util.AbstractList.add. Inserts the specified element at the specified position in this list (optional operation). Shifts the element currently at that position (if any) and any subsequent elements to the right (adds one to their indices). Parameters index:int Doc from java.util.List.add. index at which the specified element is to be inserted node:T Doc from java.util.List.add. element to be inserted Annotations @Override

add

back to summary

public void add(int index, T node)

Overrides java.util.AbstractList.add.

Implements java.util.List.add.

Doc from java.util.AbstractList.add.

Inserts the specified element at the specified position in this list (optional operation). Shifts the element currently at that position (if any) and any subsequent elements to the right (adds one to their indices).

Parameters

index:int

Doc from java.util.List.add.

index at which the specified element is to be inserted

node:T

Doc from java.util.List.add.

element to be inserted

Annotations

@Override

addAll back to summary

addAll	back to summary
public boolean addAll(Collection<? extends T> collection) Overrides java.util.AbstractCollection.addAll. Implements java.util.List.addAll, java.util.Collection.addAll. Doc from java.util.List.addAll. 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.) Parameters collection:Collection<? extends T> collection containing elements to be added to this list Returns:boolean `true` if this list changed as a result of the call Annotations @Override

public boolean addAll(Collection<? extends T> collection)

Overrides java.util.AbstractCollection.addAll.

Implements java.util.List.addAll, java.util.Collection.addAll.

Doc from java.util.List.addAll.

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.)

Parameters

collection:Collection<? extends T>: collection containing elements to be added to this list

Returns:boolean

true if this list changed as a result of the call

Annotations

@Override

addAll back to summary

addAll	back to summary
public boolean addAll(int index, Collection<? extends T> collection) Overrides java.util.AbstractList.addAll. Implements java.util.List.addAll. Doc from java.util.AbstractList.addAll. Inserts all of the elements in the specified collection into this list at the specified position (optional operation). Shifts the element currently at that position (if any) and any subsequent elements to the right (increases their indices). The new elements will appear in this list in the order that they are returned by the specified collection's iterator. 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.) Parameters index:int Doc from java.util.List.addAll. index at which to insert the first element from the specified collection collection:Collection<? extends T> Doc from java.util.List.addAll. collection containing elements to be added to this list Returns:boolean Doc from java.util.List.addAll. `true` if this list changed as a result of the call Annotations @Override

public boolean addAll(int index, Collection<? extends T> collection)

Overrides java.util.AbstractList.addAll.

Implements java.util.List.addAll.

Doc from java.util.AbstractList.addAll.

Inserts all of the elements in the specified collection into this list at the specified position (optional operation). Shifts the element currently at that position (if any) and any subsequent elements to the right (increases their indices). The new elements will appear in this list in the order that they are returned by the specified collection's iterator. 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.)

Parameters

index:int

Doc from java.util.List.addAll.

index at which to insert the first element from the specified collection

collection:Collection<? extends T>

Doc from java.util.List.addAll.

collection containing elements to be added to this list

Returns:boolean

Doc from java.util.List.addAll.

true if this list changed as a result of the call

Annotations

@Override

asNode	back to summary
protected Node asNode(Object object)

clear	back to summary
public void clear() Overrides java.util.AbstractList.clear. Implements java.util.List.clear, java.util.Collection.clear. Doc from java.util.AbstractList.clear. Removes all of the elements from this list (optional operation). The list will be empty after this call returns. Annotations @Override

clear

back to summary

public void clear()

Overrides java.util.AbstractList.clear.

Implements java.util.List.clear, java.util.Collection.clear.

Doc from java.util.AbstractList.clear.

Removes all of the elements from this list (optional operation). The list will be empty after this call returns.

Annotations

@Override

contains back to summary

contains	back to summary
public boolean contains(Object o) Overrides java.util.AbstractCollection.contains. Implements java.util.List.contains, java.util.Collection.contains. Doc from java.util.List.contains. Returns `true` if this list contains the specified element. More formally, returns `true` if and only if this list contains at least one element `e` such that `Objects.equals(o, e)`. Parameters o:Object element whose presence in this list is to be tested Returns:boolean `true` if this list contains the specified element Annotations @Override

public boolean contains(Object o)

Overrides java.util.AbstractCollection.contains.

Implements java.util.List.contains, java.util.Collection.contains.

Doc from java.util.List.contains.

Returns true if this list contains the specified element. More formally, returns true if and only if this list contains at least one element e such that Objects.equals(o, e).

Parameters

o:Object: element whose presence in this list is to be tested

Returns:boolean

true if this list contains the specified element

Annotations

@Override

containsAll back to summary

containsAll	back to summary
public boolean containsAll(Collection<?> c) Overrides java.util.AbstractCollection.containsAll. Implements java.util.List.containsAll, java.util.Collection.containsAll. Doc from java.util.List.containsAll. Returns `true` if this list contains all of the elements of the specified collection. Parameters c:Collection<?> collection to be checked for containment in this list Returns:boolean `true` if this list contains all of the elements of the specified collection Annotations @Override

public boolean containsAll(Collection<?> c)

Overrides java.util.AbstractCollection.containsAll.

Implements java.util.List.containsAll, java.util.Collection.containsAll.

Doc from java.util.List.containsAll.

Returns true if this list contains all of the elements of the specified collection.

Parameters

c:Collection<?>: collection to be checked for containment in this list

Returns:boolean

true if this list contains all of the elements of the specified collection

Annotations

@Override

get	back to summary
public T get(int index) Implements abstract java.util.AbstractList.get. Implements java.util.List.get. Doc from java.util.AbstractList.get. Returns the element at the specified position in this list. Parameters index:int Doc from java.util.List.get. index of the element to return Returns:T Doc from java.util.List.get. the element at the specified position in this list Annotations @Override

get

back to summary

public T get(int index)

Implements abstract java.util.AbstractList.get.

Implements java.util.List.get.

Doc from java.util.AbstractList.get.

Returns the element at the specified position in this list.

Parameters

index:int

Doc from java.util.List.get.

index of the element to return

Returns:T

Doc from java.util.List.get.

the element at the specified position in this list

Annotations

@Override

getBackingList	back to summary
protected List<T> getBackingList()

indexOf back to summary

indexOf	back to summary
public int indexOf(Object o) Overrides java.util.AbstractList.indexOf. Implements java.util.List.indexOf. Doc from java.util.AbstractList.indexOf. Returns the index of the first occurrence of the specified element in this list, or -1 if this list does not contain the element. More formally, returns the lowest index `i` such that `Objects.equals(o, get(i))`, or -1 if there is no such index. Parameters o:Object Doc from java.util.List.indexOf. element to search for Returns:int Doc from java.util.List.indexOf. the index of the first occurrence of the specified element in this list, or -1 if this list does not contain the element Annotations @Override

public int indexOf(Object o)

Overrides java.util.AbstractList.indexOf.

Implements java.util.List.indexOf.

Doc from java.util.AbstractList.indexOf.

Returns the index of the first occurrence of the specified element in this list, or -1 if this list does not contain the element. More formally, returns the lowest index i such that Objects.equals(o, get(i)), or -1 if there is no such index.

Parameters

o:Object

Doc from java.util.List.indexOf.

element to search for

Returns:int

Doc from java.util.List.indexOf.

the index of the first occurrence of the specified element in this list, or -1 if this list does not contain the element

Annotations

@Override

isEmpty back to summary

isEmpty	back to summary
public boolean isEmpty() Overrides java.util.AbstractCollection.isEmpty. Implements java.util.List.isEmpty, java.util.Collection.isEmpty. Doc from java.util.List.isEmpty. Returns `true` if this list contains no elements. Returns:boolean `true` if this list contains no elements Annotations @Override

public boolean isEmpty()

Overrides java.util.AbstractCollection.isEmpty.

Implements java.util.List.isEmpty, java.util.Collection.isEmpty.

Doc from java.util.List.isEmpty.

Returns true if this list contains no elements.

Returns:boolean

true if this list contains no elements

Annotations

@Override

lastIndexOf back to summary

lastIndexOf	back to summary
public int lastIndexOf(Object o) Overrides java.util.AbstractList.lastIndexOf. Implements java.util.List.lastIndexOf. Doc from java.util.AbstractList.lastIndexOf. Returns 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 `Objects.equals(o, get(i))`, or -1 if there is no such index. Parameters o:Object Doc from java.util.List.lastIndexOf. element to search for Returns:int Doc from java.util.List.lastIndexOf. the index of the last occurrence of the specified element in this list, or -1 if this list does not contain the element Annotations @Override

public int lastIndexOf(Object o)

Overrides java.util.AbstractList.lastIndexOf.

Implements java.util.List.lastIndexOf.

Doc from java.util.AbstractList.lastIndexOf.

Returns 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 Objects.equals(o, get(i)), or -1 if there is no such index.

Parameters

o:Object

Doc from java.util.List.lastIndexOf.

element to search for

Returns:int

Doc from java.util.List.lastIndexOf.

the index of the last occurrence of the specified element in this list, or -1 if this list does not contain the element

Annotations

@Override

remove back to summary

remove	back to summary
public boolean remove(Object object) Overrides java.util.AbstractCollection.remove. Implements java.util.List.remove, java.util.Collection.remove. Doc from java.util.List.remove. Removes the first occurrence of the specified element from this list, if it is present (optional operation). If this list does not contain the element, it is unchanged. More formally, removes the element with the lowest index `i` such that `Objects.equals(o, get(i))` (if such an element exists). Returns `true` if this list contained the specified element (or equivalently, if this list changed as a result of the call). Parameters object:Object element to be removed from this list, if present Returns:boolean `true` if this list contained the specified element Annotations @Override

public boolean remove(Object object)

Overrides java.util.AbstractCollection.remove.

Implements java.util.List.remove, java.util.Collection.remove.

Doc from java.util.List.remove.

Removes the first occurrence of the specified element from this list, if it is present (optional operation). If this list does not contain the element, it is unchanged. More formally, removes the element with the lowest index i such that Objects.equals(o, get(i)) (if such an element exists). Returns true if this list contained the specified element (or equivalently, if this list changed as a result of the call).

Parameters

object:Object: element to be removed from this list, if present

Returns:boolean

true if this list contained the specified element

Annotations

@Override

remove	back to summary
public T remove(int index) Overrides java.util.AbstractList.remove. Implements java.util.List.remove. Doc from java.util.AbstractList.remove. Removes the element at the specified position in this list (optional operation). Shifts any subsequent elements to the left (subtracts one from their indices). Returns the element that was removed from the list. Parameters index:int Doc from java.util.List.remove. the index of the element to be removed Returns:T Doc from java.util.List.remove. the element previously at the specified position Annotations @Override

remove

back to summary

public T remove(int index)

Overrides java.util.AbstractList.remove.

Implements java.util.List.remove.

Doc from java.util.AbstractList.remove.

Removes the element at the specified position in this list (optional operation). Shifts any subsequent elements to the left (subtracts one from their indices). Returns the element that was removed from the list.

Parameters

index:int

Doc from java.util.List.remove.

the index of the element to be removed

Returns:T

Doc from java.util.List.remove.

the element previously at the specified position

Annotations

@Override

removeAll back to summary

removeAll	back to summary
public boolean removeAll(Collection<?> c) Overrides java.util.AbstractCollection.removeAll. Implements java.util.List.removeAll, java.util.Collection.removeAll. Doc from java.util.List.removeAll. Removes from this list all of its elements that are contained in the specified collection (optional operation). Parameters c:Collection<?> collection containing elements to be removed from this list Returns:boolean `true` if this list changed as a result of the call Annotations @Override

public boolean removeAll(Collection<?> c)

Overrides java.util.AbstractCollection.removeAll.

Implements java.util.List.removeAll, java.util.Collection.removeAll.

Doc from java.util.List.removeAll.

Removes from this list all of its elements that are contained in the specified collection (optional operation).

Parameters

c:Collection<?>: collection containing elements to be removed from this list

Returns:boolean

true if this list changed as a result of the call

Annotations

@Override

set	back to summary
public T set(int index, T node) Overrides java.util.AbstractList.set. Implements java.util.List.set. Doc from java.util.AbstractList.set. Replaces the element at the specified position in this list with the specified element (optional operation). Parameters index:int Doc from java.util.List.set. index of the element to replace node:T Doc from java.util.List.set. element to be stored at the specified position Returns:T Doc from java.util.List.set. the element previously at the specified position Annotations @Override

set

back to summary

public T set(int index, T node)

Overrides java.util.AbstractList.set.

Implements java.util.List.set.

Doc from java.util.AbstractList.set.

Replaces the element at the specified position in this list with the specified element (optional operation).

Parameters

index:int

Doc from java.util.List.set.

index of the element to replace

node:T

Doc from java.util.List.set.

element to be stored at the specified position

Returns:T

Doc from java.util.List.set.

the element previously at the specified position

Annotations

@Override

size back to summary

size	back to summary
public int size() Implements abstract java.util.AbstractCollection.size. Implements java.util.List.size, java.util.Collection.size. Doc from java.util.List.size. Returns the number of elements in this list. If this list contains more than `Integer.MAX_VALUE` elements, returns `Integer.MAX_VALUE`. Returns:int the number of elements in this list Annotations @Override

public int size()

Implements abstract java.util.AbstractCollection.size.

Implements java.util.List.size, java.util.Collection.size.

Doc from java.util.List.size.

Returns the number of elements in this list. If this list contains more than Integer.MAX_VALUE elements, returns Integer.MAX_VALUE.

Returns:int

the number of elements in this list

Annotations

@Override

toArray	back to summary
public Object[] toArray() Overrides java.util.AbstractCollection.toArray. Implements java.util.List.toArray, java.util.Collection.toArray. Doc from java.util.List.toArray. 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. Returns:Object[] an array containing all of the elements in this list in proper sequence Annotations @Override

toArray

back to summary

public Object[] toArray()

Overrides java.util.AbstractCollection.toArray.

Implements java.util.List.toArray, java.util.Collection.toArray.

Doc from java.util.List.toArray.

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.

Returns:Object[]

an array containing all of the elements in this list in proper sequence

Annotations

@Override

toArray back to summary

toArray	back to summary
public Object[] toArray(Object[] a) Overrides java.util.AbstractCollection.toArray. Implements java.util.List.toArray, java.util.Collection.toArray. Doc from java.util.List.toArray. Returns an array containing all of the elements in this list in proper sequence (from first to last element); the runtime type of the returned array is that of the specified array. If the list fits in the specified array, it is returned therein. Otherwise, a new array is allocated with the runtime type of the specified array and the size of this list. If the list fits in the specified array with room to spare (i.e., the array has more elements than the list), the element in the array immediately following the end of the list is set to `null`. (This is useful in determining the length of the list only if the caller knows that the list does not contain any null elements.) Like the `toArray()` method, this method acts as bridge between array-based and collection-based APIs. Further, this method allows precise control over the runtime type of the output array, and may, under certain circumstances, be used to save allocation costs. Suppose `x` is a list known to contain only strings. The following code can be used to dump the list into a newly allocated array of `String`: `String[] y = x.toArray(new String[0]);` Note that `toArray(new Object[0])` is identical in function to `toArray()`. Parameters a:Object[] the array into which the elements of this list are to be stored, if it is big enough; otherwise, a new array of the same runtime type is allocated for this purpose. Returns:Object[] an array containing the elements of this list Annotations @Override

public Object[] toArray(Object[] a)

Overrides java.util.AbstractCollection.toArray.

Implements java.util.List.toArray, java.util.Collection.toArray.

Doc from java.util.List.toArray.

Returns an array containing all of the elements in this list in proper sequence (from first to last element); the runtime type of the returned array is that of the specified array. If the list fits in the specified array, it is returned therein. Otherwise, a new array is allocated with the runtime type of the specified array and the size of this list.

If the list fits in the specified array with room to spare (i.e., the array has more elements than the list), the element in the array immediately following the end of the list is set to null. (This is useful in determining the length of the list only if the caller knows that the list does not contain any null elements.)

Like the toArray() method, this method acts as bridge between array-based and collection-based APIs. Further, this method allows precise control over the runtime type of the output array, and may, under certain circumstances, be used to save allocation costs.

Suppose x is a list known to contain only strings. The following code can be used to dump the list into a newly allocated array of String:

String[] y = x.toArray(new String[0]);

Note that toArray(new Object[0]) is identical in function to toArray().

Parameters

a:Object[]: the array into which the elements of this list are to be stored, if it is big enough; otherwise, a new array of the same runtime type is allocated for this purpose.

Returns:Object[]

an array containing the elements of this list

Annotations

@Override

public Class ContentListFacade<T extends org.dom4j.Node>

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail