Package org.apache.maven.doxia.site.skin

Class ResourceCondition

java.lang.Object

org.apache.maven.doxia.site.skin.ResourceCondition

All Implemented Interfaces:

Serializable, Cloneable

public class ResourceCondition
extends Object
implements Serializable, Cloneable

Describes the condition for including a specific Skin resource. If multiple conditions are defined for a single resource only the first matching condition determines the outcome. Resources not matching a condition will always be included.

Version:

$Revision$ $Date$

See Also:

• Serialized Form

Constructor Summary

Constructors

Constructor	Description
ResourceCondition()

Method Summary

Modifier and Type	Method	Description
void	addResourceName(String string)	Method addResourceName.
ResourceCondition	clone()	Method clone.
List<String>	getResourceNames()	Method getResourceNames.
String	getVtlCondition()	Get the Velocity (VTL) expression to be evaluated to decide if the resource should be included.
void	removeResourceName(String string)	Method removeResourceName.
void	setResourceNames(List<String> resourceNames)	Set a resource name to which this condition applies.
void	setVtlCondition(String vtlCondition)	Set the Velocity (VTL) expression to be evaluated to decide if the resource should be included.

Methods inherited from class java.lang.Object

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

Constructor Details

ResourceCondition

public ResourceCondition()

Method Details

addResourceName

public void addResourceName(String string)

Method addResourceName.

Parameters:

string - a string object.

clone

public ResourceCondition clone()

Method clone.

Overrides:

clone in class Object

Returns:

ResourceCondition

getResourceNames

public List<String> getResourceNames()

Method getResourceNames.

Returns:

List

getVtlCondition

public String getVtlCondition()

Get the Velocity (VTL) expression to be evaluated to decide if the resource should be included. Only if the condition evaluates to true, the resource will be included.

Returns:

String

removeResourceName

public void removeResourceName(String string)

Method removeResourceName.

Parameters:

string - a string object.

setResourceNames

public void setResourceNames(List<String> resourceNames)

Set a resource name to which this condition applies. Refers to the relative path within the JAR (i.e. must always use "/" as separator and must not start with a slash). Multiple resource names can be specified sharing the same condition.

Parameters:

resourceNames - a resourceNames object.

setVtlCondition

public void setVtlCondition(String vtlCondition)

Set the Velocity (VTL) expression to be evaluated to decide if the resource should be included. Only if the condition evaluates to true, the resource will be included.

Parameters:

vtlCondition - a vtlCondition object.