Package org.codelibs.fess.theme

Enum Class ThemeManifestException.Code

java.lang.Object

java.lang.Enum<ThemeManifestException.Code>

org.codelibs.fess.theme.ThemeManifestException.Code

All Implemented Interfaces:

Serializable, Comparable<ThemeManifestException.Code>, Constable

Enclosing class:

ThemeManifestException

public static enum ThemeManifestException.Code
extends Enum<ThemeManifestException.Code>

Structured error codes for theme.yml failures.

Codes form a stable contract with the admin UI and the i18n message catalog (see errors.theme_manifest_* keys). When adding a new code, also add a corresponding addErrorsTheme* helper and message in fess_message*.properties.

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
DISPLAY_NAME_REQUIRED	displayName is missing or blank.
EMPTY	theme.yml contained no document (empty file or only comments).
FIELD_TOO_LONG	A field value exceeds the maximum allowed length.
INVALID_NAME	name is missing, blank, or fails the name regex.
INVALID_VERSION	version is missing or not a supported SemVer.
NOT_MAPPING	theme.yml root node is not a YAML mapping.
OTHER	Fallback for failures that do not fit any other category.
PARSE_FAILED	SnakeYAML failed to parse theme.yml.
UNSAFE_ENTRY	entry is absolute, contains traversal, or otherwise unsafe.
UNSUPPORTED_API_VERSION	apiVersion is missing or does not match the expected constant.
UNSUPPORTED_KIND	kind is missing or does not match the expected constant.

Method Summary

Modifier and Type	Method	Description
static ThemeManifestException.Code	valueOf(String name)	Returns the enum constant of this class with the specified name.
static ThemeManifestException.Code[]	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, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

PARSE_FAILED

public static final ThemeManifestException.Code PARSE_FAILED

SnakeYAML failed to parse theme.yml.

EMPTY

public static final ThemeManifestException.Code EMPTY

theme.yml contained no document (empty file or only comments).

NOT_MAPPING

public static final ThemeManifestException.Code NOT_MAPPING

theme.yml root node is not a YAML mapping.

FIELD_TOO_LONG

public static final ThemeManifestException.Code FIELD_TOO_LONG

A field value exceeds the maximum allowed length.

UNSUPPORTED_API_VERSION

public static final ThemeManifestException.Code UNSUPPORTED_API_VERSION

apiVersion is missing or does not match the expected constant.

UNSUPPORTED_KIND

public static final ThemeManifestException.Code UNSUPPORTED_KIND

kind is missing or does not match the expected constant.

INVALID_NAME

public static final ThemeManifestException.Code INVALID_NAME

name is missing, blank, or fails the name regex.

DISPLAY_NAME_REQUIRED

public static final ThemeManifestException.Code DISPLAY_NAME_REQUIRED

displayName is missing or blank.

INVALID_VERSION

public static final ThemeManifestException.Code INVALID_VERSION

version is missing or not a supported SemVer.

UNSAFE_ENTRY

public static final ThemeManifestException.Code UNSAFE_ENTRY

entry is absolute, contains traversal, or otherwise unsafe.

OTHER

public static final ThemeManifestException.Code OTHER

Fallback for failures that do not fit any other category.

Method Details

values

public static ThemeManifestException.Code[] 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 ThemeManifestException.Code 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