Modifier and Type	Class and Description
private class	VisitorList.EqualsHashcodeOverridingFacade

Modifier and Type	Field and Description
protected final GenericVisitor<Boolean, Visitable>	equalsVisitor
protected final GenericVisitor<Integer, Void>	hashcodeVisitor
protected List<VisitorList<N>.EqualsHashcodeOverridingFacade>	innerList

Access	Constructor and Description
public	VisitorList(GenericVisitor<Integer, Void> hashcodeVisitor, GenericVisitor<Boolean, Visitable> equalsVisitor) Pass the visitors to use for equals and hashcode.

Method Summary

Modifier and Type	Method and Description
public boolean	add(N element to be appended to this list elem) Implements java.util.List.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, N element to be inserted elem) Implements java.util.List.add. Inserts the specified element at the specified position in this list (optional operation).
public boolean	addAll(Collection<? extends N> collection containing elements to be added to this list col) Implements 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).
public boolean	addAll(int index at which to insert the first element from the specified collection index, Collection<? extends N> collection containing elements to be added to this list col) Implements java.util.List.addAll. Inserts all of the elements in the specified collection into this list at the specified position (optional operation).
public void	clear() Implements java.util.List.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 elem) Implements java.util.List.contains. Returns `true` if this list contains the specified element.
public boolean	containsAll(Collection<?> collection to be checked for containment in this list col) Implements java.util.List.containsAll. Returns `true` if this list contains all of the elements of the specified collection.
public N	get(int index of the element to return index) Implements java.util.List.get. Returns the element at the specified position in this list.
public int	indexOf(Object element to search for elem) 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() Implements java.util.List.isEmpty. Returns `true` if this list contains no elements.
public Iterator<N>	iterator() Implements java.util.List.iterator. Returns an iterator over the elements in this list in proper sequence.
public int	lastIndexOf(Object element to search for elem) 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 ListIterator<N>	listIterator() Implements java.util.List.listIterator. Returns a list iterator over the elements in this list (in proper sequence).
public ListIterator<N>	listIterator(int index of the first element to be returned from the list iterator (by a call to `next`) index) Implements java.util.List.listIterator. Returns a list iterator over the elements in this list (in proper sequence), starting at the specified position in the list.
public boolean	remove(Object element to be removed from this list, if present elem) Implements java.util.List.remove. Removes the first occurrence of the specified element from this list, if it is present (optional operation).
public N	remove(int the index of the element to be removed index) 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 col) Implements java.util.List.removeAll. Removes from this list all of its elements that are contained in the specified collection (optional operation).
public boolean	retainAll(Collection<?> collection containing elements to be retained in this list col) Implements java.util.List.retainAll. Retains only the elements in this list that are contained in the specified collection (optional operation).
public N	set(int index of the element to replace index, N element to be stored at the specified position elem) 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 java.util.List.size. Returns the number of elements in this list.
public List<N>	subList(int low endpoint (inclusive) of the subList fromIndex, int high endpoint (exclusive) of the subList toIndex) Implements java.util.List.subList. Returns a view of the portion of this list between the specified `fromIndex`, inclusive, and `toIndex`, exclusive.
public Object[]	toArray() Implements java.util.List.toArray. Returns an array containing all of the elements in this list in proper sequence (from first to last element).
public <T> T[]	toArray(T[] 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. arr) Implements 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.
public String	toString() Overrides java.lang.Object.toString. Returns a string representation of the object.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll wait wait wait

Field Detail

equalsVisitor	back to summary
protected final GenericVisitor<Boolean, Visitable> equalsVisitor

hashcodeVisitor	back to summary
protected final GenericVisitor<Integer, Void> hashcodeVisitor

innerList	back to summary
protected List<VisitorList<N>.EqualsHashcodeOverridingFacade> innerList

Constructor Detail

VisitorList	back to summary
public VisitorList(GenericVisitor<Integer, Void> hashcodeVisitor, GenericVisitor<Boolean, Visitable> equalsVisitor) Pass the visitors to use for equals and hashcode.

Method Detail

add back to summary

add	back to summary
public boolean add(N elem) Implements java.util.List.add. Doc from java.util.List.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 elem:N element to be appended to this list Returns:boolean `true` (as specified by `Collection#add`) Annotations @Override

