com.day.cq.contentbus

Interface ContainerList

All Superinterfaces:

ContentElement

public interface ContainerList
extends ContentElement

The ContainerList class represents an ordered map of Containers. It extends the ContentElement by methods that allow access and modification of the list.

Since:

antbear

Method Summary

Methods

Modifier and Type	Method and Description
ContainerIterator	containerIterator() Returns a ContainerIterator over all containers.
Container	createContainer() Creates a new container at the end of the list.
Container	createContainer(java.lang.String label, java.lang.String above) Creates a new Container and places is above the one specified with the above argument.
Container	createContainer(java.lang.String labelhint, java.lang.String above, boolean exact) Creates a new Container and places is above the one specified with the above argument.
Container	getContainer(int index) Returns the Container of this list which has the speficied index.
Container	getContainer(java.lang.String label) Returns the Container with the given label.
Container	getContainer(java.lang.String label, boolean create) Returns the Container with the given label.
boolean	hasContainer(java.lang.String label) Determines if this containerlist contains the Container with the specified label.
boolean	isReadOnly() Returns if this container list is defined as read only.
void	moveContainer(java.lang.String label, java.lang.String above) Moves a Container to a new location.
void	removeContainer(java.lang.String label) Removes the Container specified by label from this containerlist.
int	size() Returns the number of containers in the list

Methods inherited from interface com.day.cq.contentbus.ContentElement

accept, clear, copyTo, getDeepElement, getDeepElement, getElement, getLabel, getModificationTime, getQualident, getUUID, hasElement, isEmpty, parent

Method Detail

getContainer

Container getContainer(java.lang.String label)
                       throws ContentBusException

Returns the Container with the given label.

Parameters:

label - the label of the desired container

Returns:

the desired container

Throws:

ContentBusException - if an error occurrs

NoSuchContentElementException - if the container does not exist

getContainer

Container getContainer(int index)
                       throws ContentBusException

Returns the Container of this list which has the speficied index.

Parameters:

index - the index of the container to retrieve

Returns:

the desired container

Throws:

ContentBusException - if an error occurrs

NoSuchContentElementException - if the container does not exist

getContainer

Container getContainer(java.lang.String label,
                     boolean create)
                       throws ContentBusException

Returns the Container with the given label. if the container does not exist and the create parameter is true, a new container is created at the end of the containerlist. Please note, that the page this ContainerList belongs to, must already be in a transaction.

Parameters:

label - The label of the desired container

create - if true, a new container is created, if the specified one does not exist.

Returns:

the desired container or null if its not found

Throws:

ContentBusException - if an error occurres

java.lang.IllegalStateException - if a container should be created, but the page it not in a transaction yet.

hasContainer

boolean hasContainer(java.lang.String label)

Determines if this containerlist contains the Container with the specified label.

Parameters:

label - the label of a container

Returns:

true if the container exists; false otherwise;

createContainer

Container createContainer()
                          throws ContentBusException

Creates a new container at the end of the list. The page that this container list belongs to, must already be in a transaction. If this container list is defined read only, this method has no effect.

Returns:

the newly created container

Throws:

ContentBusException - if an error occurres

java.lang.IllegalStateException - if the page is not in a transaction

createContainer

Container createContainer(java.lang.String label,
                        java.lang.String above)
                          throws ContentBusException

Creates a new Container and places is above the one specified with the above argument. The label argument is taken as the label of the new container. The page that this container list belongs to, must already be in a transaction. If the label contains non valid label characters, a IllegalArgumentException is thrown. If the container with the given label does already exist, this container will be replaced. If this container list is defined read only, this method has no effect.

Parameters:

label - the lable of the new container.

above - the label of the container above which the new contaienr will be inserted. if this parameter is null or if the referenced container does not exist, the new one is added at the end.

Returns:

the newly created container.

Throws:

ContentBusException - if an error occurres.

java.lang.IllegalStateException - if the page is not in a transaction

java.lang.IllegalArgumentException - if the label contains illegal label characters

createContainer

Container createContainer(java.lang.String labelhint,
                        java.lang.String above,
                        boolean exact)
                          throws ContentBusException

Creates a new Container and places is above the one specified with the above argument. The labelhint argument is taken as hint for the label of the new container. The page that this container list belongs to, must already be in a transaction. If this container list is defined read only, this method has no effect.

Parameters:

labelhint - a hint for the label

above - the label of the container above which the new contaienr will be inserted. if this parameter is null or if the referenced container does not exist, the new one is added at the end.

exact - if true, the labelhint is taken as exact string. if it contains any illegal label chars, this method will throw an IllegalArgumentException.

Returns:

the newly created container.

Throws:

ContentBusException - if an error occurres.

java.lang.IllegalStateException - if the page is not in a transaction

java.lang.IllegalArgumentException - if the labelhint contains illegal characters.

moveContainer

void moveContainer(java.lang.String label,
                 java.lang.String above)
                   throws ContentBusException

Moves a Container to a new location. The page that this container list belongs to, must already be in a transaction. If this container list is defined read only, this method has no effect.

Parameters:

label - label of container to move

above - label of container to place above. if this parameter is null or an empty string, the container is moved at the end of the list

Throws:

ContentBusException - if an error occurrs

NoSuchContentElementException - if either the source or above container does not exist.

java.lang.IllegalStateException - if the page is not in a transaction

removeContainer

void removeContainer(java.lang.String label)
                     throws ContentBusException

Removes the Container specified by label from this containerlist. The page that this container list belongs to, must already be in a transaction. If this container list is defined read only, this method has no effect.

Parameters:

label - the label of the container to remove

Throws:

ContentBusException - if an error occurrs

NoSuchContentElementException - if the container does not exist.

java.lang.IllegalStateException - if the page is not in a transaction

containerIterator

ContainerIterator containerIterator()
                                    throws ContentBusException

Returns a ContainerIterator over all containers.

Returns:

a ContainerIterator.

Throws:

ContentBusException

size

int size()
         throws ContentBusException

Returns the number of containers in the list

Returns:

the number of containers in the list

Throws:

ContentBusException

isReadOnly

boolean isReadOnly()

Returns if this container list is defined as read only.

Returns:

true if this container list is defined as read only; false otherwise.