com.isti.quakewatch.alert
Class AlertRecipientsList

java.lang.Object
  extended by com.isti.quakewatch.alert.AlertRecipientsList
All Implemented Interfaces:
java.lang.Iterable, java.util.Collection, java.util.List

public class AlertRecipientsList
extends java.lang.Object
implements java.util.List

Class AlertRecipientsList defines an alert recipients list.


Field Summary
 javax.swing.AbstractAction addButtonActionObj
          Action object for the "Add" button (and menu item).
protected  javax.swing.JButton addButtonObj
           
 javax.swing.AbstractAction editButtonActionObj
          Action object for the "Edit" button (and menu item).
protected  javax.swing.JButton editButtonObj
           
protected  boolean inRemoveSelRecipsMethodFlag
          Flag set true while inside 'doRemoveSelectedRecipients()' method.
protected  boolean mouseClickEditFlag
          Flag set true if recipient-edit via double-click on list is enabled.
protected  javax.swing.JPanel recipientGUIPanel
          Panel setup via 'setGUI()'.
protected  javax.swing.JList recipientsJListObj
          GUI list holding entries for recipients.
protected  java.util.List recipientsListObj
           
 javax.swing.AbstractAction regionsButtonActionObj
          Action object for the "Regions" button (and menu item).
protected  javax.swing.JButton regionsButtonObj
           
 javax.swing.AbstractAction removeButtonActionObj
          Action object for the "Remove" button (and menu item).
protected  javax.swing.JButton removeButtonObj
           
 
Constructor Summary
AlertRecipientsList(QWProgramInformationInterface progInfo, CfgSettingsDialog cfgSettingsDialog)
          Creates an alert recipients list.
AlertRecipientsList(QWProgramInformationInterface progInfo, CfgSettingsDialog cfgSettingsDialog, boolean tearOffRegionsDlgFlag)
          Creates an alert recipients list.
AlertRecipientsList(QWProgramInformationInterface progInfo, CfgSettingsDialog cfgSettingsDialog, boolean tearOffRegionsDlgFlag, IstiRegionMgrIntf istiRegionMgrObj)
          Creates an alert recipients list.
 
Method Summary
 void add(int index, java.lang.Object element)
          Inserts the specified element at the specified position in this list (optional operation).
 boolean add(java.lang.Object o)
          Appends the specified element to the end of this list (optional operation).
 boolean addAll(java.util.Collection c)
          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).
 boolean addAll(int index, java.util.Collection c)
          Inserts all of the elements in the specified collection into this list at the specified position (optional operation).
 void clear()
          Removes all of the elements from this list (optional operation).
 void commitRecipient(AlertRecipient recipObj)
          Commits changes to the given recipient.
 boolean contains(java.lang.Object o)
          Returns true if this list contains the specified element.
 boolean containsAll(java.util.Collection c)
          Returns true if this list contains all of the elements of the specified collection.
protected  javax.swing.JPanel createButtonPanel()
          Creates the button panel.
 boolean equals(java.lang.Object o)
          Compares the specified object with this list for equality.
 java.lang.Object get(int index)
          Returns the element at the specified position in this list.
 boolean getAnyEnabledRecipsFlag()
          Determines whether or not this list contains any send-enabled recipients.
 IstiRegionMgrIntf getIstiRegionMgrObj()
          Returns the region-manager object.
 javax.swing.JPanel getRecipientGUIPanel()
          Returns the panel setup via 'setupGUI()'.
