org.milyn.cdr

Class SmooksResourceConfigurationList

java.lang.Object

org.milyn.cdr.SmooksResourceConfigurationList

public class SmooksResourceConfigurationList
extends Object

SmooksResourceConfiguration list.

Author:

tfennelly

Constructor Summary

Constructors

Constructor and Description
SmooksResourceConfigurationList(String name) Public constructor.

Method Summary

Modifier and Type	Method and Description
void	add(ProfileSet profileSet) Add a ProfileSet instance to this list.
void	add(SmooksResourceConfiguration config) Add a SmooksResourceConfiguration instance to this list.
void	addAll(SmooksResourceConfigurationList configList) Add all the SmooksResourceConfiguration instances in the specified SmooksResourceConfigurationList to this list.
protected boolean	addSourceResourceURI(URI resource)
SmooksResourceConfiguration	get(int index) Get the SmooksResourceConfiguration instance at the specified index.
String	getName() Get the name of this list instance.
List<ProfileSet>	getProfiles() Get the list of profiles configured on this resource configuration list.
SmooksResourceConfiguration[]	getTargetConfigurations(ProfileSet profileSet) Get all SmooksResourceConfiguration entries targeted at the specified profile set.
boolean	isEmpty() Is this list instance empty.
boolean	isSystemConfigList() Is this configuration list instance one of the system installed config lists.
List<SmooksResourceConfiguration>	lookupResource(ConfigSearch searchCriteria) Lookup a resource configuration from this config list.
void	setSystemConfigList(boolean systemConfigList) Set whether or not this configuration list instance is one of the system installed config lists.
int	size() Get the size of this list.

Methods inherited from class java.lang.Object

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

Constructor Detail

SmooksResourceConfigurationList

public SmooksResourceConfigurationList(String name)

Public constructor.

Parameters:

name - The name of this instance.

Method Detail

add

public void add(SmooksResourceConfiguration config)

Add a SmooksResourceConfiguration instance to this list.

Parameters:

config - SmooksResourceConfiguration instance to add.

addAll

public void addAll(SmooksResourceConfigurationList configList)

Add all the SmooksResourceConfiguration instances in the specified SmooksResourceConfigurationList to this list.

Parameters:

configList - SmooksResourceConfigurationList instance to add.

add

public void add(ProfileSet profileSet)

Add a ProfileSet instance to this list.

Parameters:

profileSet - ProfileSet instance to add.

getName

public String getName()

Get the name of this list instance.

Returns:

List name.

isSystemConfigList

public boolean isSystemConfigList()

Is this configuration list instance one of the system installed config lists.

Returns:

True if this configuration list instance one of the system installed config lists, otherwise false.

setSystemConfigList

public void setSystemConfigList(boolean systemConfigList)

Set whether or not this configuration list instance is one of the system installed config lists.

Parameters:

systemConfigList - True if this configuration list instance one of the system installed config lists, otherwise false.

isEmpty

public boolean isEmpty()

Is this list instance empty.

Returns:

True if this list instance is empty, otherwise false.

size

public int size()

Get the size of this list.

Returns:

The size of te list i.e. number of entries.

get

public SmooksResourceConfiguration get(int index)
                                throws ArrayIndexOutOfBoundsException

Get the SmooksResourceConfiguration instance at the specified index.

Parameters:

index - Resource index.

Returns:

The SmooksResourceConfiguration instance at the specified index.

Throws:

ArrayIndexOutOfBoundsException - The specified index is out of bounds.

getTargetConfigurations

public SmooksResourceConfiguration[] getTargetConfigurations(ProfileSet profileSet)

Get all SmooksResourceConfiguration entries targeted at the specified profile set.

Parameters:

profileSet - The profile set to searh against.

Returns:

All SmooksResourceConfiguration entries targeted at the specified profile set.

getProfiles

public List<ProfileSet> getProfiles()

Get the list of profiles configured on this resource configuration list.

Returns:

List of profiles.

addSourceResourceURI

protected boolean addSourceResourceURI(URI resource)

lookupResource

public List<SmooksResourceConfiguration> lookupResource(ConfigSearch searchCriteria)

Lookup a resource configuration from this config list.

Note that this is resource config order-dependent. It will not locate configs that have not yet been loaded.

Parameters:

searchCriteria - The resource lookup criteria.

Returns:

List of matches resources, or an empty List if no matches are found.