org.opensaml.xml.util

クラス XMLObjectChildrenList<ElementType extends XMLObject>

java.lang.Object

java.util.AbstractCollection<E>

java.util.AbstractList<ElementType>

org.opensaml.xml.util.XMLObjectChildrenList<ElementType>

型パラメータ:

ElementType - type of elements added to the list

すべての実装されたインタフェース:

Iterable<ElementType>, Collection<ElementType>, List<ElementType>

直系の既知のサブクラス:

IndexedXMLObjectChildrenList

public class XMLObjectChildrenList<ElementType extends XMLObject>
extends AbstractList<ElementType>

Resizable list for the children of XMLObjects. This list implements all optional List operations and does not all for null elements. XMLObjects added to, or removed from, this list will have their parent object appropriately set and, the underlying DOM will be released during mutation opertions.

フィールドの概要

クラスから継承されたフィールド java.util.AbstractList

modCount

コンストラクタの概要

コンストラクタ

コンストラクタと説明
XMLObjectChildrenList(XMLObject newParent) Constructs an empty list with all added XMLObjects being assigned the given parent XMLObject.
XMLObjectChildrenList(XMLObject newParent, Collection<ElementType> newElements) Constructs a list containing the elements in the specified collection, in the order they are returned by the collection's iterator, with each added XMLObject assigned the given parent XMLObject.

メソッドの概要

メソッド

修飾子とタイプ	メソッドと説明
void	add(int index, ElementType element) Adds the given XMLObject to this list.
boolean	contains(ElementType element) Checks to see if the given element is contained in this list.
ElementType	get(int index)
boolean	remove(ElementType element) Removes the element from the list.
ElementType	remove(int index)
ElementType	set(int index, ElementType element) Replaces the XMLObject at the specified index with the given element.
protected void	setParent(ElementType element) Assigned the parent, given at list construction, to the given element if the element does not have a parent or its parent matches the one given at list construction time.
int	size()

クラスから継承されたメソッド java.util.AbstractList

add, addAll, clear, equals, hashCode, indexOf, iterator, lastIndexOf, listIterator, listIterator, removeRange, subList

クラスから継承されたメソッド java.util.AbstractCollection

addAll, contains, containsAll, isEmpty, remove, removeAll, retainAll, toArray, toArray, toString

クラスから継承されたメソッド java.lang.Object

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

インタフェースから継承されたメソッド java.util.List

addAll, contains, containsAll, isEmpty, remove, removeAll, retainAll, toArray, toArray

コンストラクタの詳細

XMLObjectChildrenList

public XMLObjectChildrenList(XMLObject newParent)
                      throws NullPointerException

Constructs an empty list with all added XMLObjects being assigned the given parent XMLObject.

パラメータ:

newParent - the parent for all the added XMLObjects

例外:

NullPointerException - thrown if the parent is null

XMLObjectChildrenList

public XMLObjectChildrenList(XMLObject newParent,
                     Collection<ElementType> newElements)
                      throws NullPointerException

Constructs a list containing the elements in the specified collection, in the order they are returned by the collection's iterator, with each added XMLObject assigned the given parent XMLObject.

パラメータ:

newParent - the parent for all the added XMLObjects

newElements - the elements to be added

例外:

NullPointerException - thrown if the parent is null

IllegalArgumentException - thrown if any of the XMLObjects in the given collection already have a parent that is different from the given parent

メソッドの詳細

size

public int size()

定義:

size インタフェース内 Collection<ElementType extends XMLObject>

定義:

size インタフェース内 List<ElementType extends XMLObject>

定義:

size クラス内 AbstractCollection<ElementType extends XMLObject>

contains

public boolean contains(ElementType element)

Checks to see if the given element is contained in this list.

パラメータ:

element - the element to check for

戻り値:

true if the element is in this list, false if not

get

public ElementType get(int index)

定義:

get インタフェース内 List<ElementType extends XMLObject>

定義:

get クラス内 AbstractList<ElementType extends XMLObject>

set

public ElementType set(int index,
              ElementType element)
                                  throws IllegalArgumentException

Replaces the XMLObject at the specified index with the given element.

定義:

set インタフェース内 List<ElementType extends XMLObject>

オーバーライド:

set クラス内 AbstractList<ElementType extends XMLObject>

パラメータ:

index - index of the XMLObject to be replaced

element - element to be stored at the given index

戻り値:

the replaced XMLObject

例外:

IllegalArgumentException - thrown if the given XMLObject already has a parent that is different from the XMLObject given at list construction time

add

public void add(int index,
       ElementType element)
         throws IllegalArgumentException

Adds the given XMLObject to this list.

定義:

add インタフェース内 List<ElementType extends XMLObject>

オーバーライド:

add クラス内 AbstractList<ElementType extends XMLObject>

パラメータ:

index - index at which to add the given XMLObject

element - element to be stored at the given index

例外:

IllegalArgumentException - thrown if the given XMLObject already has a parent that is different from the XMLObject given at list construction time

remove

public ElementType remove(int index)

定義:

remove インタフェース内 List<ElementType extends XMLObject>

オーバーライド:

remove クラス内 AbstractList<ElementType extends XMLObject>

remove

public boolean remove(ElementType element)

Removes the element from the list.

パラメータ:

element - the element to be removed

戻り値:

true if the element was in the list and removed, false if not

setParent

protected void setParent(ElementType element)
                  throws IllegalArgumentException

Assigned the parent, given at list construction, to the given element if the element does not have a parent or its parent matches the one given at list construction time.

パラメータ:

element - the element to set the parent on

例外:

IllegalArgumentException - thrown if the given element already has a parent and it is different than the parent given at list construction time