FileBasePath (Silverpeas Core 6.3 API)

java.lang.Object
- java.lang.Enum<FileBasePath>
- - org.silverpeas.core.process.io.file.FileBasePath

All Implemented Interfaces:

Serializable, Comparable<FileBasePath>
```
public enum FileBasePath
extends Enum<FileBasePath>
```
This enumeration represents all root pathes that are handled by Silverpeas. For each definition is associated a real path on the file system and its assiocated node path. The node path is used by FileHandler in case it has to be managed by this one.

Author:

Yohann Chastagnier

Enum Constant Summary

Enum Constants
Enum Constant Description

UPLOAD_PATH

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`String`	`getHandledNodeName()`
`String`	`getPath()`
`static FileBasePath`	`valueOf(String name)`	Returns the enum constant of this type with the specified name.
`static FileBasePath[]`	`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
  - UPLOAD_PATH
```
public static final FileBasePath UPLOAD_PATH
```
- Method Detail
  - values
```
public static FileBasePath[] 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 (FileBasePath c : FileBasePath.values()) System.out.println(c);
    Returns:
    
    an array containing the constants of this enum type, in the order they are declared
  - valueOf
```
public static FileBasePath 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
  - getPath
```
public String getPath()
```
    Returns:
    
    the path
  - getHandledNodeName
```
public String getHandledNodeName()
```
    Returns:
    
    the handledNodeName