public boolean add(N elem)

Implements java.util.List.add.

Doc from java.util.List.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

elem:N: 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, N elem) Implements java.util.List.add. Doc from java.util.List.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 index at which the specified element is to be inserted elem:N element to be inserted Annotations @Override

add

back to summary

public void add(int index, N elem)

Implements java.util.List.add.

Doc from java.util.List.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: index at which the specified element is to be inserted
elem:N: element to be inserted

Annotations

@Override

addAll back to summary

addAll	back to summary
public boolean addAll(Collection<? extends N> col) Implements java.util.List.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 col:Collection<? extends N> 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 N> col)

Implements java.util.List.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

col:Collection<? extends N>: 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 N> col) Implements java.util.List.addAll. Doc from java.util.List.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 index at which to insert the first element from the specified collection col:Collection<? extends N> 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(int index, Collection<? extends N> col)

Implements java.util.List.addAll.

Doc from java.util.List.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: index at which to insert the first element from the specified collection
col:Collection<? extends N>: collection containing elements to be added to this list

Returns:boolean

true if this list changed as a result of the call

Annotations

@Override

clear	back to summary
public void clear() Implements java.util.List.clear. Doc from java.util.List.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()

Implements java.util.List.clear.

Doc from java.util.List.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 elem) Implements java.util.List.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 elem: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 elem)

Implements java.util.List.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

elem: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<?> col) Implements java.util.List.containsAll. Doc from java.util.List.containsAll. Returns `true` if this list contains all of the elements of the specified collection. Parameters col: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<?> col)

Implements java.util.List.containsAll.

Doc from java.util.List.containsAll.

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

Parameters

col: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 N get(int index) Implements java.util.List.get. Doc from java.util.List.get. Returns the element at the specified position in this list. Parameters index:int index of the element to return Returns:N the element at the specified position in this list Annotations @Override

get

back to summary

public N get(int index)

Implements java.util.List.get.

Doc from java.util.List.get.

Returns the element at the specified position in this list.

Parameters

index:int: index of the element to return

Returns:N

the element at the specified position in this list

Annotations

@Override

indexOf back to summary

indexOf	back to summary
public int indexOf(Object elem) Implements java.util.List.indexOf. Doc from 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. More formally, returns the lowest index `i` such that `Objects.equals(o, get(i))`, or -1 if there is no such index. Parameters elem:Object element to search for Returns:int 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 elem)

Implements java.util.List.indexOf.

Doc from 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. More formally, returns the lowest index i such that Objects.equals(o, get(i)), or -1 if there is no such index.

Parameters

elem:Object: element to search for

Returns:int

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() Implements java.util.List.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()

Implements java.util.List.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

iterator	back to summary
public Iterator<N> iterator() Implements java.util.List.iterator. Doc from java.util.List.iterator. Returns an iterator over the elements in this list in proper sequence. Returns:Iterator<N> an iterator over the elements in this list in proper sequence Annotations @Override

iterator

back to summary

public Iterator<N> iterator()

Implements java.util.List.iterator.

Doc from java.util.List.iterator.

Returns an iterator over the elements in this list in proper sequence.

Returns:Iterator<N>

an iterator over the elements in this list in proper sequence

Annotations

@Override

lastIndexOf back to summary

lastIndexOf	back to summary
public int lastIndexOf(Object elem) Implements java.util.List.lastIndexOf. Doc from 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. More formally, returns the highest index `i` such that `Objects.equals(o, get(i))`, or -1 if there is no such index. Parameters elem:Object element to search for Returns:int 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 elem)

Implements java.util.List.lastIndexOf.

Doc from 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. More formally, returns the highest index i such that Objects.equals(o, get(i)), or -1 if there is no such index.

Parameters

elem:Object: element to search for

Returns:int

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

listIterator	back to summary
public ListIterator<N> listIterator() Implements java.util.List.listIterator. Doc from java.util.List.listIterator. Returns a list iterator over the elements in this list (in proper sequence). Returns:ListIterator<N> a list iterator over the elements in this list (in proper sequence) Annotations @Override

listIterator

back to summary

