de.innovationgate.webgate.api

Class WGStructEntryList

java.lang.Object

java.util.AbstractCollection<E>

java.util.AbstractSet<E>

java.util.HashSet<E>

java.util.LinkedHashSet<WGStructEntry>

de.innovationgate.webgate.api.WGStructEntryList

All Implemented Interfaces:

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

public class WGStructEntryList
extends java.util.LinkedHashSet<WGStructEntry>

A list of struct entries.

See Also:

Serialized Form

Method Summary

Methods

Modifier and Type	Method and Description
java.util.List<WGStructEntry>	asList() Returns a basic List containing the struct entries in their order.
static WGStructEntryList	create() Creates an empty struct entry list
static WGStructEntryList	create(java.util.List<WGStructEntry> list) Create a WGStructEntryList from an ordinary java.util.List filled with WGStructEntry objects
WGStructEntry	getByIndex(int idx) Retrieve a struct entry by it's index.
WGStructEntry	getByPosition(double pos) Retrieves a struct entry by it's position number.
int	getIndexOfEntry(WGStructEntry testEntry) Returns the siblings index of the given entry in the siblings list.

Methods inherited from class java.util.HashSet

add, clear, clone, contains, isEmpty, iterator, remove, size

Methods inherited from class java.util.AbstractSet

equals, hashCode, removeAll

Methods inherited from class java.util.AbstractCollection

addAll, containsAll, retainAll, toArray, toArray, toString

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.Set

add, addAll, clear, contains, containsAll, equals, hashCode, isEmpty, iterator, remove, removeAll, retainAll, size, toArray, toArray

Method Detail

create

public static WGStructEntryList create(java.util.List<WGStructEntry> list)

Create a WGStructEntryList from an ordinary java.util.List filled with WGStructEntry objects

Parameters:

list -

create

public static WGStructEntryList create()

Creates an empty struct entry list

getByPosition

public WGStructEntry getByPosition(double pos)
                            throws WGAPIException

Retrieves a struct entry by it's position number. If there are multiple entries with the same position number, the first in the siblings index is returned.

Parameters:

pos -

Throws:

WGAPIException

getByIndex

public WGStructEntry getByIndex(int idx)
                         throws WGAPIException

Retrieve a struct entry by it's index. The index is the position in the siblings list, that is ordered by the position number.

Parameters:

idx -

Throws:

WGAPIException

getIndexOfEntry

public int getIndexOfEntry(WGStructEntry testEntry)
                    throws WGAPIException

Returns the siblings index of the given entry in the siblings list.

Parameters:

testEntry -

Returns:

The siblings index, -1 if the entry cannot be found in the list.

Throws:

WGAPIException

asList

public java.util.List<WGStructEntry> asList()
                                     throws WGAPIException

Returns a basic List containing the struct entries in their order. The list is unmodifiable.

Throws:

WGAPIException