com.filenet.api.constants
Class DirectoryStructure

java.lang.Object
  extended by com.filenet.api.constants.DirectoryStructure
All Implemented Interfaces:
java.io.Serializable

public final class DirectoryStructure
extends java.lang.Object
implements java.io.Serializable

Provides a set of constants that identify the type of directory structure (large or small) used by a file storage area or content cache area.

See Also:
Serialized Form

Field Summary
static DirectoryStructure DIRECTORY_STRUCTURE_LARGE
          Specifies a large directory structure.
static int DIRECTORY_STRUCTURE_LARGE_AS_INT
          An int value associated with the DIRECTORY_STRUCTURE_LARGE instance of this class.
static DirectoryStructure DIRECTORY_STRUCTURE_SMALL
          Specifies a small directory structure.
static int DIRECTORY_STRUCTURE_SMALL_AS_INT
          An int value associated with the DIRECTORY_STRUCTURE_SMALL instance of this class.
 
Method Summary
static DirectoryStructure getInstanceFromInt(int value)
          Returns an instance of this class using its associated integer value.
 int getValue()
          Returns the internal integer value associated with a specific instance of this class.
 java.lang.String toString()
          Returns a String representation of this enumeration instance.
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

DIRECTORY_STRUCTURE_SMALL_AS_INT

public static final int DIRECTORY_STRUCTURE_SMALL_AS_INT
An int value associated with the DIRECTORY_STRUCTURE_SMALL instance of this class. Consider using the static instances of this class instead of the associated int values. The int values risk binary incompatibility (but not source incompatibility) from release to release.

See Also:
Constant Field Values

DIRECTORY_STRUCTURE_SMALL

public static final DirectoryStructure DIRECTORY_STRUCTURE_SMALL
Specifies a small directory structure. Small structures consist of two levels of directories with 23 nodes at each level (total of 529 directories at the 2nd level). Content is stored only at the 2nd level.


DIRECTORY_STRUCTURE_LARGE_AS_INT

public static final int DIRECTORY_STRUCTURE_LARGE_AS_INT
An int value associated with the DIRECTORY_STRUCTURE_LARGE instance of this class. Consider using the static instances of this class instead of the associated int values. The int values risk binary incompatibility (but not source incompatibility) from release to release.

See Also:
Constant Field Values

DIRECTORY_STRUCTURE_LARGE

public static final DirectoryStructure DIRECTORY_STRUCTURE_LARGE
Specifies a large directory structure. Large structures extend the small structure with a third level of 23 nodes, for a total of 12,167 directories at the 3rd level. Content is stored only at the 3rd level.

Method Detail

getValue

public int getValue()
Returns the internal integer value associated with a specific instance of this class.

Returns:
The enumeration instance's ordinal value.
See Also:
getInstanceFromInt(int)

toString

public java.lang.String toString()
Returns a String representation of this enumeration instance.

Overrides:
toString in class java.lang.Object
Returns:
The enumeration instance's description.

getInstanceFromInt

public static DirectoryStructure getInstanceFromInt(int value)
Returns an instance of this class using its associated integer value.

Parameters:
value - The integer value. (See the *_AS_INT fields.)
Returns:
The enumeration instance with the given ordinal value.
Throws:
EngineRuntimeException - If an enumeration instance with the given ordinal value does not exist.
See Also:
getValue()


© Copyright IBM Corporation 2006, 2009. All rights reserved.