Enum Class AdocLayout

java.lang.Object
java.lang.Enum<AdocLayout>
network.ike.docs.plugin.packages.AdocLayout
All Implemented Interfaces:
Serializable, Comparable<AdocLayout>, Constable

public enum AdocLayout extends Enum<AdocLayout>
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 Constants
    Enum Constant
    Description
    The layout before packages: a topics/<domain>/ tree under the root with the preview index and shared images beside it, the registry written to target/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 under META-INF/ike/<group>/<artifact>/.
  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final String
    The property that selects the layout.
  • Method Summary

    Modifier and Type
    Method
    Description
    static AdocLayout
    of(String value)
    Read the layout from the property's value.
    static AdocLayout
    Returns the enum constant of this class with the specified name.
    static AdocLayout[]
    Returns an array containing the constants of this enum class, in the order they are declared.

    Methods inherited from class Object

    getClass, notify, notifyAll, wait, wait, wait
  • Enum Constant Details

    • LEGACY

      public static final AdocLayout LEGACY
      The layout before packages: a topics/<domain>/ tree under the root with the preview index and shared images beside it, the registry written to target/topic-registry.yaml. The default.
    • PACKAGES

      public static final AdocLayout 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 under META-INF/ike/<group>/<artifact>/.
  • Field Details

  • Method Details

    • values

      public static AdocLayout[] 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 AdocLayout 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
    • of

      public static AdocLayout of(String value)
      Read the layout from the property's value.
      Parameters:
      value - the value of ike.adoc.layout, or null when the property is absent
      Returns:
      the layout; LEGACY when the value is absent or blank
      Throws:
      IllegalArgumentException - if the value names no layout