com.telestax.javax.sip.header

Class SIPObjectList

java.lang.Object

java.util.AbstractCollection<E>

java.util.AbstractList<E>

java.util.AbstractSequentialList<E>

java.util.LinkedList<GenericObject>

com.telestax.core.GenericObjectList

com.telestax.javax.sip.header.SIPObjectList

All Implemented Interfaces:

Serializable, Cloneable, Iterable<GenericObject>, Collection<GenericObject>, Deque<GenericObject>, List<GenericObject>, Queue<GenericObject>

public class SIPObjectList
extends GenericObjectList

Root class for all the collection objects in this list: a wrapper class on the GenericObjectList class for lists of objects that can appear in SIPObjects. IMPORTANT NOTE: SIPObjectList cannot derive from SIPObject.

Version:

1.2 $Revision: 1.7 $ $Date: 2009-07-17 18:57:38 $

Author:

M. Ranganathan

See Also:

Serialized Form

Field Summary

Fields inherited from class com.telestax.core.GenericObjectList

AND, AT, COLON, COMMA, DOT, DOUBLE_QUOTE, EQUALS, GREATER_THAN, HT, indentation, LESS_THAN, listName, LPAREN, myClass, NEWLINE, PERCENT, POUND, QUESTION, QUOTE, RETURN, RPAREN, SEMICOLON, SLASH, SP, STAR

Fields inherited from class java.util.AbstractList

modCount

Constructor Summary

Constructors

Constructor and Description
SIPObjectList() Construct an empty SIPObjectList.
SIPObjectList(String lname) Construct a SIPObject List given a list name.

Method Summary

Methods

Modifier and Type	Method and Description
void	concatenate(SIPObjectList otherList) Append a given list to the end of this list.
void	concatenate(SIPObjectList otherList, boolean topFlag) Append or prepend a given list to this list.
String	debugDump(int indent) Convert to a string given an indentation(for pretty printing).
GenericObject	first() Get the first object of this list.
void	mergeObjects(GenericObjectList mergeList) Do a merge of the GenericObjects contained in this list with the GenericObjects in the mergeList.
GenericObject	next() Get the next object of this list (assumes that first() has been called prior to calling this method.)

Methods inherited from class com.telestax.core.GenericObjectList

addFirst, clone, concatenate, concatenate, debugDump, encode, equals, getIndentation, hashCode, isCloneable, isMySubclass, match, next, setMyClass, toString

Methods inherited from class java.util.LinkedList

add, add, addAll, addAll, addLast, clear, contains, descendingIterator, element, get, getFirst, getLast, indexOf, lastIndexOf, listIterator, offer, offerFirst, offerLast, peek, peekFirst, peekLast, poll, pollFirst, pollLast, pop, push, remove, remove, remove, removeFirst, removeFirstOccurrence, removeLast, removeLastOccurrence, set, size, toArray, toArray

Methods inherited from class java.util.AbstractSequentialList

iterator

Methods inherited from class java.util.AbstractList

listIterator, removeRange, subList

Methods inherited from class java.util.AbstractCollection

containsAll, isEmpty, removeAll, retainAll

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.List

containsAll, isEmpty, iterator, listIterator, removeAll, retainAll, subList

Methods inherited from interface java.util.Deque

iterator

Constructor Detail

SIPObjectList

public SIPObjectList(String lname)

Construct a SIPObject List given a list name.

Parameters:

lname - String to set

SIPObjectList

public SIPObjectList()

Construct an empty SIPObjectList.

Method Detail

mergeObjects

public void mergeObjects(GenericObjectList mergeList)

Do a merge of the GenericObjects contained in this list with the GenericObjects in the mergeList. Note that this does an inplace modification of the given list. This does an object by object merge of the given objects.

Overrides:

mergeObjects in class GenericObjectList

Parameters:

mergeList - is the list of Generic objects that we want to do an object by object merge with. Note that no new objects are added to this list.

concatenate

public void concatenate(SIPObjectList otherList)

Append a given list to the end of this list.

Parameters:

otherList - SIPObjectList to set

concatenate

public void concatenate(SIPObjectList otherList,
               boolean topFlag)

Append or prepend a given list to this list.

Parameters:

otherList - SIPObjectList to set

topFlag - boolean to set

first

public GenericObject first()

Get the first object of this list.

Overrides:

first in class GenericObjectList

Returns:

GenericObject

next

public GenericObject next()

Get the next object of this list (assumes that first() has been called prior to calling this method.)

Overrides:

next in class GenericObjectList

Returns:

GenericObject

debugDump

public String debugDump(int indent)

Convert to a string given an indentation(for pretty printing). This is useful for debugging the system in lieu of a debugger.

Overrides:

debugDump in class GenericObjectList

Parameters:

indent - int to set

Returns:

an indentation