com.sapportals.wcm.service.template

Interface IProfileList

public interface IProfileList

A typed list of ITemplate instances.

Copyright 2004 SAP AG

Method Summary

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

Method Detail

size

public int size()

Returns the size of the list.

Returns:

the size of the list.

containsProfile

public boolean containsProfile(IProfile profile)

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

Returns:

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

add

public boolean add(IProfile profile)

Add the resource to the list.

Returns:

TBD: Description of the outgoing return value

addAll

public boolean addAll(IProfileList list)

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

Parameters:

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

Returns:

TBD: Description of the outgoing return value

remove

public boolean remove(IProfile profile)

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

Returns:

Returns true is this list contained the specified resource.

get

public IProfile get(int index)

Returns the Profile at the specified position.

Parameters:

index - of the Profile to return.

Returns:

the Profile at the specified position.

set

public IProfile set(int index,
                    IProfile profile)

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

Parameters:

index - index of Profile to replace.

Returns:

the element previously at the specified position.

add

public void add(int index,
                IProfile profile)

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

Parameters:

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

remove

public IProfile remove(int index)

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

Parameters:

index - the index of the Profile to removed.

Returns:

the element previously at the specified position.

indexOf

public int indexOf(IProfile profile)

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

Returns:

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

lastIndexOf

public int lastIndexOf(IProfile profile)

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

Returns:

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

listIterator

public IProfileListIterator listIterator()

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

Returns:

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

listIterator

public IProfileListIterator listIterator(int index)

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

Parameters:

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

Returns:

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

subList

public IProfileList subList(int index1,
                            int index2)

Parameters:

index1 - TBD: Description of the incoming method parameter

index2 - TBD: Description of the incoming method parameter

Returns:

TBD: Description of the outgoing return value

See Also:

AbstractList.subList(int, int)

sort

public void sort(Comparator comp)

Sort the elements in the list using the specified comparator

Parameters:

comp - The comparator used for sorting

See Also:

Comparator

union

public IProfileList union(IProfileList list)

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 .

Parameters:

list - the IProfileList to union with this list.

Returns:

the IProfileList with the union list.

intersection

public IProfileList intersection(IProfileList list)

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 .

Parameters:

list - the IProfileList to intersect with this list.

Returns:

the IProfileList with the intersection list.

difference

public IProfileList difference(IProfileList list)

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 .

Parameters:

list - the IProfileList to subtract from this list.

Returns:

the IProfileList with the difference list.