Enum Class AdocLayout
- All Implemented Interfaces:
Serializable, Comparable<AdocLayout>, Constable
How a library lays out its AsciiDoc root, chosen by the POM property
ike.adoc.layout (dev-adoc-packages,
IKE-Network/ike-issues#1341). The property gates every rule of the
packages layout, so a library that has not declared it keeps building
exactly as before through the migration.- Since:
- 136
-
Nested Class Summary
Nested classes/interfaces inherited from class Enum
Enum.EnumDesc<E> -
Enum Constant Summary
Enum ConstantsEnum ConstantDescriptionThe layout before packages: atopics/<domain>/tree under the root with the preview index and shared images beside it, the registry written totarget/topic-registry.yaml.The packages layout: the root holds one directory per owning group, written as one dotted segment, with the topic domain as the directory under it; artifact metadata goes underMETA-INF/ike/<group>/<artifact>/. -
Field Summary
Fields -
Method Summary
Modifier and TypeMethodDescriptionstatic AdocLayoutRead the layout from the property's value.static AdocLayoutReturns the enum constant of this class with the specified name.static AdocLayout[]values()Returns an array containing the constants of this enum class, in the order they are declared.
-
Enum Constant Details
-
LEGACY
The layout before packages: atopics/<domain>/tree under the root with the preview index and shared images beside it, the registry written totarget/topic-registry.yaml. The default. -
PACKAGES
The packages layout: the root holds one directory per owning group, written as one dotted segment, with the topic domain as the directory under it; artifact metadata goes underMETA-INF/ike/<group>/<artifact>/.
-
-
Field Details
-
PROPERTY
-
-
Method Details
-
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
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 nameNullPointerException- if the argument is null
-
of
Read the layout from the property's value.- Parameters:
value- the value ofike.adoc.layout, ornullwhen the property is absent- Returns:
- the layout;
LEGACYwhen the value is absent or blank - Throws:
IllegalArgumentException- if the value names no layout
-