public ListIterator<N> listIterator()

Implements java.util.List.listIterator.

Doc from java.util.List.listIterator.

Returns a list iterator over the elements in this list (in proper sequence).

Returns:ListIterator<N>

a list iterator over the elements in this list (in proper sequence)

Annotations

@Override

listIterator back to summary

listIterator	back to summary
public ListIterator<N> listIterator(int index) Implements java.util.List.listIterator. Doc from java.util.List.listIterator. Returns a list iterator over the elements in this list (in proper sequence), starting at the specified position in the list. The specified index indicates the first element that would be returned by an initial call to `next`. An initial call to `previous` would return the element with the specified index minus one. Parameters index:int index of the first element to be returned from the list iterator (by a call to `next`) Returns:ListIterator<N> a list iterator over the elements in this list (in proper sequence), starting at the specified position in the list Annotations @Override

public ListIterator<N> listIterator(int index)

Implements java.util.List.listIterator.

Doc from java.util.List.listIterator.

Returns a list iterator over the elements in this list (in proper sequence), starting at the specified position in the list. The specified index indicates the first element that would be returned by an initial call to next. An initial call to previous would return the element with the specified index minus one.

Parameters

index:int: index of the first element to be returned from the list iterator (by a call to next)

Returns:ListIterator<N>

a list iterator over the elements in this list (in proper sequence), starting at the specified position in the list

Annotations

@Override

remove back to summary

remove	back to summary
public boolean remove(Object elem) Implements java.util.List.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 elem: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 elem)

Implements java.util.List.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

elem: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 N remove(int index) Implements java.util.List.remove. Doc from java.util.List.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 the index of the element to be removed Returns:N the element previously at the specified position Annotations @Override

remove

back to summary

public N remove(int index)

Implements java.util.List.remove.

Doc from java.util.List.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: the index of the element to be removed

Returns:N

the element previously at the specified position

Annotations

@Override

removeAll back to summary

removeAll	back to summary
public boolean removeAll(Collection<?> col) Implements java.util.List.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 col: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<?> col)

Implements java.util.List.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

col: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

retainAll back to summary

retainAll	back to summary
public boolean retainAll(Collection<?> col) Implements java.util.List.retainAll. Doc from java.util.List.retainAll. Retains only the elements in this list that are contained in the specified collection (optional operation). In other words, removes from this list all of its elements that are not contained in the specified collection. Parameters col:Collection<?> collection containing elements to be retained in this list Returns:boolean `true` if this list changed as a result of the call Annotations @Override

public boolean retainAll(Collection<?> col)

Implements java.util.List.retainAll.

Doc from java.util.List.retainAll.

Retains only the elements in this list that are contained in the specified collection (optional operation). In other words, removes from this list all of its elements that are not contained in the specified collection.

Parameters

col:Collection<?>: collection containing elements to be retained in this list

Returns:boolean

true if this list changed as a result of the call

Annotations

@Override

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

set

back to summary

public N set(int index, N elem)

Implements java.util.List.set.

Doc from java.util.List.set.

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

Parameters

index:int: index of the element to replace
elem:N: element to be stored at the specified position

Returns:N

the element previously at the specified position

Annotations

@Override

size back to summary

size	back to summary
public int size() Implements java.util.List.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 java.util.List.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

subList back to summary

subList	back to summary
public List<N> subList(int fromIndex, int toIndex) Implements java.util.List.subList. Doc from java.util.List.subList. Returns 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.) Parameters fromIndex:int low endpoint (inclusive) of the subList toIndex:int high endpoint (exclusive) of the subList Returns:List<N> a view of the specified range within this list Annotations @Override

public List<N> subList(int fromIndex, int toIndex)

Implements java.util.List.subList.

Doc from java.util.List.subList.

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

Parameters

fromIndex:int: low endpoint (inclusive) of the subList
toIndex:int: high endpoint (exclusive) of the subList

Returns:List<N>

a view of the specified range within this list

Annotations

@Override

toArray	back to summary
public Object[] toArray() Implements java.util.List.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()

Implements java.util.List.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 <T> T[] toArray(T[] arr) Implements java.util.List.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 <T> Doc from java.util.Collection.toArray. the component type of the array to contain the collection arr:T[] 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:T[] an array containing the elements of this list Annotations @Override

