lumis.portal.deployment

Enum ComponentFolder

java.lang.Object

java.lang.Enum<ComponentFolder>

lumis.portal.deployment.ComponentFolder

All Implemented Interfaces:

Serializable, Comparable<ComponentFolder>

public enum ComponentFolder
extends Enum<ComponentFolder>

Enumeration of component folders.

Since:

7.1.0

Version:

$Revision: 16037 $ $Date: 2013-11-21 22:58:50 +0000 (Thu, 21 Nov 2013) $

Enum Constant Summary

Enum Constants

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

Method Summary

Modifier and Type	Method and Description
String	getRelativePath(IComponent component) Returns the relative path of the given component.
String	getRelativePath(IComponent component, String desiredRelativePath) Returns the relative path of the desired path under the given component.
String	getRelativePath(String componentId) Returns the relative path of the given component identifier.
String	getRelativePath(String componentId, String desiredRelativePath) Returns the relative path of the desired path under the given component identifier.
static ComponentFolder	valueOf(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(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:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null

getRelativePath

public 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 String getRelativePath(IComponent component,
                              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 String getRelativePath(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 String getRelativePath(String componentId,
                              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