com.sapportals.wcm.repository.service.subscription
Interface ISubscriptionList

[contained in: com.sap.km.cm.repository.service.par - km.shared.repository.service.app.subscription_api.jar]

public interface ISubscriptionList

A list of ISubscriptions.
(for a detailed description, see java.util.LinkedList).

A ISubscriptionList provides a simple way of storing and accessing multiple subscriptions.
Typed version of a java.util.LinkedList.

Copyright (c) SAP AG

See Also:

LinkedList, ISubscription, ISubscriptionListIterator

Method Summary

void	add(int index, ISubscription subscription) Adds an item to a given position number in the list.
boolean	add(ISubscription subscription) Adds an ISubscription to the list.
boolean	contains(ISubscription subscription) Checks whether the given ISubscription is part of this list.
ISubscription	get(int index) Gets a named item from the list.
int	indexOf(ISubscription subscription) Gets the position number of a given subscription in the list.
boolean	isEmpty() Checks whether the list is empty.
int	lastIndexOf(ISubscription subscription) Gets the position number of the last occurrence of a given ISubscription.
ISubscriptionListIterator	listIterator() Gets a ISubscriptionListIterator for the list.
ISubscriptionListIterator	listIterator(int index) Gets a ISubscriptionListIterator for the list beginning at a specific position.
ISubscription	remove(int index) Removes a specific item from the list.
boolean	remove(ISubscription subscription) Removes an ISubscription from the list.
ISubscription	set(int index, ISubscription subscription) Sets a item to a given position number in the list.
int	size() Gets the size of the list.
void	sort(java.util.Comparator comparator) Sorts the list with the given comparator.
ISubscriptionList	subList(int startIndex, int stopIndex) Gets the a subList of the list.

Method Detail

isEmpty

public boolean isEmpty()

Checks whether the list is empty.

Returns:

a boolean true if the list is empty

size

public int size()

Gets the size of the list.

Returns:

a int with the size of the list

contains

public boolean contains(ISubscription subscription)

Checks whether the given ISubscription is part of this list.

Parameters:

subscription - an ISubscription to be checked to see whether it is part of the list

Returns:

a boolean true if the given ISubscription is part of the list

add

public boolean add(ISubscription subscription)

Adds an ISubscription to the list.

Parameters:

subscription - an ISubscription to be added to the list

Returns:

a boolean false if the operation fails

remove

public boolean remove(ISubscription subscription)

Removes an ISubscription from the list.

Parameters:

subscription - an ISubscription to be removed from the list

Returns:

a boolean false if the operation fails

get

public ISubscription get(int index)

Gets a named item from the list.

Provides direct access to a list item

Parameters:

index - an int with the position number of the required ISubscription

Returns:

an ISubscription from the list

set

public ISubscription set(int index,
                         ISubscription subscription)

Sets a item to a given position number in the list.

If the position is already taken by another item, the old item is replaced.

Parameters:

index - an int with the position number that indicates where the item should be placed in the list

subscription - an ISubscription to be set for the list

Returns:

an ISubscription to be inserted into the list

add

public void add(int index,
                ISubscription subscription)

Adds an item to a given position number in the list.

Items with higher position numbers move up one position.

Parameters:

index - an int with the position number that indicates where the item should be placed inside the list

subscription - an ISubscription to be added to the list

remove

public ISubscription remove(int index)

Removes a specific item from the list.

Parameters:

index - an int with the items position

Returns:

a ISubscription to be removed from the list

indexOf

public int indexOf(ISubscription subscription)

Gets the position number of a given subscription in the list.

Parameters:

subscription - an ISubscription that can be found in the list

Returns:

an int with the list's position number of the given ISubscription

lastIndexOf

public int lastIndexOf(ISubscription subscription)

Gets the position number of the last occurrence of a given ISubscription.

Parameters:

subscription - an ISubscription that can be found at least once in the list

Returns:

a int with the last list position number of the given ISubscription

listIterator

public ISubscriptionListIterator listIterator()

Gets a ISubscriptionListIterator for the list.

Returns:

an ISubscriptionListIterator

listIterator

public ISubscriptionListIterator listIterator(int index)

Gets a ISubscriptionListIterator for the list beginning at a specific position.

Returns:

an ISubscriptionListIterator

subList

public ISubscriptionList subList(int startIndex,
                                 int stopIndex)

Gets the a subList of the list.

Parameters:

startIndex - an int with the start position of this sublist

stopIndex - an int with the end position of the sublist

Returns:

an ISubscriptionList that represents a sublist of this list

sort

public void sort(java.util.Comparator comparator)

Sorts the list with the given comparator.

Parameters:

comparator - a Comparator for how to sort this list