public <T> T[] toArray(T[] arr)

Implements java.util.List.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

<T>: Doc from java.util.Collection.toArray. the component type of the array to contain the collection
arr:T[]: 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:T[]

an array containing the elements of this list

Annotations

@Override

toString	back to summary
public String toString() Overrides java.lang.Object.toString. Doc from java.lang.Object.toString. Returns a string representation of the object. Returns:String a string representation of the object Annotations @Override

toString

back to summary

public String toString()

Overrides java.lang.Object.toString.

Doc from java.lang.Object.toString.

Returns a string representation of the object.

Returns:String

a string representation of the object

Annotations

@Override

com.github.javaparser.utils back to summary

private Class VisitorList.EqualsHashcodeOverridingFacade

Class Inheritance

extends Object
implements Visitable

java.lang.Object
com.github.javaparser.utils.VisitorList.EqualsHashcodeOverridingFacade

All Implemented Interfaces

com.github.javaparser.ast.visitor.Visitable

Field Summary

Modifier and Type	Field and Description
private final N	overridden

Constructor Summary

Access	Constructor and Description
pack-priv	EqualsHashcodeOverridingFacade(N overridden)

Method Summary

Modifier and Type	Method and Description
public <R, A> R	accept(GenericVisitor<R, A> the visitor implementation v, A the argument passed to the visitor (of type A) arg) Implements com.github.javaparser.ast.visitor.Visitable.accept. Accept method for visitor support.
public <A> void	accept(VoidVisitor<A> the visitor implementation v, A any value relevant for the visitor (of type A) arg) Implements com.github.javaparser.ast.visitor.Visitable.accept. Accept method for visitor support.
public boolean	equals(final Object the reference object with which to compare. obj) Overrides java.lang.Object.equals. Indicates whether some other object is "equal to" this one.
public final int	hashCode() Overrides java.lang.Object.hashCode. Returns a hash code value for this object.

Inherited from java.lang.Object:: clone finalize getClass notify notifyAll toString wait wait wait

Field Detail

overridden	back to summary
private final N overridden

Constructor Detail

EqualsHashcodeOverridingFacade	back to summary
pack-priv EqualsHashcodeOverridingFacade(N overridden)

Method Detail

accept	back to summary
public <R, A> R accept(GenericVisitor<R, A> v, A arg) Implements com.github.javaparser.ast.visitor.Visitable.accept. Doc from com.github.javaparser.ast.visitor.Visitable.accept. Accept method for visitor support. Parameters <R> the type of the return value of the visitor <A> the type the user argument passed to the visitor v:GenericVisitor<R, A> the visitor implementation arg:A the argument passed to the visitor (of type A) Returns:R the result of the visit (of type R) Annotations @Override

back to summary

public <R, A> R accept(GenericVisitor<R, A> v, A arg)

Implements com.github.javaparser.ast.visitor.Visitable.accept.

Doc from com.github.javaparser.ast.visitor.Visitable.accept.

Accept method for visitor support.

Parameters

<R>: the type of the return value of the visitor
<A>: the type the user argument passed to the visitor
v:GenericVisitor<R, A>: the visitor implementation
arg:A: the argument passed to the visitor (of type A)

Returns:R

the result of the visit (of type R)

Annotations

@Override

accept	back to summary
public <A> void accept(VoidVisitor<A> v, A arg) Implements com.github.javaparser.ast.visitor.Visitable.accept. Doc from com.github.javaparser.ast.visitor.Visitable.accept. Accept method for visitor support. Parameters <A> the type the argument passed for the visitor v:VoidVisitor<A> the visitor implementation arg:A any value relevant for the visitor (of type A) Annotations @Override

back to summary

public <A> void accept(VoidVisitor<A> v, A arg)

Implements com.github.javaparser.ast.visitor.Visitable.accept.

Doc from com.github.javaparser.ast.visitor.Visitable.accept.

Accept method for visitor support.

Parameters

<A>: the type the argument passed for the visitor
v:VoidVisitor<A>: the visitor implementation
arg:A: any value relevant for the visitor (of type A)

Annotations

@Override

equals back to summary

