NIST-SIP: The Reference Implementation for JAIN-SIP 1.2

gov.nist.javax.sip.header
Class SIPObjectList

java.lang.Object
  extended by java.util.AbstractCollection<E>
      extended by java.util.AbstractList<E>
          extended by java.util.AbstractSequentialList<E>
              extended by java.util.LinkedList<gov.nist.core.GenericObject>
                  extended by gov.nist.core.GenericObjectList
                      extended by gov.nist.javax.sip.header.SIPObjectList
All Implemented Interfaces:
Serializable, Cloneable, Iterable<gov.nist.core.GenericObject>, Collection<gov.nist.core.GenericObject>, Deque<gov.nist.core.GenericObject>, List<gov.nist.core.GenericObject>, Queue<gov.nist.core.GenericObject>

public class SIPObjectList
extends gov.nist.core.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

Constructor Summary
SIPObjectList()
          Construct an empty SIPObjectList.
SIPObjectList(String lname)
          Construct a SIPObject List given a list name.
 
Method Summary
 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).
 gov.nist.core.GenericObject first()
          Get the first object of this list.
 void mergeObjects(gov.nist.core.GenericObjectList mergeList)
          Do a merge of the GenericObjects contained in this list with the GenericObjects in the mergeList.
 gov.nist.core.GenericObject next()
          Get the next object of this list (assumes that first() has been called prior to calling this method.)
 
Methods inherited from class gov.nist.core.GenericObjectList
addFirst, clone, debugDump, encode, equals, isMySubclass, match, setMyClass, setSeparator, 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
hashCode, listIterator, subList
 
Methods inherited from class java.util.AbstractCollection
containsAll, isEmpty, removeAll, retainAll
 
Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait
 
Methods inherited from interface java.util.List
containsAll, hashCode, 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(gov.nist.core.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 gov.nist.core.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 gov.nist.core.GenericObject first()
Get the first object of this list.

Overrides:
first in class gov.nist.core.GenericObjectList
Returns:
GenericObject

next

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

Overrides:
next in class gov.nist.core.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 gov.nist.core.GenericObjectList
Parameters:
indent - int to set
Returns:
an indentation

NIST-SIP: The Reference Implementation for JAIN-SIP 1.2

A product of the NIST/ITL Advanced Networking Technologies Division.
See conditions of use.
Submit a bug report or feature request.