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

Class ResourceCondition

  • All Implemented Interfaces:
    java.io.Serializable, java.lang.Cloneable
    public class ResourceCondition
extends java.lang.Object
implements java.io.Serializable, java.lang.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

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      void addResourceName​(java.lang.String string)
      Method addResourceName.
      ResourceCondition clone()
      Method clone.
      java.util.List<java.lang.String> getResourceNames()
      Method getResourceNames.
      java.lang.String getVtlCondition()
      Get the Velocity (VTL) expression to be evaluated to decide if the resource should be included.
      void removeResourceName​(java.lang.String string)
      Method removeResourceName.
      void setResourceNames​(java.util.List<java.lang.String> resourceNames)
      Set a resource name to which this condition applies.
      void setVtlCondition​(java.lang.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 Detail

      • ResourceCondition

        public ResourceCondition()

    • Method Detail

      • addResourceName

        public void addResourceName​(java.lang.String string)
        Method addResourceName.
        Parameters:
        string - a string object.

      • clone

        public ResourceCondition clone()
        Method clone.
        Overrides:
        clone in class java.lang.Object
        Returns:
        ResourceCondition

      • getResourceNames

        public java.util.List<java.lang.String> getResourceNames()
        Method getResourceNames.
        Returns:
        List

      • getVtlCondition

        public java.lang.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​(java.lang.String string)
        Method removeResourceName.
        Parameters:
        string - a string object.

      • setResourceNames

        public void setResourceNames​(java.util.List<java.lang.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​(java.lang.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.