equals	back to summary
public boolean equals(final Object obj) Overrides java.lang.Object.equals. Doc from java.lang.Object.equals. Indicates whether some other object is "equal to" this one. The `equals` method implements an equivalence relation on non-null object references: It is reflexive: for any non-null reference value `x`, `x.equals(x)` should return `true`. It is symmetric: for any non-null reference values `x` and `y`, `x.equals(y)` should return `true` if and only if `y.equals(x)` returns `true`. It is transitive: for any non-null reference values `x`, `y`, and `z`, if `x.equals(y)` returns `true` and `y.equals(z)` returns `true`, then `x.equals(z)` should return `true`. It is consistent: for any non-null reference values `x` and `y`, multiple invocations of `x.equals(y)` consistently return `true` or consistently return `false`, provided no information used in `equals` comparisons on the objects is modified. For any non-null reference value `x`, `x.equals(null)` should return `false`. An equivalence relation partitions the elements it operates on into equivalence classes; all the members of an equivalence class are equal to each other. Members of an equivalence class are substitutable for each other, at least for some purposes. Parameters obj:Object the reference object with which to compare. Returns:boolean `true` if this object is the same as the obj argument; `false` otherwise. Annotations @Override

public boolean equals(final Object obj)

Overrides java.lang.Object.equals.

Doc from java.lang.Object.equals.

Indicates whether some other object is "equal to" this one.

The equals method implements an equivalence relation on non-null object references:

It is reflexive: for any non-null reference value x, x.equals(x) should return true.
It is symmetric: for any non-null reference values x and y, x.equals(y) should return true if and only if y.equals(x) returns true.
It is transitive: for any non-null reference values x, y, and z, if x.equals(y) returns true and y.equals(z) returns true, then x.equals(z) should return true.
It is consistent: for any non-null reference values x and y, multiple invocations of x.equals(y) consistently return true or consistently return false, provided no information used in equals comparisons on the objects is modified.
For any non-null reference value x, x.equals(null) should return false.

An equivalence relation partitions the elements it operates on into equivalence classes; all the members of an equivalence class are equal to each other. Members of an equivalence class are substitutable for each other, at least for some purposes.

Parameters

obj:Object: the reference object with which to compare.

Returns:boolean

true if this object is the same as the obj argument; false otherwise.

Annotations

@Override

hashCode back to summary

hashCode	back to summary
public final int hashCode() Overrides java.lang.Object.hashCode. Doc from java.lang.Object.hashCode. Returns a hash code value for this object. This method is supported for the benefit of hash tables such as those provided by `java.util.HashMap`. The general contract of `hashCode` is: Whenever it is invoked on the same object more than once during an execution of a Java application, the `hashCode` method must consistently return the same integer, provided no information used in `equals` comparisons on the object is modified. This integer need not remain consistent from one execution of an application to another execution of the same application. If two objects are equal according to the `equals` method, then calling the `hashCode` method on each of the two objects must produce the same integer result. It is not required that if two objects are unequal according to the `equals` method, then calling the `hashCode` method on each of the two objects must produce distinct integer results. However, the programmer should be aware that producing distinct integer results for unequal objects may improve the performance of hash tables. Returns:int a hash code value for this object Annotations @Override

public final int hashCode()

Overrides java.lang.Object.hashCode.

Doc from java.lang.Object.hashCode.

Returns a hash code value for this object. This method is supported for the benefit of hash tables such as those provided by java.util.HashMap.

The general contract of hashCode is:

Whenever it is invoked on the same object more than once during an execution of a Java application, the hashCode method must consistently return the same integer, provided no information used in equals comparisons on the object is modified. This integer need not remain consistent from one execution of an application to another execution of the same application.
If two objects are equal according to the equals method, then calling the hashCode method on each of the two objects must produce the same integer result.
It is not required that if two objects are unequal according to the equals method, then calling the hashCode method on each of the two objects must produce distinct integer results. However, the programmer should be aware that producing distinct integer results for unequal objects may improve the performance of hash tables.

Returns:int

a hash code value for this object

Annotations

@Override

public Class VisitorList<N extends Node>

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

private Class VisitorList.EqualsHashcodeOverridingFacade

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail