|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | ENUM CONSTANTS | FIELD | METHOD | DETAIL: ENUM CONSTANTS | FIELD | METHOD |
java.lang.Object java.lang.Enum<PortalBaseFolder> lumis.portal.filesystem.PortalBaseFolder
@StableMinor(version="6.2", sinceVersion="4.1") public enum PortalBaseFolder
Specifies a portal standard base folder. Also provides conversions between relative paths and absolute paths for each base folder.
Enum Constant Summary | |
---|---|
DATA
Indicates the path is relative to the portal data (lumisdata/data) folder. |
|
DEF
Indicates the path is relative to the portal definition (lumisdata/def) folder. |
|
WWW
Deprecated. Since 6.2.0, replaced by IWebsite.getWebRootBaseFolder()
due to the inclusion of multiple websites, and consequently, multiple
web roots.
For best compatibility, this enumeration value refers to the default website's web root folder. If there is no default website, it will cause an exception when converting the paths. |
Method Summary | |
---|---|
String |
getAbsolutePath(String relativePath)
Calculates the absolute path from a relative path to this base folder. |
String |
getRelativePath(String absolutePath)
Calculates the relative path to this base folder from the given absolute path. |
static PortalBaseFolder |
valueOf(String name)
Returns the enum constant of this type with the specified name. |
static PortalBaseFolder[] |
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 |
Methods inherited from interface lumis.portal.filesystem.IPortalBaseFolder |
---|
equals, toString |
Enum Constant Detail |
---|
@Deprecated public static final PortalBaseFolder WWW
IWebsite.getWebRootBaseFolder()
due to the inclusion of multiple websites, and consequently, multiple
web roots.
For best compatibility, this enumeration value refers to the default website's web root folder. If there is no default website, it will cause an exception when converting the paths.
public static final PortalBaseFolder DATA
public static final PortalBaseFolder DEF
Method Detail |
---|
public static PortalBaseFolder[] values()
for (PortalBaseFolder c : PortalBaseFolder.values()) System.out.println(c);
public static PortalBaseFolder valueOf(String name)
name
- the name of the enum constant to be returned.
IllegalArgumentException
- if this enum type has no constant
with the specified name
NullPointerException
- if the argument is nullpublic String getAbsolutePath(String relativePath)
getAbsolutePath
in interface IPortalBaseFolder
relativePath
- the relative path.
public String getRelativePath(String absolutePath)
getRelativePath
in interface IPortalBaseFolder
absolutePath
- the absolute path.
IllegalArgumentException
- if the given absolute path is invalid
or does not belongs to this base folder area.
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | ENUM CONSTANTS | FIELD | METHOD | DETAIL: ENUM CONSTANTS | FIELD | METHOD |