com.sapportals.wcm.rendering.collection

Class LazyResourceList

java.lang.Object

com.sapportals.wcm.rendering.collection.LazyResourceList

All Implemented Interfaces:

IResourceList

public final class LazyResourceList
extends Object
implements IResourceList

Constructor Summary

Constructors

Constructor and Description
LazyResourceList(RidList list, IResourceContext context)

Method Summary

Modifier and Type	Method and Description
void	add(int index, IResource resource) Inserts the specified resource at the specified position in this list.
boolean	add(IResource resource) Add the resource to the list.
boolean	addAll(IResourceList list) Add all the elements in the specified list to this list.
boolean	containsResource(IResource resource) Returns true if the specified resource is a member of the list.
IResourceList	difference(IResourceList list) Get the difference of this list to the given list.
IResource	get(int index) Returns the resource at the specified position.
int	indexOf(IResource resource) Returns the index in this list of the first occurrence of the specified resource, or -1 if the List does not contain this resource.
IResourceList	intersection(IResourceList list) Get the intersection of this list and the given list.
int	lastIndexOf(IResource resource) Returns the index in this list of the last occurrence of the specified resource, or -1 if the List does not contain this resource.
IResourceListIterator	listIterator() Returns a resource-list-iterator of the elements in this list.
IResourceListIterator	listIterator(int index) Returns a list-iterator of the elements in this list, starting at the specified position in the list.
IResource	remove(int index) Removes the resource at the specified position in this list.
boolean	remove(IResource resource) Removes the first occurence of the specified resource from the list.
IResource	set(int index, IResource resource) Replaces the element at the specified position in this list with the specified resource.
int	size() Returns the size of the list.
void	sort(Comparator comp) Sort the elements in the list using the specified comparator
IResourceList	subList(int index1, int index2)
IResourceList	union(IResourceList list) Get the union of this list and the given list.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

LazyResourceList

public LazyResourceList(RidList list,
                        IResourceContext context)

Method Detail

add

public boolean add(IResource resource)

Description copied from interface: IResourceList

Add the resource to the list.

Specified by:

add in interface IResourceList

Parameters:

resource - The resource to add to the list.

Returns:

TBD: Description of the outgoing return value

add

public void add(int index,
                IResource resource)

Description copied from interface: IResourceList

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

Specified by:

add in interface IResourceList

Parameters:

index - at which the specified resource is to be inserted.

resource - element to be inserted.

addAll

public boolean addAll(IResourceList list)

Description copied from interface: IResourceList

Add all the elements in the specified list to this list.

Specified by:

addAll in interface IResourceList

Parameters:

list - The list whose elements are to be added to this list.

Returns:

TBD: Description of the outgoing return value

containsResource

public boolean containsResource(IResource resource)

Description copied from interface: IResourceList

Returns true if the specified resource is a member of the list.

Specified by:

containsResource in interface IResourceList

Parameters:

resource - TBD: Description of the incoming method parameter

Returns:

true if the specified resource is a member of the list.

difference

public IResourceList difference(IResourceList list)

Description copied from interface: IResourceList

Get the difference of this list to the given list.
Given a , b and c in this list; b , c and d in the given list, the result will contain only a .

Specified by:

difference in interface IResourceList

Parameters:

list - the IResourceList to subtract from this list.

Returns:

the IResourceList with the difference list.

get

public IResource get(int index)

Description copied from interface: IResourceList

Returns the resource at the specified position.

Specified by:

get in interface IResourceList

Parameters:

index - of the resource to return.

Returns:

the resource that is located at this position in the list. If the resource cannot be instantiated at the time of method invocation, the method will return null. This state is cached within this instance so subsequent calls to this method will return null as well, regardless if the resource would be instantiable or not.

indexOf

public int indexOf(IResource resource)

Description copied from interface: IResourceList

Returns the index in this list of the first occurrence of the specified resource, or -1 if the List does not contain this resource.

Specified by:

indexOf in interface IResourceList

Parameters:

resource - resource to search for.

Returns:

the index in this list of the first occurrence of the specified resource, or -1 if the List does not contain this resource.

intersection

public IResourceList intersection(IResourceList list)

Description copied from interface: IResourceList

Get the intersection of this list and the given list.
Given a , b and c in this list; b , c and d in the given list, the result will contain b and c .

Specified by:

intersection in interface IResourceList

Parameters:

list - the IResourceList to intersect with this list.

Returns:

the IResourceList with the intersection list.

lastIndexOf

public int lastIndexOf(IResource resource)

Description copied from interface: IResourceList

Returns the index in this list of the last occurrence of the specified resource, or -1 if the List does not contain this resource.

Specified by:

lastIndexOf in interface IResourceList

Parameters:

resource - resource to search for.

Returns:

the index in this list of the last occurrence of the specified resource, or -1 if the List does not contain this resource.

listIterator

public IResourceListIterator listIterator()

Description copied from interface: IResourceList

Returns a resource-list-iterator of the elements in this list.

Specified by:

listIterator in interface IResourceList

Returns:

a resource-list-iterator of the elements in this list.

listIterator

public IResourceListIterator listIterator(int index)

Description copied from interface: IResourceList

Returns a list-iterator of the elements in this list, starting at the specified position in the list.

Specified by:

listIterator in interface IResourceList

Parameters:

index - index of first element to be returned from the list-iterator (by a call to next).

Returns:

a resource-list-iterator of the elements in this list.

remove

public boolean remove(IResource resource)

Description copied from interface: IResourceList

Removes the first occurence of the specified resource from the list.

Specified by:

remove in interface IResourceList

Parameters:

resource - TBD: Description of the incoming method parameter

Returns:

Returns true is this list contained the specified resource.

remove

public IResource remove(int index)

Description copied from interface: IResourceList

Removes the resource at the specified position in this list. Shifts any subsequent resources to the left (subtracts one from their indices).

Specified by:

remove in interface IResourceList

Parameters:

index - the index of the resource to removed.

Returns:

the element previously at the specified position.

set

public IResource set(int index,
                     IResource resource)

Description copied from interface: IResourceList

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

Specified by:

set in interface IResourceList

Parameters:

index - index of resource to replace.

resource - resource to be stored at the specified position.

Returns:

the element previously at the specified position.

size

public int size()

Description copied from interface: IResourceList

Returns the size of the list.

Specified by:

size in interface IResourceList

Returns:

the size of the list.

sort

public void sort(Comparator comp)

Description copied from interface: IResourceList

Sort the elements in the list using the specified comparator

Specified by:

sort in interface IResourceList

Parameters:

comp - The comparator used for sorting

See Also:

Comparator

subList

public IResourceList subList(int index1,
                             int index2)

Specified by:

subList in interface IResourceList

Parameters:

index1 - TBD: Description of the incoming method parameter

index2 - TBD: Description of the incoming method parameter

Returns:

a list that contains all resoources in the given order of the current list that are located between the two indexes. Depending if a resource can be instantiated at the moment of method invocation, this resource might not be contained in the returned list.

See Also:

AbstractList.subList(int, int)

union

public IResourceList union(IResourceList list)

Description copied from interface: IResourceList

Get the union of this list and the given list.
Given a , b and c in this list; b , c and d in the given list, the result will contain a , b , c and d .

Specified by:

union in interface IResourceList

Parameters:

list - the IResourceList to union with this list.

Returns:

the IResourceList with the union list.