Package org.odpi.openmetadata.frameworks.openmetadata.refdata

Enum Class FileName

java.lang.Object

java.lang.Enum<FileName>

org.odpi.openmetadata.frameworks.openmetadata.refdata.FileName

All Implemented Interfaces:

Serializable, Comparable<FileName>, Constable

public enum FileName
extends Enum<FileName>

FileName describes the standard file names recognized by Egeria. These are encoded in the OpenConnectorsArchive.omarchive and are available in the open metadata repository as valid values.

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
APACHE_MAVEN_BUILD_FILE	A XML file containing instructions for building a module using Apache Maven.
APPLICATION_PROPERTIES_FILE	A properties file used to configure a Spring application during startup.
CODEOWNERS_FILE	A file listing the people responsible for maintaining the content of a git repository.
DOCKER_CONTAINER_BUILD_SCRIPT	A file containing instructions to build a Docker container.
GIT_IGNORE_FILE	A file containing details of the files to exclude from checking to the git tools.
GRADLE_BUILD_FILE	A file containing instructions for building a module using gradle.
GRADLE_PROPERTIES_FILE	A file containing instructions and properties for building a module using gradle.
JAVA_ARCHIVE_MANIFEST_FILE	A text file containing a list of name-value property pairs describing the content of a Java Archive (JAR) file.
JAVA_PACKAGE_DESCRIPTION	A file containing a description of a Java package that is incorporated into Javadoc documentation website.
LICENSE_FILE	A file describing the license for using the co-located content in a git repository.
LOGBACK_CONFIG_FILE	A properties file used to configure the Logback log file management utilities.
NOTICE_FILE	A file describing the license or copyright for using the co-located content in a git repository.
README_FILE	A document of words and linked to diagrams in Markdown format that describes the other files in the same directory (folder).

Method Summary

Modifier and Type	Method	Description
String	getFileName()	Return the file name.
FileType	getFileType()	Return the file type.
String	toString()	Output of this enum class and main value.
static FileName	valueOf(String name)	Returns the enum constant of this class with the specified name.
static FileName[]	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

JAVA_ARCHIVE_MANIFEST_FILE

public static final FileName JAVA_ARCHIVE_MANIFEST_FILE

A text file containing a list of name-value property pairs describing the content of a Java Archive (JAR) file.

APACHE_MAVEN_BUILD_FILE

public static final FileName APACHE_MAVEN_BUILD_FILE

A XML file containing instructions for building a module using Apache Maven.

GRADLE_BUILD_FILE

public static final FileName GRADLE_BUILD_FILE

A file containing instructions for building a module using gradle.

GRADLE_PROPERTIES_FILE

public static final FileName GRADLE_PROPERTIES_FILE

A file containing instructions and properties for building a module using gradle.

JAVA_PACKAGE_DESCRIPTION

public static final FileName JAVA_PACKAGE_DESCRIPTION

A file containing a description of a Java package that is incorporated into Javadoc documentation website.

DOCKER_CONTAINER_BUILD_SCRIPT

public static final FileName DOCKER_CONTAINER_BUILD_SCRIPT

A file containing instructions to build a Docker container.

GIT_IGNORE_FILE

public static final FileName GIT_IGNORE_FILE

A file containing details of the files to exclude from checking to the git tools.

CODEOWNERS_FILE

public static final FileName CODEOWNERS_FILE

A file listing the people responsible for maintaining the content of a git repository.

LICENSE_FILE

public static final FileName LICENSE_FILE

A file describing the license for using the co-located content in a git repository.

NOTICE_FILE

public static final FileName NOTICE_FILE

A file describing the license or copyright for using the co-located content in a git repository.

APPLICATION_PROPERTIES_FILE

public static final FileName APPLICATION_PROPERTIES_FILE

A properties file used to configure a Spring application during startup.

LOGBACK_CONFIG_FILE

public static final FileName LOGBACK_CONFIG_FILE

A properties file used to configure the Logback log file management utilities.

README_FILE

public static final FileName README_FILE

A document of words and linked to diagrams in Markdown format that describes the other files in the same directory (folder).

Method Details

values

public static FileName[] 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 FileName 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

getFileName

public String getFileName()

Return the file name.

Returns:

string

getFileType

public FileType getFileType()

Return the file type.

Returns:

string

toString

public String toString()

Output of this enum class and main value.

Overrides:

toString in class Enum<FileName>

Returns:

string showing enum value