org.xbrlapi
Interface FragmentList<F extends Fragment>

All Superinterfaces:

Collection<F>, Iterable<F>, List<F>

All Known Implementing Classes:

FragmentListImpl

public interface FragmentList<F extends Fragment>
extends List<F>

Method Summary

void	addAll(FragmentList<F> list) Appends a list of fragments to this fragment list.
void	addFragment(F fragment) Adds a specified fragment to the end of the list of fragments.
F	getFragment(int index) Returns the indexth fragment in the collection.
int	getLength() The number of fragments in the list.
void	removeFragment(F fragment) Removes a specified fragment from the list

Methods inherited from interface java.util.List

add, add, addAll, addAll, clear, contains, containsAll, equals, get, hashCode, indexOf, isEmpty, iterator, lastIndexOf, listIterator, listIterator, remove, remove, removeAll, retainAll, set, size, subList, toArray, toArray

Method Detail

getLength

int getLength()
              throws XBRLException

The number of fragments in the list. The range of valid child fragment indices is 0 to length-1 inclusive.

Returns:

The number of fragments in the list.

Throws:

AnnotationException

XBRLException

getFragment

F getFragment(int index)
                               throws XBRLException

Returns the indexth fragment in the collection. If index is greater than or equal to the number of fragments in the list, this returns null.

Parameters:

index - The index of the required fragment

Returns:

The fragment at the indexth position in the FragmentList, or null if that is not a valid index.

Throws:

XBRLException

removeFragment

void removeFragment(F fragment)
                    throws XBRLException

Removes a specified fragment from the list

Parameters:

fragment - The fragment to be removed

Throws:

XBRLException

addFragment

void addFragment(F fragment)
                 throws XBRLException

Adds a specified fragment to the end of the list of fragments.

Throws:

XBRLException - if the fragment cannot be added to the list of fragments or if the fragment is null.

addAll

void addAll(FragmentList<F> list)
            throws XBRLException

Appends a list of fragments to this fragment list.

Parameters:

list - The list of fragments to append to this fragment list.

Throws:

XBRLException