Package io.github.chrimle.classforge

Enum Class Builder.VersionPlacement

java.lang.Object
java.lang.Enum<Builder.VersionPlacement>
io.github.chrimle.classforge.Builder.VersionPlacement
All Implemented Interfaces:
Serializable, Comparable<Builder.VersionPlacement>, Constable
Enclosing interface:
Builder<T extends Builder<T>>
public static enum Builder.VersionPlacement extends Enum<Builder.VersionPlacement>
The placement of version information in generated classes.
Since:
0.3.0
Author:
Chrimle

  • Enum Constant Details

    • CLASS_NAME_WITH_COMPLETE_VERSION

      public static final Builder.VersionPlacement CLASS_NAME_WITH_COMPLETE_VERSION
      The complete version is included as a suffix in the class-name - always consisting of V{major}_{minor}_{patch}.

      Example: 1.2.3 

      class ExampleV1_2_3 { ... }

      Example: 1.3.0 

      class ExampleV1_3_0 { ... }

      Example: 2.0.0 

      class ExampleV2_0_0 { ... }
      Since:
      0.8.0

    • CLASS_NAME_WITH_SHORTENED_VERSION

      public static final Builder.VersionPlacement CLASS_NAME_WITH_SHORTENED_VERSION
      The shortened version is included as a suffix in the class-name - omitting trailing zeros i.e. V2.

      Example: 1.2.3 

      class ExampleV1_2_3 { ... }

      Example: 1.3.0 

      class ExampleV1_3 { ... }

      Example: 2.0.0 

      class ExampleV2 { ... }
      Since:
      0.8.0

    • NONE

      public static final Builder.VersionPlacement NONE
      Default. Version information is excluded.
      Since:
      0.3.0

    • PACKAGE_NAME_WITH_COMPLETE_VERSION

      public static final Builder.VersionPlacement PACKAGE_NAME_WITH_COMPLETE_VERSION
      The complete version is included in the package-name - always consisting of v{major}_{minor}_{patch}.

      Example: 1.2.3 

      package com.example.v1_2_3;

      Example: 1.3.0 

      package com.example.v1_3_0;

      Example: 2.0.0 

      package com.example.v2_0_0;
      Since:
      0.4.0

    • PACKAGE_NAME_WITH_SHORTENED_VERSION

      public static final Builder.VersionPlacement PACKAGE_NAME_WITH_SHORTENED_VERSION
      The shortened version is included in the package-name - omitting trailing zeros i.e. v2.

      Example: 1.2.3 

      package com.example.v1_2_3;

      Example: 1.3.0 

      package com.example.v1_3;

      Example: 2.0.0 

      package com.example.v2;
      Since:
      0.4.0

  • Method Details

    • values

      public static Builder.VersionPlacement[] 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 Builder.VersionPlacement 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