static java.awt.Component getWindowForComponent(java.awt.Component compObj)
          Returns the specified component's parent Frame or Dialog object.
 int hashCode()
          Returns the hash code value for this list.
 int indexOf(java.lang.Object o)
          Returns the index in this list of the first occurrence of the specified element, or -1 if this list does not contain this element.
 boolean isEmpty()
          Returns true if this list contains no elements.
 java.util.Iterator iterator()
          Returns an iterator over the elements in this list in proper sequence.
 int lastIndexOf(java.lang.Object o)
          Returns the index in this list of the last occurrence of the specified element, or -1 if this list does not contain this element.
 java.util.ListIterator listIterator()
          Returns a list iterator of the elements in this list (in proper sequence).
 java.util.ListIterator listIterator(int index)
          Returns a list iterator of the elements in this list (in proper sequence), starting at the specified position in this list.
 boolean processMenuItemEvent(java.lang.String nameStr)
          Called when a MenuItem event happens.
 java.lang.Object remove(int index)
          Removes the element at the specified position in this list (optional operation).
 boolean remove(java.lang.Object o)
          Removes the first occurrence in this list of the specified element (optional operation).
 boolean removeAll(java.util.Collection c)
          Removes from this list all the elements that are contained in the specified collection (optional operation).
 boolean retainAll(java.util.Collection c)
          Retains only the elements in this list that are contained in the specified collection (optional operation).
 void sendGlobalAlarmAlerts(QWEventMsgRecord eventRecObj)
          Sends new alert messages to those recipients that have alert-on-global-alarm enabled.
 java.lang.Object set(int index, java.lang.Object element)
          Replaces the element at the specified position in this list with the specified element (optional operation).
protected  void setButtonsEnabled(boolean flgVal)
          Enables or disables the button components.
 javax.swing.JPanel setupGUI(ConnectionStatusPanel connStatusPanel)
          Sets up the GUI.
 void showConfigDialog(AlertRecipient recipObj)
          Shows the configuration dialog for the specified alert recipient.
 void showRegionsConfigDialog(AlertRecipient recipObj)
          Shows the regions configuration dialog for the specified alert recipient.
 int size()
          Returns the number of elements in this list.
 java.util.List subList(int fromIndex, int toIndex)
          Returns a view of the portion of this list between the specified fromIndex, inclusive, and toIndex, exclusive.
 java.lang.Object[] toArray()
          Returns an array containing all of the elements in this list in proper sequence.
 java.lang.Object[] toArray(java.lang.Object[] a)
          Returns an array containing all of the elements in this list in proper sequence; the runtime type of the returned array is that of the specified array.
 void updateAlertRecipients()
          Update the alert recipients.
protected  void updateListModel()
          Updates the list model.
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

recipientsListObj

protected final java.util.List recipientsListObj

recipientsJListObj

protected final javax.swing.JList recipientsJListObj
GUI list holding entries for recipients.


recipientGUIPanel

protected javax.swing.JPanel recipientGUIPanel
Panel setup via 'setGUI()'.


inRemoveSelRecipsMethodFlag

protected boolean inRemoveSelRecipsMethodFlag
Flag set true while inside 'doRemoveSelectedRecipients()' method.


mouseClickEditFlag

protected boolean mouseClickEditFlag
Flag set true if recipient-edit via double-click on list is enabled.


addButtonActionObj

public final javax.swing.AbstractAction addButtonActionObj
Action object for the "Add" button (and menu item).


addButtonObj

protected javax.swing.JButton addButtonObj

editButtonActionObj

public final javax.swing.AbstractAction editButtonActionObj
Action object for the "Edit" button (and menu item).


editButtonObj

protected javax.swing.JButton editButtonObj

regionsButtonActionObj

public final javax.swing.AbstractAction regionsButtonActionObj
Action object for the "Regions" button (and menu item).


regionsButtonObj

protected javax.swing.JButton regionsButtonObj

removeButtonActionObj

public final javax.swing.AbstractAction removeButtonActionObj
Action object for the "Remove" button (and menu item).


removeButtonObj

protected javax.swing.JButton removeButtonObj
Constructor Detail

AlertRecipientsList

public AlertRecipientsList(QWProgramInformationInterface progInfo,
                           CfgSettingsDialog cfgSettingsDialog,
                           boolean tearOffRegionsDlgFlag,
                           IstiRegionMgrIntf istiRegionMgrObj)
Creates an alert recipients list.

Parameters:
progInfo - the program information.
cfgSettingsDialog - the config settings dialog.
tearOffRegionsDlgFlag - true to "tear off" the regions dialog (and close the settings dialog while the regions are being edited); false to use the parent dialog.
istiRegionMgrObj - region manager object to use, or null for none.

AlertRecipientsList

