org.opensaml.xml.util

クラス IndexedXMLObjectChildrenList<ElementType extends XMLObject>

java.lang.Object

java.util.AbstractCollection<E>

java.util.AbstractList<ElementType>

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

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

型パラメータ:

ElementType - the type of element added to the list

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

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

@NotThreadSafe
public class IndexedXMLObjectChildrenList<ElementType extends XMLObject>
extends XMLObjectChildrenList<ElementType>

A list which indexes XMLObjects by their schema type and element QName for quick retrival based on those items.

フィールドの概要

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

modCount

コンストラクタの概要

コンストラクタ

コンストラクタと説明
IndexedXMLObjectChildrenList(XMLObject parent) Constructor.
IndexedXMLObjectChildrenList(XMLObject parent, Collection<ElementType> col) Constructor.

メソッドの概要

メソッド

修飾子とタイプ	メソッドと説明
void	add(int index, ElementType element) Inserts the specified element at the specified position in this list.
protected void	checkAndCreateIndex(QName index) Check for the existence of an index for the specified QName and create it if it doesn't exist.
void	clear()
List<ElementType>	get(QName typeOrName) Retrieves all the SAMLObjects that have given schema type or element name.
protected void	indexElement(ElementType element) Indexes the given SAMLObject by type and element name.
protected void	indexElement(QName index, ElementType element) Indexes the given SAMLobject by the given index.
boolean	remove(ElementType element) Removes a given element from the list and index.
ElementType	remove(int index) Removes the element at the specified position in this list.
protected void	removeElementFromIndex(ElementType element) Removes the given element from the schema type and element qname index.
protected void	removeElementFromIndex(QName index, ElementType element) Removes an object from the given index id.
ElementType	set(int index, ElementType element) Replaces the element at the specified position in this list with the specified element.
List<? extends ElementType>	subList(QName index) Returns a view of the list that only contains elements stored under the given index.

クラスから継承されたメソッド org.opensaml.xml.util.XMLObjectChildrenList

contains, get, setParent, size

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

add, addAll, 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

コンストラクタの詳細

IndexedXMLObjectChildrenList

public IndexedXMLObjectChildrenList(XMLObject parent)

Constructor.

パラメータ:

parent - the parent of the XMLObjects added to the list

IndexedXMLObjectChildrenList

public IndexedXMLObjectChildrenList(XMLObject parent,
                            Collection<ElementType> col)

Constructor.

パラメータ:

parent - the parent of all elements

col - collection to add to this list

メソッドの詳細

add

public void add(int index,
       ElementType element)

Inserts the specified element at the specified position in this list. Shifts the element currently at that position (if any) and any subsequent elements to the right (adds one to their indices).

定義:

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

オーバーライド:

add クラス内 XMLObjectChildrenList<ElementType extends XMLObject>

パラメータ:

index - index of element to add

element - element to be stored at the specified position

clear

public void clear()

定義:

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

定義:

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

オーバーライド:

clear クラス内 AbstractList<ElementType extends XMLObject>

get

public List<ElementType> get(QName typeOrName)

Retrieves all the SAMLObjects that have given schema type or element name.

パラメータ:

typeOrName - the schema type or element name

戻り値:

list of SAMLObjects that have given schema type or element name, which may be empty. Will not be null.

checkAndCreateIndex

protected void checkAndCreateIndex(QName index)

Check for the existence of an index for the specified QName and create it if it doesn't exist.

パラメータ:

index - the index to check

indexElement

protected void indexElement(ElementType element)

Indexes the given SAMLObject by type and element name.

パラメータ:

element - the SAMLObject to index

indexElement

protected void indexElement(QName index,
                ElementType element)

Indexes the given SAMLobject by the given index.

パラメータ:

index - the index for the element

element - the element to be indexed

remove

public boolean remove(ElementType element)

Removes a given element from the list and index.

オーバーライド:

remove クラス内 XMLObjectChildrenList<ElementType extends XMLObject>

パラメータ:

element - the element to be removed

戻り値:

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

remove

public ElementType remove(int index)

Removes the element at the specified position in this list. Shifts any subsequent elements to the left (subtracts one from their indices). Returns the element that was removed from the list

定義:

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

オーバーライド:

remove クラス内 XMLObjectChildrenList<ElementType extends XMLObject>

パラメータ:

index - the index of the element to remove

戻り値:

the element removed from the list

removeElementFromIndex

protected void removeElementFromIndex(ElementType element)

Removes the given element from the schema type and element qname index.

パラメータ:

element - the element to remove from the index

removeElementFromIndex

protected void removeElementFromIndex(QName index,
                          ElementType element)

Removes an object from the given index id.

パラメータ:

index - the id of the index

element - the element to be removed from that index

set

public ElementType set(int index,
              ElementType element)

Replaces the element at the specified position in this list with the specified element.

定義:

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

オーバーライド:

set クラス内 XMLObjectChildrenList<ElementType extends XMLObject>

パラメータ:

index - index of element to replace

element - element to be stored at the specified position

戻り値:

the element previously at the specified position

subList

public List<? extends ElementType> subList(QName index)

Returns a view of the list that only contains elements stored under the given index. The returned list is backed by this list so and supports all optional operations, so changes made to the returned list are reflected in this list.

パラメータ:

index - index of the elements returned in the list view

戻り値:

a view of this list that contains only the elements stored under the given index