com.edustructures.sifworks
Class SIFList<T extends SIFElement>

java.lang.Object
  com.edustructures.sifworks.Element
      com.edustructures.sifworks.SIFElement
          com.edustructures.sifworks.SIFList<T>

Type Parameters:

T -

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable, java.lang.Iterable<T>, java.util.Collection<T>

Direct Known Subclasses:

AcademicPerformanceHistory, ActionList, ActivityAwardHistory, AdditionalGraduationRequirementPerformanceHistory, AnnualItems, Approvals, AssessmentPerformanceHistory, BackgroundChecks, BudgetAccounts, Components, Contacts, CourseHistory, ExpenseAccounts, FISAmounts, FTAmounts, ItemQuantities, LessonSource, LessonSources, Letter, MarkingPeriods, MeetingTimeList, PartCTransitionMeetingNotHeldReasons, PartCTransitionMeetingOutcomes, ProgramFundingSources, PurchaseQuantities, RightsElements, SaleQuantities, ScheduleInfoOverrideList, ServiceFundingSources, SIF_OrderBy, SIF_Rows, SIFKeyedList, SpanGaps, StudentProgramAccommodations, TermMarkLists, TransactionList, TransferPoints, TransStudents

public class SIFList<T extends SIFElement>
extends SIFElement
implements java.util.Collection<T>

See Also:

Serialized Form

Field Summary

Fields inherited from class com.edustructures.sifworks.Element

CURRENT_SERIALIZE_VERSION

Constructor Summary

SIFList(ElementDef def)
Creates an instance of a SIFList class

Method Summary

boolean	add(T element) Adds the specified Repeatable child element to this list of elements
boolean	addAll(java.util.Collection<? extends T> elementCollection) Adds all of the elements in the specified collection to this list
void	clear()
boolean	contains(java.lang.Object item)
boolean	containsAll(java.util.Collection<?> elementCollection)
T	get(int arg0)
java.util.Iterator<T>	iterator()
boolean	remove(java.lang.Object child)
boolean	remove(T element) Remobes the specified Repeatable child element from the list of elements
boolean	removeAll(java.util.Collection<?> elementCollection)
boolean	retainAll(java.util.Collection<?> arg0)
int	size()
java.lang.Object[]	toArray()
<V> V[]	toArray(V[] array) Copies the child elements to the specified array

Methods inherited from class com.edustructures.sifworks.SIFElement

addChild, addChild, clone, compareGraphTo, create, effectiveSIFVersion, getChild, getChild, getChild, getChild, getChild, getChildCount, getChildList, getChildList, getChildList, getChildren, getChildren, getContent, getContent, getField, getField, getFieldCount, getFields, getFieldValue, getKey, getSIFValue, getSIFVersion, getTextValue, getXmlId, hasTextValue, removeChild, removeChild, removeChild, removeChild, restoreImplementationDef, setChanged, setChildren, setEmpty, setField, setField, setField, setField, setSIFValue, setSIFVersion, setTextValue, setXmlId, tag

Methods inherited from class com.edustructures.sifworks.Element

compareTo, getElementDef, getParent, getRoot, isChanged, isDoNotEncode, isEmpty, setChanged, setDoNotEncode, setElementDef, setEmpty, setParent, toString

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.Collection

equals, hashCode, isEmpty

Constructor Detail

SIFList

public SIFList(ElementDef def)

Creates an instance of a SIFList class

Parameters:

def -

Method Detail

size

public int size()

Specified by:

size in interface java.util.Collection<T extends SIFElement>

iterator

public java.util.Iterator<T> iterator()

Specified by:

iterator in interface java.lang.Iterable<T extends SIFElement>

Specified by:

iterator in interface java.util.Collection<T extends SIFElement>

toArray

public java.lang.Object[] toArray()

Specified by:

toArray in interface java.util.Collection<T extends SIFElement>

add

public boolean add(T element)

Adds the specified Repeatable child element to this list of elements

Specified by:

add in interface java.util.Collection<T extends SIFElement>

Parameters:

element - The child to add

Returns:

True if the element was added to the list

remove

public boolean remove(T element)

Remobes the specified Repeatable child element from the list of elements

Parameters:

element -

Returns:

True if the child was removed from this List. Otherwise, false

containsAll

public boolean containsAll(java.util.Collection<?> elementCollection)

Specified by:

containsAll in interface java.util.Collection<T extends SIFElement>

addAll

public boolean addAll(java.util.Collection<? extends T> elementCollection)

Adds all of the elements in the specified collection to this list

Specified by:

addAll in interface java.util.Collection<T extends SIFElement>

Parameters:

elementCollection -

Returns:

True if all items were added to this list

removeAll

public boolean removeAll(java.util.Collection<?> elementCollection)

Specified by:

removeAll in interface java.util.Collection<T extends SIFElement>

clear

public void clear()

Specified by:

clear in interface java.util.Collection<T extends SIFElement>

contains

public boolean contains(java.lang.Object item)

Specified by:

contains in interface java.util.Collection<T extends SIFElement>

remove

public boolean remove(java.lang.Object child)

Specified by:

remove in interface java.util.Collection<T extends SIFElement>

toArray

public <V> V[] toArray(V[] array)

Copies the child elements to the specified array

Specified by:

toArray in interface java.util.Collection<T extends SIFElement>

Type Parameters:

V - The generic Type of the array

Parameters:

array - The Array to add the members to

Returns:

The array that the child members were added to

retainAll

public boolean retainAll(java.util.Collection<?> arg0)

Specified by:

retainAll in interface java.util.Collection<T extends SIFElement>

get

public T get(int arg0)