public AlertRecipientsList(QWProgramInformationInterface progInfo,
                           CfgSettingsDialog cfgSettingsDialog,
                           boolean tearOffRegionsDlgFlag)
Creates an alert recipients list.

Parameters:
progInfo - the program information.
cfgSettingsDialog - the config settings dialog.
tearOffRegionsDlgFlag - true to "tear off" the regions dialog (and close the settings dialog while the regions are being edited); false to use the parent dialog.

AlertRecipientsList

public AlertRecipientsList(QWProgramInformationInterface progInfo,
                           CfgSettingsDialog cfgSettingsDialog)
Creates an alert recipients list.

Parameters:
progInfo - the program information.
cfgSettingsDialog - the config settings dialog.
Method Detail

commitRecipient

public void commitRecipient(AlertRecipient recipObj)
Commits changes to the given recipient. The GUI list of recipients and the configuration file are updated. If the recipient is not on the list then it is added.

Parameters:
recipObj - the recipient object to use.

processMenuItemEvent

public boolean processMenuItemEvent(java.lang.String nameStr)
Called when a MenuItem event happens.

Parameters:
nameStr - the name of the menu item.
Returns:
true if the MenuItem event is for a recipient, false otherwise. NOTE: This method should only be called from the event dispatch thread.

sendGlobalAlarmAlerts

public void sendGlobalAlarmAlerts(QWEventMsgRecord eventRecObj)
Sends new alert messages to those recipients that have alert-on-global-alarm enabled. If an alarm-alert would already be triggered for the recipient then one is not triggered by this method.

Parameters:
eventRecObj - message record for event.

setupGUI

public javax.swing.JPanel setupGUI(ConnectionStatusPanel connStatusPanel)
Sets up the GUI.

Parameters:
connStatusPanel - the 'ConnectionStatusPanel' or null for none.
Returns:
the recipient panel.

getRecipientGUIPanel

public javax.swing.JPanel getRecipientGUIPanel()
Returns the panel setup via 'setupGUI()'.

Returns:
The 'JPanel' object setup via 'setupGUI()', or null if none has been setup.

createButtonPanel

protected javax.swing.JPanel createButtonPanel()
Creates the button panel.

Returns:
the button panel.

updateAlertRecipients

public void updateAlertRecipients()
Update the alert recipients.


updateListModel

protected void updateListModel()
Updates the list model.


showConfigDialog

public void showConfigDialog(AlertRecipient recipObj)
Shows the configuration dialog for the specified alert recipient.

Parameters:
recipObj - the alert recipient.

showRegionsConfigDialog

public void showRegionsConfigDialog(AlertRecipient recipObj)
Shows the regions configuration dialog for the specified alert recipient.

Parameters:
recipObj - the alert recipient.

getWindowForComponent

public static java.awt.Component getWindowForComponent(java.awt.Component compObj)
Returns the specified component's parent Frame or Dialog object.

Parameters:
compObj - Component to check.
Returns:
The Frame or Dialog that contains the component, or the given component if it does not have a valid Frame or Dialog parent.

setButtonsEnabled

protected void setButtonsEnabled(boolean flgVal)
Enables or disables the button components.

Parameters:
flgVal - true to enable, false to disable.

getAnyEnabledRecipsFlag

public boolean getAnyEnabledRecipsFlag()
Determines whether or not this list contains any send-enabled recipients.

Returns:
true if this list contains any send-enabled recipients; false if not.

getIstiRegionMgrObj

public IstiRegionMgrIntf getIstiRegionMgrObj()
Returns the region-manager object.

Returns:
The region-manager object, or null if none available.

size

public int size()
Returns the number of elements in this list. If this list contains more than Integer.MAX_VALUE elements, returns Integer.MAX_VALUE.

Specified by:
size in interface java.util.Collection
Specified by:
size in interface java.util.List
Returns:
the number of elements in this list.

isEmpty

public boolean isEmpty()
Returns true if this list contains no elements.

Specified by:
isEmpty in interface java.util.Collection
Specified by:
isEmpty in interface java.util.List
Returns:
true if this list contains no elements.

contains

public boolean contains(java.lang.Object o)
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 (o==null ? e==null : o.equals(e)).

