Package io.github.chrimle.classforge
Enum Class Builder.VersionPlacement
- All Implemented Interfaces:
Serializable
,Comparable<Builder.VersionPlacement>
,Constable
The placement of version information in generated classes.
- Since:
- 0.3.0
- Author:
- Chrimle
-
Nested Class Summary
Nested classes/interfaces inherited from class java.lang.Enum
Enum.EnumDesc<E extends Enum<E>>
-
Enum Constant Summary
Enum ConstantsEnum ConstantDescriptionDefault. Version information is excluded.The complete version is included in thepackage
-name - always consisting ofv{major}_{minor}_{patch}
.The shortened version is included in thepackage
-name - omitting trailing zeros i.e. -
Method Summary
Modifier and TypeMethodDescriptionstatic Builder.VersionPlacement
Returns the enum constant of this class with the specified name.static Builder.VersionPlacement[]
values()
Returns an array containing the constants of this enum class, in the order they are declared.
-
Enum Constant Details
-
NONE
Default. Version information is excluded.- Since:
- 0.3.0
-
PACKAGE_NAME_WITH_COMPLETE_VERSION
The complete version is included in thepackage
-name - always consisting ofv{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
The shortened version is included in thepackage
-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
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
-