Package lumis.portal.deployment

Enum ComponentFolder

  • All Implemented Interfaces:
    java.io.Serializable, java.lang.Comparable<ComponentFolder>
    public enum ComponentFolder
extends java.lang.Enum<ComponentFolder>
    Enumeration of component folders.
    Since:
    7.1.0
    Version:
    $Revision$ $Date$

    • Enum Constant Summary

      Enum Constants 
      Enum Constant Description
      SETUP
      Setup folder.
      STRUCTURE
      Structure folder.
      WWW
      Public files folder.

    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      java.lang.String getRelativePath​(java.lang.String componentId)
      Returns the relative path of the given component identifier.
      java.lang.String getRelativePath​(java.lang.String componentId, java.lang.String desiredRelativePath)
      Returns the relative path of the desired path under the given component identifier.
      java.lang.String getRelativePath​(IComponent component)
      Returns the relative path of the given component.
      java.lang.String getRelativePath​(IComponent component, java.lang.String desiredRelativePath)
      Returns the relative path of the desired path under the given component.
      static ComponentFolder valueOf​(java.lang.String name)
      Returns the enum constant of this type with the specified name.
      static ComponentFolder[] values()
      Returns an array containing the constants of this enum type, in the order they are declared.

      • Methods inherited from class java.lang.Enum

        clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

      • Methods inherited from class java.lang.Object

        getClass, notify, notifyAll, wait, wait, wait

    • Enum Constant Detail

      • STRUCTURE

        public static final ComponentFolder STRUCTURE
        Structure folder.
        Since:
        7.1.0

      • WWW

        public static final ComponentFolder WWW
        Public files folder.
        Since:
        7.1.0

      • SETUP

        public static final ComponentFolder SETUP
        Setup folder.
        Since:
        7.1.0

    • Method Detail

      • values

        public static ComponentFolder[] values()
        Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows: 
        for (ComponentFolder c : ComponentFolder.values())
    System.out.println(c);
        Returns:
        an array containing the constants of this enum type, in the order they are declared

      • valueOf

        public static ComponentFolder valueOf​(java.lang.String name)
        Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)
        Parameters:
        name - the name of the enum constant to be returned.
        Returns:
        the enum constant with the specified name
        Throws:
        java.lang.IllegalArgumentException - if this enum type has no constant with the specified name
        java.lang.NullPointerException - if the argument is null

      • getRelativePath

        public java.lang.String getRelativePath​(IComponent component)
        Returns the relative path of the given component.
        Parameters:
        component - the component.
        Returns:
        the relative path of the given component.
        Since:
        7.1.0

      • getRelativePath

        public java.lang.String getRelativePath​(IComponent component,
                                        java.lang.String desiredRelativePath)
        Returns the relative path of the desired path under the given component.
        Parameters:
        component - the component.
        desiredRelativePath - the desired path.
        Returns:
        the relative path of the desired path under the given component.
        Since:
        7.1.0

      • getRelativePath

        public java.lang.String getRelativePath​(java.lang.String componentId)
        Returns the relative path of the given component identifier.
        Parameters:
        componentId - the component identifier
        Returns:
        the relative path of the given component identifier.
        Since:
        7.1.0

      • getRelativePath

        public java.lang.String getRelativePath​(java.lang.String componentId,
                                        java.lang.String desiredRelativePath)
        Returns the relative path of the desired path under the given component identifier.
        Parameters:
        component - the component identifier.
        desiredRelativePath - the desired path.
        Returns:
        the relative path of the desired path under the given component identifier.
        Since:
        7.1.0