Specified by:
contains in interface java.util.Collection
Specified by:
contains in interface java.util.List
Parameters:
o - element whose presence in this list is to be tested.
Returns:
true if this list contains the specified element.
Throws:
java.lang.ClassCastException - if the type of the specified element is incompatible with this list (optional).
java.lang.NullPointerException - if the specified element is null and this list does not support null elements (optional).

iterator

public java.util.Iterator iterator()
Returns an iterator over the elements in this list in proper sequence.

Specified by:
iterator in interface java.lang.Iterable
Specified by:
iterator in interface java.util.Collection
Specified by:
iterator in interface java.util.List
Returns:
an iterator over the elements in this list in proper sequence.

toArray

public java.lang.Object[] toArray()
Returns an array containing all of the elements in this list in proper sequence. Obeys the general contract of the Collection.toArray method.

Specified by:
toArray in interface java.util.Collection
Specified by:
toArray in interface java.util.List
Returns:
an array containing all of the elements in this list in proper sequence.
See Also:
Arrays.asList(Object[])

toArray

public java.lang.Object[] toArray(java.lang.Object[] a)
Returns an array containing all of the elements in this list in proper sequence; the runtime type of the returned array is that of the specified array. Obeys the general contract of the Collection.toArray(Object[]) method.

Specified by:
toArray in interface java.util.Collection
Specified by:
toArray in interface java.util.List
Parameters:
a - 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:
an array containing the elements of this list.
Throws:
java.lang.ArrayStoreException - if the runtime type of the specified array is not a supertype of the runtime type of every element in this list.
java.lang.NullPointerException - if the specified array is null.

add

public boolean add(java.lang.Object o)
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.

Specified by:
add in interface java.util.Collection
Specified by:
add in interface java.util.List
Parameters:
o - element to be appended to this list.
Returns:
true (as per the general contract of the Collection.add method).
Throws:
java.lang.UnsupportedOperationException - if the add method is not supported by this list.
java.lang.ClassCastException - if the class of the specified element prevents it from being added to this list.
java.lang.NullPointerException - if the specified element is null and this list does not support null elements.
java.lang.IllegalArgumentException - if some aspect of this element prevents it from being added to this list.

remove

public boolean remove(java.lang.Object o)
Removes the first occurrence in this list of the specified element (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 (o==null ? get(i)==null : o.equals(get(i))) (if such an element exists).

Specified by:
remove in interface java.util.Collection
Specified by:
remove in interface java.util.List
Parameters:
o - element to be removed from this list, if present.
Returns:
true if this list contained the specified element.
Throws:
java.lang.ClassCastException - if the type of the specified element is incompatible with this list (optional).
java.lang.NullPointerException - if the specified element is null and this list does not support null elements (optional).
java.lang.UnsupportedOperationException - if the remove method is not supported by this list.

containsAll

public boolean containsAll(java.util.Collection c)
Returns true if this list contains all of the elements of the specified collection.

Specified by:
containsAll in interface java.util.Collection
Specified by:
containsAll in interface java.util.List
Parameters:
c - collection to be checked for containment in this list.
Returns:
true if this list contains all of the elements of the specified collection.
Throws:
java.lang.ClassCastException - if the types of one or more elements in the specified collection are incompatible with this list (optional).
java.lang.NullPointerException - if the specified collection contains one or more null elements and this list does not support null elements (optional).
java.lang.NullPointerException - if the specified collection is null.
See Also:
contains(Object)

addAll

public boolean addAll(java.util.Collection c)
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 unspecified 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.)

Specified by:
addAll in interface java.util.Collection
Specified by:
addAll in interface java.util.List
Parameters:
c - collection whose elements are to be added to this list.
Returns:
true if this list changed as a result of the call.
Throws:
java.lang.UnsupportedOperationException - if the addAll method is not supported by this list.
java.lang.ClassCastException - if the class of an element in the specified collection prevents it from being added to this list.
java.lang.NullPointerException - if the specified collection contains one or more null elements and this list does not support null elements, or if the specified collection is null.
java.lang.IllegalArgumentException - if some aspect of an element in the specified collection prevents it from being added to this list.
See Also:
add(Object)

