org.jtool.jxplatform.wrapper.collection
Class JxMethodList

java.lang.Object
  org.jtool.jxplatform.wrapper.collection.JxMethodList

public class JxMethodList

extends java.lang.Object

A list of JxMethod wrappers.

Author:

Katsuhsa Maruyama

Constructor Summary

JxMethodList()
Creates a new, empty list object.

JxMethodList(org.w3c.dom.Element[] elems)
Creates a new list containing DOM elements of an array.

JxMethodList(JxMethodList list)
Creates a new list from a list of JxMethod wrappers.

Method Summary

boolean	add(int index, JxMethod jm) Inserts a wrapper at a position in this list.
boolean	add(JxMethod jm) Appends a wrapper to the end of this list.
void	addAll(JxMethodList list) Appends all wrappers in a list to the end of this list.
boolean	addFirst(JxMethod jm) Inserts a wrapper at the beginning of this list.
boolean	addLast(JxMethod jm) Appends a wrapper to the end of this list.
void	clear() Removes all wrappers from this list.
boolean	contains(JxMethod jm) Tests if this list contains a wrapper.
boolean	containsAll(JxMethodList list) Tests if this list contains all wrappers of a list.
JxMethod	get(int index) Returns a wrapper at the position in this list.
JxMethod	getFirst() Returns the first wrapper in this list.
java.lang.String	getInfo() Obtains information about this list.
JxMethod	getJxMethod(JxMethod jm) Returns a wrapper in this list that indicates the same DOM element of a wrapper.
JxMethod	getJxMethod(java.lang.String sig) Returns a wrapper with a signature in this list.
JxMethod	getLast() Returns the last wrapper in this list.
boolean	isEmpty() Tests if this list contains no wrapper.
java.util.Iterator	iterator() Returns an iterator of this list in proper sequence.
void	print() Displays information about this list.
JxMethod	remove(int index) Removes a wrapper at a position in this list.
boolean	remove(JxMethod jm) Removes a wrapper from this list.
void	removeAll(JxMethodList list) Removes all wrappers in a list from this list.
JxMethod	removeFirst() Removes the first wrapper from this list.
JxMethod	removeLast() Removes the last wrapper from this list.
boolean	retainAll(JxMethodList list) Retains only wrappers in this list that are contained in a specified list.
int	size() Returns the number of wrappers in this list.
JxMethod[]	toArray() Returns an array containing all wrappers in this list in proper sequence.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

JxMethodList

public JxMethodList()

Creates a new, empty list object.

JxMethodList

public JxMethodList(JxMethodList list)

Creates a new list from a list of JxMethod wrappers.

Parameters:

list - A list of wrappers.

JxMethodList

public JxMethodList(org.w3c.dom.Element[] elems)
             throws JxWrapperException

Creates a new list containing DOM elements of an array.

Parameters:

elems - An array of DOM elements.

Throws:

JxWrapperException - if the array contains elements other than the element.

Method Detail

clear

public void clear()

Removes all wrappers from this list.

add

public boolean add(JxMethod jm)

Appends a wrapper to the end of this list.

Parameters:

jm - A wrapper to be appended.

Returns:

true if this list changed as a result of the call.

add

public boolean add(int index,
                   JxMethod jm)

Inserts a wrapper at a position in this list.

Parameters:

index - A position where a wrapper is inserted.

jm - A wrapper to be inserted.

Returns:

true if this list changed as a result of the call.

addAll

public void addAll(JxMethodList list)

Appends all wrappers in a list to the end of this list.

Parameters:

list - A list of wrappes to be appended.

remove

public boolean remove(JxMethod jm)

Removes a wrapper from this list.

Parameters:

jm - A wrapper to be removed.

Returns:

true if this list changed as a result of the call.

removeAll

public void removeAll(JxMethodList list)

Removes all wrappers in a list from this list.

Parameters:

list - A list of wrappers to be removed.

remove

public JxMethod remove(int index)

Removes a wrapper at a position in this list.

Parameters:

index - A position where a wrapper is removed.

Returns:

The removed wrapper, null if there is no removed wrapper.

retainAll

public boolean retainAll(JxMethodList list)

Retains only wrappers in this list that are contained in a specified list.

Parameters:

list - A list of wrappers to be retained.

Returns:

true if this list changed as a result of the call.

contains

public boolean contains(JxMethod jm)

Tests if this list contains a wrapper.

Parameters:

jm - A wrapper to be tested.

Returns:

true if the wrapper is present, otherwise false.

containsAll

public boolean containsAll(JxMethodList list)

Tests if this list contains all wrappers of a list.

Parameters:

list - A list of wrappers to be tested.

Returns:

true if this list contains all of the wrappers of the list, otherwise false.

get

public JxMethod get(int index)

Returns a wrapper at the position in this list.

Parameters:

index - The position where a wrapper is obtained.

Returns:

The wrapper at the position, null if there is no wrapper found.

getFirst

public JxMethod getFirst()

Returns the first wrapper in this list.

Returns:

The first wrapper.

getLast

public JxMethod getLast()

Returns the last wrapper in this list.

Returns:

The last wrapper.

addFirst

public boolean addFirst(JxMethod jm)

Inserts a wrapper at the beginning of this list.

Parameters:

jm - A wrapper to be inserted.

Returns:

true if this list changed as a result of the call.

addLast

public boolean addLast(JxMethod jm)

Appends a wrapper to the end of this list.

Parameters:

jm - A wrapper to be append.

Returns:

true if this list changed as a result of the call.

removeFirst

public JxMethod removeFirst()

Removes the first wrapper from this list.

Returns:

The removed wrapper, null if no wrapper was removed.

removeLast

public JxMethod removeLast()

Removes the last wrapper from this list.

Returns:

The removed wrapper, null if no element was removed.

isEmpty

public boolean isEmpty()

Tests if this list contains no wrapper.

Returns:

true if this list contains no wrapper, otherwise false.

size

public int size()

Returns the number of wrappers in this list.

Returns:

The number of wrappers.

iterator

public java.util.Iterator iterator()

Returns an iterator of this list in proper sequence.

Returns:

The iterator of this list.

getJxMethod

public JxMethod getJxMethod(JxMethod jm)

Returns a wrapper in this list that indicates the same DOM element of a wrapper.

Parameters:

jm - A wrapper to be retrived.

Returns:

The matched wrapper in this list, null if there is no wrapper matched.

getJxMethod

public JxMethod getJxMethod(java.lang.String sig)

Returns a wrapper with a signature in this list.

Parameters:

sig - The signature of a method to be retrived.

Returns:

The matched wrapper in this list, null if there is no wrapper matched.

toArray

public JxMethod[] toArray()

Returns an array containing all wrappers in this list in proper sequence.

Returns:

The array of wrappers.

print

public void print()

Displays information about this list.

getInfo

public java.lang.String getInfo()

Obtains information about this list.

Returns:

The text describing the information.