Package org.odpi.openmetadata.adapters.connectors.surveyaction.surveyfolder

Enum Class FolderMetric

java.lang.Object

java.lang.Enum<FolderMetric>

org.odpi.openmetadata.adapters.connectors.surveyaction.surveyfolder.FolderMetric

All Implemented Interfaces:

Serializable, Comparable<FolderMetric>, Constable

public enum FolderMetric
extends Enum<FolderMetric>

FolderMetric describes the metrics for a directory (folder) that are captured by the Folder Survey Action Service.

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
EXECUTABLE_FILE_COUNT
FILE_COUNT
READABLE_FILE_COUNT
SUB_DIRECTORY_COUNT
WRITEABLE_FILE_COUNT

Field Summary

Fields

Modifier and Type	Field	Description
final String	description
final String	name

Method Summary

Modifier and Type	Method	Description
String	getDescription()	Return the description of the metric.
String	getName()	Return the name of the metric.
String	toString()	Output of this enum class and main value.
static FolderMetric	valueOf(String name)	Returns the enum constant of this class with the specified name.
static FolderMetric[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

FILE_COUNT

public static final FolderMetric FILE_COUNT

SUB_DIRECTORY_COUNT

public static final FolderMetric SUB_DIRECTORY_COUNT

READABLE_FILE_COUNT

public static final FolderMetric READABLE_FILE_COUNT

WRITEABLE_FILE_COUNT

public static final FolderMetric WRITEABLE_FILE_COUNT

EXECUTABLE_FILE_COUNT

public static final FolderMetric EXECUTABLE_FILE_COUNT

Field Details

name

public final String name

description

public final String description

Method Details

values

public static FolderMetric[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

an array containing the constants of this enum class, in the order they are declared

valueOf

public static FolderMetric valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (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 class has no constant with the specified name

NullPointerException - if the argument is null

getName

public String getName()

Return the name of the metric.

Returns:

string name

getDescription

public String getDescription()

Return the description of the metric.

Returns:

text

toString

public String toString()

Output of this enum class and main value.

Overrides:

toString in class Enum<FolderMetric>

Returns:

string showing enum value