addAll

public boolean addAll(int index,
                      java.util.Collection c)
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 unspecified 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.)

Specified by:
addAll in interface java.util.List
Parameters:
index - index at which to insert first element from the specified collection.
c - elements to be inserted into this list.
Returns:
true if this list changed as a result of the call.
Throws:
java.lang.UnsupportedOperationException - if the addAll method is not supported by this list.
java.lang.ClassCastException - if the class of one of elements of the specified collection prevents it from being added to this list.
java.lang.NullPointerException - if the specified collection contains one or more null elements and this list does not support null elements, or if the specified collection is null.
java.lang.IllegalArgumentException - if some aspect of one of elements of the specified collection prevents it from being added to this list.
java.lang.IndexOutOfBoundsException - if the index is out of range (index < 0 || index > size()).

removeAll

public boolean removeAll(java.util.Collection c)
Removes from this list all the elements that are contained in the specified collection (optional operation).

Specified by:
removeAll in interface java.util.Collection
Specified by:
removeAll in interface java.util.List
Parameters:
c - collection that defines which elements will be removed from this list.
Returns:
true if this list changed as a result of the call.
Throws:
java.lang.UnsupportedOperationException - if the removeAll method is not supported by this list.
java.lang.ClassCastException - if the types of one or more elements in this list are incompatible with the specified collection (optional).
java.lang.NullPointerException - if this list contains one or more null elements and the specified collection does not support null elements (optional).
java.lang.NullPointerException - if the specified collection is null.
See Also:
remove(Object), contains(Object)

retainAll

public boolean retainAll(java.util.Collection c)
Retains 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.

Specified by:
retainAll in interface java.util.Collection
Specified by:
retainAll in interface java.util.List
Parameters:
c - collection that defines which elements this set will retain.
Returns:
true if this list changed as a result of the call.
Throws:
java.lang.UnsupportedOperationException - if the retainAll method is not supported by this list.
java.lang.ClassCastException - if the types of one or more elements in this list are incompatible with the specified collection (optional).
java.lang.NullPointerException - if this list contains one or more null elements and the specified collection does not support null elements (optional).
java.lang.NullPointerException - if the specified collection is null.
See Also:
remove(Object), contains(Object)

clear

public void clear()
Removes all of the elements from this list (optional operation). This list will be empty after this call returns (unless it throws an exception).

Specified by:
clear in interface java.util.Collection
Specified by:
clear in interface java.util.List
Throws:
java.lang.UnsupportedOperationException - if the clear method is not supported by this list.

equals

public boolean equals(java.lang.Object o)
Compares the specified object with this list for equality. Returns true if and only if the specified object is also a list, both lists have the same size, and all corresponding pairs of elements in the two lists are equal. (Two elements e1 and e2 are equal if (e1==null ? e2==null : e1.equals(e2)).) In other words, two lists are defined to be equal if they contain the same elements in the same order. This definition ensures that the equals method works properly across different implementations of the List interface.

Specified by:
equals in interface java.util.Collection
Specified by:
equals in interface java.util.List
Overrides:
equals in class java.lang.Object
Parameters:
o - the object to be compared for equality with this list.
Returns:
true if the specified object is equal to this list.

hashCode

public int hashCode()
Returns the hash code value for this list. The hash code of a list is defined to be the result of the following calculation:
  hashCode = 1;
  Iterator i = list.iterator();
  while (i.hasNext()) {
      Object obj = i.next();
      hashCode = 31*hashCode + (obj==null ? 0 : obj.hashCode());
  }
 
This ensures that list1.equals(list2) implies that list1.hashCode()==list2.hashCode() for any two lists, list1 and list2, as required by the general contract of Object.hashCode.

Specified by:
hashCode in interface java.util.Collection
Specified by:
hashCode in interface java.util.List
Overrides:
hashCode in class java.lang.Object
Returns:
the hash code value for this list.
See Also:
Object.hashCode(), Object.equals(Object), equals(Object)

get

public java.lang.Object get(int index)
Returns the element at the specified position in this list.

