Package com.opensymphony.module.sitemesh.mapper

Class DefaultDecorator

  • All Implemented Interfaces:
    Decorator
    public class DefaultDecorator
extends java.lang.Object
implements Decorator
    Default implementation of Decorator. All properties are set by the constructor.
    Version:
    $Revision: 1.1 $
    Author:
    Joe Walnes
    See Also:
    Decorator

    • Field Summary

      Fields 
      Modifier and Type Field Description
      protected java.lang.String name  
      protected java.lang.String page  
      protected java.util.Map parameters  
      protected java.lang.String role  
      protected java.lang.String uriPath  

    • Constructor Summary

      Constructors 
      Constructor Description
      DefaultDecorator​(java.lang.String name, java.lang.String page, java.lang.String uriPath, java.lang.String role, java.util.Map parameters)
      Constructor to set all properties.
      DefaultDecorator​(java.lang.String name, java.lang.String page, java.lang.String uriPath, java.util.Map parameters)
      Constructor to set all properties.
      DefaultDecorator​(java.lang.String name, java.lang.String page, java.util.Map parameters)
      Constructor to set name, page and parameters.

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      java.lang.String getInitParameter​(java.lang.String paramName)
      Returns a String containing the value of the named initialization parameter, or null if the parameter does not exist.
      java.util.Iterator getInitParameterNames()
      Returns the names of the Decorator's initialization parameters as an Iterator of String objects, or an empty Iterator if the Decorator has no initialization parameters.
      java.lang.String getName()
      Name of Decorator.
      java.lang.String getPage()
      URI of the Servlet/JSP to dispatch the request to (relative to the web-app context).
      java.lang.String getRole()
      Role the user has to be in to get this decorator applied.
      java.lang.String getURIPath()
      URI path of the Decorator.

      • Methods inherited from class java.lang.Object

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

    • Constructor Detail

      • DefaultDecorator

        public DefaultDecorator​(java.lang.String name,
                        java.lang.String page,
                        java.util.Map parameters)
        Constructor to set name, page and parameters.

      • DefaultDecorator

        public DefaultDecorator​(java.lang.String name,
                        java.lang.String page,
                        java.lang.String uriPath,
                        java.util.Map parameters)
        Constructor to set all properties.

      • DefaultDecorator

        public DefaultDecorator​(java.lang.String name,
                        java.lang.String page,
                        java.lang.String uriPath,
                        java.lang.String role,
                        java.util.Map parameters)
        Constructor to set all properties.

    • Method Detail

      • getPage

        public java.lang.String getPage()
        URI of the Servlet/JSP to dispatch the request to (relative to the web-app context).
        Specified by:
        getPage in interface Decorator

      • getName

        public java.lang.String getName()
        Name of Decorator. For information purposes only.
        Specified by:
        getName in interface Decorator

      • getURIPath

        public java.lang.String getURIPath()
        URI path of the Decorator. Enables support for decorators defined in seperate web-apps.
        Specified by:
        getURIPath in interface Decorator

      • getRole

        public java.lang.String getRole()
        Role the user has to be in to get this decorator applied.
        Specified by:
        getRole in interface Decorator

      • getInitParameter

        public java.lang.String getInitParameter​(java.lang.String paramName)
        Returns a String containing the value of the named initialization parameter, or null if the parameter does not exist.
        Specified by:
        getInitParameter in interface Decorator
        Parameters:
        paramName - Key of parameter.
        Returns:
        Value of parameter or null if not found.

      • getInitParameterNames

        public java.util.Iterator getInitParameterNames()
        Returns the names of the Decorator's initialization parameters as an Iterator of String objects, or an empty Iterator if the Decorator has no initialization parameters.
        Specified by:
        getInitParameterNames in interface Decorator