Specified by:
get in interface java.util.List
Parameters:
index - index of element to return.
Returns:
the element at the specified position in this list.
Throws:
java.lang.IndexOutOfBoundsException - if the index is out of range (index < 0 || index >= size()).

set

public java.lang.Object set(int index,
                            java.lang.Object element)
Replaces the element at the specified position in this list with the specified element (optional operation).

Specified by:
set in interface java.util.List
Parameters:
index - index of element to replace.
element - element to be stored at the specified position.
Returns:
the element previously at the specified position.
Throws:
java.lang.UnsupportedOperationException - if the set method is not supported by this list.
java.lang.ClassCastException - if the class of the specified element prevents it from being added to this list.
java.lang.NullPointerException - if the specified element is null and this list does not support null elements.
java.lang.IllegalArgumentException - if some aspect of the specified element prevents it from being added to this list.
java.lang.IndexOutOfBoundsException - if the index is out of range (index < 0 || index >= size()).

add

public void add(int index,
                java.lang.Object element)
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).

Specified by:
add in interface java.util.List
Parameters:
index - index at which the specified element is to be inserted.
element - element to be inserted.
Throws:
java.lang.UnsupportedOperationException - if the add method is not supported by this list.
java.lang.ClassCastException - if the class of the specified element prevents it from being added to this list.
java.lang.NullPointerException - if the specified element is null and this list does not support null elements.
java.lang.IllegalArgumentException - if some aspect of the specified element prevents it from being added to this list.
java.lang.IndexOutOfBoundsException - if the index is out of range (index < 0 || index > size()).

remove

public java.lang.Object remove(int index)
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.

Specified by:
remove in interface java.util.List
Parameters:
index - the index of the element to removed.
Returns:
the element previously at the specified position.
Throws:
java.lang.UnsupportedOperationException - if the remove method is not supported by this list.
java.lang.IndexOutOfBoundsException - if the index is out of range (index < 0 || index >= size()).

indexOf

public int indexOf(java.lang.Object o)
Returns the index in this list of the first occurrence of the specified element, or -1 if this list does not contain this element. More formally, returns the lowest index i such that (o==null ? get(i)==null : o.equals(get(i))), or -1 if there is no such index.

Specified by:
indexOf in interface java.util.List
Parameters:
o - element to search for.
Returns:
the index in this list of the first occurrence of the specified element, or -1 if this list does not contain this element.
Throws:
java.lang.ClassCastException - if the type of the specified element is incompatible with this list (optional).
java.lang.NullPointerException - if the specified element is null and this list does not support null elements (optional).

lastIndexOf

public int lastIndexOf(java.lang.Object o)
Returns the index in this list of the last occurrence of the specified element, or -1 if this list does not contain this 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.

Specified by:
lastIndexOf in interface java.util.List
Parameters:
o - element to search for.
Returns:
the index in this list of the last occurrence of the specified element, or -1 if this list does not contain this element.
Throws:
java.lang.ClassCastException - if the type of the specified element is incompatible with this list (optional).
java.lang.NullPointerException - if the specified element is null and this list does not support null elements (optional).

listIterator

public java.util.ListIterator listIterator()
Returns a list iterator of the elements in this list (in proper sequence).

Specified by:
listIterator in interface java.util.List
Returns:
a list iterator of the elements in this list (in proper sequence).

listIterator

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

Specified by:
listIterator in interface java.util.List
Parameters:
index - index of first element to be returned from the list iterator (by a call to the next method).
Returns:
a list iterator of the elements in this list (in proper sequence), starting at the specified position in this list.
Throws:
java.lang.IndexOutOfBoundsException - if the index is out of range (index < 0 || index > size()).

subList

public java.util.List subList(int fromIndex,
                              int toIndex)
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.)

Specified by:
subList in interface java.util.List
Parameters:
fromIndex - low endpoint (inclusive) of the subList.
toIndex - high endpoint (exclusive) of the subList.
Returns:
a view of the specified range within this list.
Throws:
java.lang.IndexOutOfBoundsException - for an illegal endpoint index value (fromIndex < 0 || toIndex > size || fromIndex > toIndex).