[Git][java-team/headius-options][upstream] 15 commits: Bump junit from 4.11 to 4.13.1
Miguel Landaeta (@nomadium)
gitlab at salsa.debian.org
Tue Nov 28 21:09:47 GMT 2023
Miguel Landaeta pushed to branch upstream at Debian Java Maintainers / headius-options
Commits:
4a347cba by dependabot[bot] at 2020-10-13T06:45:22+00:00
Bump junit from 4.11 to 4.13.1
Bumps [junit](https://github.com/junit-team/junit4) from 4.11 to 4.13.1.
- [Release notes](https://github.com/junit-team/junit4/releases)
- [Changelog](https://github.com/junit-team/junit4/blob/main/doc/ReleaseNotes4.11.md)
- [Commits](https://github.com/junit-team/junit4/compare/r4.11...r4.13.1)
Signed-off-by: dependabot[bot] <support at github.com>
- - - - -
e7648663 by Charles Oliver Nutter at 2020-10-21T12:34:03-05:00
Merge pull request #4 from headius/dependabot/maven/junit-junit-4.13.1
Bump junit from 4.11 to 4.13.1
- - - - -
efe0f547 by Charles Oliver Nutter at 2021-01-15T14:04:20-06:00
Update to Java 8 min and add auto module name
- - - - -
4b7a21da by Charles Oliver Nutter at 2021-01-15T14:12:22-06:00
Remove nonexistant param
- - - - -
a956cb7b by Charles Oliver Nutter at 2021-01-15T14:13:41-06:00
[maven-release-plugin] prepare release options-1.5
- - - - -
f05cf43d by Charles Oliver Nutter at 2021-01-15T14:13:48-06:00
[maven-release-plugin] prepare for next development iteration
- - - - -
aaf07b90 by Charles Oliver Nutter at 2021-03-05T17:21:26-06:00
Promote to a full module-info
- - - - -
51897c14 by Charles Oliver Nutter at 2021-03-05T17:22:03-06:00
[maven-release-plugin] prepare release options-1.6
- - - - -
a40a7275 by Charles Oliver Nutter at 2021-03-05T17:22:10-06:00
[maven-release-plugin] prepare for next development iteration
- - - - -
eb5614b7 by Didik Supriadi at 2021-11-09T19:44:35+07:00
Add LICENSE
- - - - -
ea3b1262 by Charles Oliver Nutter at 2021-11-22T09:40:48-08:00
Merge pull request #5 from didiksupriadi41/add-license
Add LICENSE
- - - - -
85aef909 by Charles Oliver Nutter at 2021-11-22T11:49:35-06:00
Update license header with copyright
See #5
- - - - -
5fc74449 by Charles Oliver Nutter at 2021-11-22T12:29:08-06:00
License should not be javadoc
- - - - -
5ba744c2 by Charles Oliver Nutter at 2021-11-22T12:31:02-06:00
Fix javadoc to allow release on Java 11+
- - - - -
c948d50d by Charles Oliver Nutter at 2021-11-22T12:31:44-06:00
[maven-release-plugin] prepare release options-1.7
- - - - -
10 changed files:
- + LICENSE
- pom.xml
- src/main/java/com/headius/options/BooleanOption.java
- src/main/java/com/headius/options/EnumerationOption.java
- src/main/java/com/headius/options/IntegerOption.java
- src/main/java/com/headius/options/Option.java
- src/main/java/com/headius/options/StringOption.java
- src/main/java/com/headius/options/example/Example.java
- + src/main/java/module-info.java
- src/test/java/com/headius/options/BooleanOptionTest.java
Changes:
=====================================
LICENSE
=====================================
@@ -0,0 +1,201 @@
+ Apache License
+ Version 2.0, January 2004
+ http://www.apache.org/licenses/
+
+ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+ 1. Definitions.
+
+ "License" shall mean the terms and conditions for use, reproduction,
+ and distribution as defined by Sections 1 through 9 of this document.
+
+ "Licensor" shall mean the copyright owner or entity authorized by
+ the copyright owner that is granting the License.
+
+ "Legal Entity" shall mean the union of the acting entity and all
+ other entities that control, are controlled by, or are under common
+ control with that entity. For the purposes of this definition,
+ "control" means (i) the power, direct or indirect, to cause the
+ direction or management of such entity, whether by contract or
+ otherwise, or (ii) ownership of fifty percent (50%) or more of the
+ outstanding shares, or (iii) beneficial ownership of such entity.
+
+ "You" (or "Your") shall mean an individual or Legal Entity
+ exercising permissions granted by this License.
+
+ "Source" form shall mean the preferred form for making modifications,
+ including but not limited to software source code, documentation
+ source, and configuration files.
+
+ "Object" form shall mean any form resulting from mechanical
+ transformation or translation of a Source form, including but
+ not limited to compiled object code, generated documentation,
+ and conversions to other media types.
+
+ "Work" shall mean the work of authorship, whether in Source or
+ Object form, made available under the License, as indicated by a
+ copyright notice that is included in or attached to the work
+ (an example is provided in the Appendix below).
+
+ "Derivative Works" shall mean any work, whether in Source or Object
+ form, that is based on (or derived from) the Work and for which the
+ editorial revisions, annotations, elaborations, or other modifications
+ represent, as a whole, an original work of authorship. For the purposes
+ of this License, Derivative Works shall not include works that remain
+ separable from, or merely link (or bind by name) to the interfaces of,
+ the Work and Derivative Works thereof.
+
+ "Contribution" shall mean any work of authorship, including
+ the original version of the Work and any modifications or additions
+ to that Work or Derivative Works thereof, that is intentionally
+ submitted to Licensor for inclusion in the Work by the copyright owner
+ or by an individual or Legal Entity authorized to submit on behalf of
+ the copyright owner. For the purposes of this definition, "submitted"
+ means any form of electronic, verbal, or written communication sent
+ to the Licensor or its representatives, including but not limited to
+ communication on electronic mailing lists, source code control systems,
+ and issue tracking systems that are managed by, or on behalf of, the
+ Licensor for the purpose of discussing and improving the Work, but
+ excluding communication that is conspicuously marked or otherwise
+ designated in writing by the copyright owner as "Not a Contribution."
+
+ "Contributor" shall mean Licensor and any individual or Legal Entity
+ on behalf of whom a Contribution has been received by Licensor and
+ subsequently incorporated within the Work.
+
+ 2. Grant of Copyright License. Subject to the terms and conditions of
+ this License, each Contributor hereby grants to You a perpetual,
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+ copyright license to reproduce, prepare Derivative Works of,
+ publicly display, publicly perform, sublicense, and distribute the
+ Work and such Derivative Works in Source or Object form.
+
+ 3. Grant of Patent License. Subject to the terms and conditions of
+ this License, each Contributor hereby grants to You a perpetual,
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+ (except as stated in this section) patent license to make, have made,
+ use, offer to sell, sell, import, and otherwise transfer the Work,
+ where such license applies only to those patent claims licensable
+ by such Contributor that are necessarily infringed by their
+ Contribution(s) alone or by combination of their Contribution(s)
+ with the Work to which such Contribution(s) was submitted. If You
+ institute patent litigation against any entity (including a
+ cross-claim or counterclaim in a lawsuit) alleging that the Work
+ or a Contribution incorporated within the Work constitutes direct
+ or contributory patent infringement, then any patent licenses
+ granted to You under this License for that Work shall terminate
+ as of the date such litigation is filed.
+
+ 4. Redistribution. You may reproduce and distribute copies of the
+ Work or Derivative Works thereof in any medium, with or without
+ modifications, and in Source or Object form, provided that You
+ meet the following conditions:
+
+ (a) You must give any other recipients of the Work or
+ Derivative Works a copy of this License; and
+
+ (b) You must cause any modified files to carry prominent notices
+ stating that You changed the files; and
+
+ (c) You must retain, in the Source form of any Derivative Works
+ that You distribute, all copyright, patent, trademark, and
+ attribution notices from the Source form of the Work,
+ excluding those notices that do not pertain to any part of
+ the Derivative Works; and
+
+ (d) If the Work includes a "NOTICE" text file as part of its
+ distribution, then any Derivative Works that You distribute must
+ include a readable copy of the attribution notices contained
+ within such NOTICE file, excluding those notices that do not
+ pertain to any part of the Derivative Works, in at least one
+ of the following places: within a NOTICE text file distributed
+ as part of the Derivative Works; within the Source form or
+ documentation, if provided along with the Derivative Works; or,
+ within a display generated by the Derivative Works, if and
+ wherever such third-party notices normally appear. The contents
+ of the NOTICE file are for informational purposes only and
+ do not modify the License. You may add Your own attribution
+ notices within Derivative Works that You distribute, alongside
+ or as an addendum to the NOTICE text from the Work, provided
+ that such additional attribution notices cannot be construed
+ as modifying the License.
+
+ You may add Your own copyright statement to Your modifications and
+ may provide additional or different license terms and conditions
+ for use, reproduction, or distribution of Your modifications, or
+ for any such Derivative Works as a whole, provided Your use,
+ reproduction, and distribution of the Work otherwise complies with
+ the conditions stated in this License.
+
+ 5. Submission of Contributions. Unless You explicitly state otherwise,
+ any Contribution intentionally submitted for inclusion in the Work
+ by You to the Licensor shall be under the terms and conditions of
+ this License, without any additional terms or conditions.
+ Notwithstanding the above, nothing herein shall supersede or modify
+ the terms of any separate license agreement you may have executed
+ with Licensor regarding such Contributions.
+
+ 6. Trademarks. This License does not grant permission to use the trade
+ names, trademarks, service marks, or product names of the Licensor,
+ except as required for reasonable and customary use in describing the
+ origin of the Work and reproducing the content of the NOTICE file.
+
+ 7. Disclaimer of Warranty. Unless required by applicable law or
+ agreed to in writing, Licensor provides the Work (and each
+ Contributor provides its Contributions) on an "AS IS" BASIS,
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+ implied, including, without limitation, any warranties or conditions
+ of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+ PARTICULAR PURPOSE. You are solely responsible for determining the
+ appropriateness of using or redistributing the Work and assume any
+ risks associated with Your exercise of permissions under this License.
+
+ 8. Limitation of Liability. In no event and under no legal theory,
+ whether in tort (including negligence), contract, or otherwise,
+ unless required by applicable law (such as deliberate and grossly
+ negligent acts) or agreed to in writing, shall any Contributor be
+ liable to You for damages, including any direct, indirect, special,
+ incidental, or consequential damages of any character arising as a
+ result of this License or out of the use or inability to use the
+ Work (including but not limited to damages for loss of goodwill,
+ work stoppage, computer failure or malfunction, or any and all
+ other commercial damages or losses), even if such Contributor
+ has been advised of the possibility of such damages.
+
+ 9. Accepting Warranty or Additional Liability. While redistributing
+ the Work or Derivative Works thereof, You may choose to offer,
+ and charge a fee for, acceptance of support, warranty, indemnity,
+ or other liability obligations and/or rights consistent with this
+ License. However, in accepting such obligations, You may act only
+ on Your own behalf and on Your sole responsibility, not on behalf
+ of any other Contributor, and only if You agree to indemnify,
+ defend, and hold each Contributor harmless for any liability
+ incurred by, or claims asserted against, such Contributor by reason
+ of your accepting any such warranty or additional liability.
+
+ END OF TERMS AND CONDITIONS
+
+ APPENDIX: How to apply the Apache License to your work.
+
+ To apply the Apache License to your work, attach the following
+ boilerplate notice, with the fields enclosed by brackets "[]"
+ replaced with your own identifying information. (Don't include
+ the brackets!) The text should be enclosed in the appropriate
+ comment syntax for the file format. We also recommend that a
+ file or class name and description of purpose be included on the
+ same "printed page" as the copyright notice for easier
+ identification within third-party archives.
+
+ Copyright [yyyy] [name of copyright owner]
+
+ Licensed under the Apache License, Version 2.0 (the "License");
+ you may not use this file except in compliance with the License.
+ You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing, software
+ distributed under the License is distributed on an "AS IS" BASIS,
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ See the License for the specific language governing permissions and
+ limitations under the License.
=====================================
pom.xml
=====================================
@@ -1,9 +1,25 @@
+<!--
+Copyright 2013-2021 Charles Oliver Nutter <headius at headius.com>
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+-->
+
<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
<modelVersion>4.0.0</modelVersion>
<groupId>com.headius</groupId>
<artifactId>options</artifactId>
- <version>1.5-SNAPSHOT</version>
+ <version>1.7</version>
<packaging>jar</packaging>
<name>options</name>
@@ -11,6 +27,8 @@
<properties>
<project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
+ <maven.compiler.source>8</maven.compiler.source>
+ <maven.compiler.target>8</maven.compiler.target>
</properties>
<parent>
@@ -45,8 +63,48 @@
<dependency>
<groupId>junit</groupId>
<artifactId>junit</artifactId>
- <version>4.11</version>
+ <version>4.13.1</version>
<scope>test</scope>
</dependency>
</dependencies>
+
+ <build>
+ <plugins>
+ <plugin>
+ <groupId>org.apache.maven.plugins</groupId>
+ <artifactId>maven-compiler-plugin</artifactId>
+ <version>3.7.0</version>
+ <executions>
+ <execution>
+ <id>default-compile</id>
+ <configuration>
+ <includes>
+ <include>module-info.java</include>
+ </includes>
+ <release>9</release>
+ </configuration>
+ </execution>
+ <execution>
+ <id>default-testCompile</id>
+ <configuration>
+ <release>9</release>
+ </configuration>
+ </execution>
+ <execution>
+ <id>base-compile</id>
+ <goals>
+ <goal>compile</goal>
+ </goals>
+ <configuration>
+ <source>8</source>
+ <target>8</target>
+ <excludes>
+ <exclude>module-info.java</exclude>
+ </excludes>
+ </configuration>
+ </execution>
+ </executions>
+ </plugin>
+ </plugins>
+ </build>
</project>
=====================================
src/main/java/com/headius/options/BooleanOption.java
=====================================
@@ -1,4 +1,6 @@
/*
+ * Copyright 2013-2021 Charles Oliver Nutter <headius at headius.com>
+ *
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
@@ -21,8 +23,8 @@ package com.headius.options;
* it is considered an "on" switch and a true value.
*/
public class BooleanOption extends Option<Boolean> {
- public BooleanOption(String prefix, String name, Enum category, Boolean defval, String description) {
- super(prefix, name, Boolean.class, category, new Boolean[] {true, false}, defval, description);
+ public BooleanOption(String prefix, String shortName, Enum category, Boolean defval, String description) {
+ super(prefix, shortName, Boolean.class, category, new Boolean[] {true, false}, defval, description);
}
public BooleanOption(String longName, Enum category, Boolean defval, String description) {
=====================================
src/main/java/com/headius/options/EnumerationOption.java
=====================================
@@ -1,4 +1,6 @@
/*
+ * Copyright 2013-2021 Charles Oliver Nutter <headius at headius.com>
+ *
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
@@ -18,8 +20,8 @@ package com.headius.options;
* An Enum-based Option.
*/
public class EnumerationOption<T extends Enum<T>> extends Option<T> {
- public EnumerationOption(String prefix, String name, Enum category, Class<T> enumType, T defval, String description) {
- super(prefix, name, enumType, category, (T[])enumType.getEnumConstants(), defval, description);
+ public EnumerationOption(String prefix, String shortName, Enum category, Class<T> enumType, T defval, String description) {
+ super(prefix, shortName, enumType, category, (T[])enumType.getEnumConstants(), defval, description);
}
public EnumerationOption(String longName, Enum category, Class<T> enumType, T defval, String description) {
=====================================
src/main/java/com/headius/options/IntegerOption.java
=====================================
@@ -1,4 +1,6 @@
/*
+ * Copyright 2013-2021 Charles Oliver Nutter <headius at headius.com>
+ *
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
@@ -18,16 +20,16 @@ package com.headius.options;
* An Integer-based Option.
*/
public class IntegerOption extends Option<Integer> {
- public IntegerOption(String prefix, String name, Enum category, Integer[] options, Integer defval, String description) {
- super(prefix, name, Integer.class, category, options, defval, description);
+ public IntegerOption(String prefix, String shortName, Enum category, Integer[] options, Integer defval, String description) {
+ super(prefix, shortName, Integer.class, category, options, defval, description);
}
public IntegerOption(String longName, Enum category, Integer[] options, Integer defval, String description) {
super(longName, Integer.class, category, options, defval, description);
}
- public IntegerOption(String prefix, String name, Enum category, Integer defval, String description) {
- super(prefix, name, Integer.class, category, null, defval, description);
+ public IntegerOption(String prefix, String shortName, Enum category, Integer defval, String description) {
+ super(prefix, shortName, Integer.class, category, null, defval, description);
}
public IntegerOption(String longName, Enum category, Integer defval, String description) {
=====================================
src/main/java/com/headius/options/Option.java
=====================================
@@ -1,4 +1,6 @@
-/*
+/**
+ * Copyright 2013-2021 Charles Oliver Nutter <headius at headius.com>
+ *
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
@@ -42,7 +44,6 @@ public abstract class Option<T> {
/**
* Create a new option with the given values.
*
- * @param <C> an enumeration type
* @param prefix the prefix used for loading this option from properties
* @param shortName the rest of the property name
* @param type the value type of the option
@@ -68,7 +69,6 @@ public abstract class Option<T> {
/**
* Create a new option with the given values.
*
- * @param <C> an enumeration type
* @param longName the property name
* @param type the value type of the option
* @param category the category to which this option belongs
@@ -92,13 +92,27 @@ public abstract class Option<T> {
/**
* Create a new String option with the given configuration.
+ *
+ * @param prefix the prefix used for loading this option from properties
+ * @param shortName the rest of the property name
+ * @param category the category to which this option belongs
+ * @param description a description for the option
+ *
+ * @return a new String-based option
*/
- public static Option<String> string(String prefix, String name, Enum category, String description) {
- return new StringOption(prefix, name, category, null, null, description);
+ public static Option<String> string(String prefix, String shortName, Enum category, String description) {
+ return new StringOption(prefix, shortName, category, null, null, description);
}
-
+
+
/**
* Create a new String option with the given configuration.
+ *
+ * @param longName the property name
+ * @param category the category to which this option belongs
+ * @param description a description for the option
+ *
+ * @return a new String-based option
*/
public static Option<String> string(String longName, Enum category, String description) {
return new StringOption(longName, category, null, null, description);
@@ -106,13 +120,28 @@ public abstract class Option<T> {
/**
* Create a new String option with the given configuration.
+ *
+ * @param prefix the prefix used for loading this option from properties
+ * @param shortName the rest of the property name
+ * @param category the category to which this option belongs
+ * @param defval the default value for the option
+ * @param description a description for the option
+ *
+ * @return a new String-based Option
*/
- public static Option<String> string(String prefix, String name, Enum category, String defval, String description) {
- return new StringOption(prefix, name, category, null, defval, description);
+ public static Option<String> string(String prefix, String shortName, Enum category, String defval, String description) {
+ return new StringOption(prefix, shortName, category, null, defval, description);
}
/**
* Create a new String option with the given configuration.
+ *
+ * @param longName the property name
+ * @param category the category to which this option belongs
+ * @param defval the default value for the option
+ * @param description a description for the option
+ *
+ * @return a new String-based Option
*/
public static Option<String> string(String longName, Enum category, String defval, String description) {
return new StringOption(longName, category, null, defval, description);
@@ -120,13 +149,30 @@ public abstract class Option<T> {
/**
* Create a new String option with the given configuration.
+ *
+ * @param prefix the prefix used for loading this option from properties
+ * @param shortName the rest of the property name
+ * @param category the category to which this option belongs
+ * @param options a list of supported for the option, or null if the set is
+ * not applicable
+ * @param description a description for the option
+ *
+ * @return a new String-based Option
*/
- public static Option<String> string(String prefix, String name, Enum category, String[] options, String description) {
- return new StringOption(prefix, name, category, options, null, description);
+ public static Option<String> string(String prefix, String shortName, Enum category, String[] options, String description) {
+ return new StringOption(prefix, shortName, category, options, null, description);
}
/**
* Create a new String option with the given configuration.
+ *
+ * @param longName the property name
+ * @param category the category to which this option belongs
+ * @param options a list of supported for the option, or null if the set is
+ * not applicable
+ * @param description a description for the option
+ *
+ * @return a new String-based Option
*/
public static Option<String> string(String longName, Enum category, String[] options, String description) {
return new StringOption(longName, category, options, null, description);
@@ -134,13 +180,32 @@ public abstract class Option<T> {
/**
* Create a new String option with the given configuration.
+ *
+ * @param prefix the prefix used for loading this option from properties
+ * @param shortName the rest of the property name
+ * @param category the category to which this option belongs
+ * @param options a list of supported for the option, or null if the set is
+ * not applicable
+ * @param defval the default value for the option
+ * @param description a description for the option
+ *
+ * @return a new String-based Option
*/
- public static Option<String> string(String prefix, String name, Enum category, String[] options, String defval, String description) {
- return new StringOption(prefix, name, category, options, defval, description);
+ public static Option<String> string(String prefix, String shortName, Enum category, String[] options, String defval, String description) {
+ return new StringOption(prefix, shortName, category, options, defval, description);
}
/**
* Create a new String option with the given configuration.
+ *
+ * @param longName the property name
+ * @param category the category to which this option belongs
+ * @param options a list of supported for the option, or null if the set is
+ * not applicable
+ * @param defval the default value for the option
+ * @param description a description for the option
+ *
+ * @return a new String-based Option
*/
public static Option<String> string(String longName, Enum category, String[] options, String defval, String description) {
return new StringOption(longName, category, options, defval, description);
@@ -148,13 +213,26 @@ public abstract class Option<T> {
/**
* Create a new Boolean option with the given configuration.
+ *
+ * @param prefix the prefix used for loading this option from properties
+ * @param shortName the rest of the property name
+ * @param category the category to which this option belongs
+ * @param description a description for the option
+ *
+ * @return a new Boolean-based Option
*/
- public static Option<Boolean> bool(String prefix, String name, Enum category, String description) {
- return new BooleanOption(prefix, name, category, null, description);
+ public static Option<Boolean> bool(String prefix, String shortName, Enum category, String description) {
+ return new BooleanOption(prefix, shortName, category, null, description);
}
/**
* Create a new Boolean option with the given configuration.
+ *
+ * @param longName the property name
+ * @param category the category to which this option belongs
+ * @param description a description for the option
+ *
+ * @return a new Boolean-based Option
*/
public static Option<Boolean> bool(String longName, Enum category, String description) {
return new BooleanOption(longName, category, null, description);
@@ -162,13 +240,28 @@ public abstract class Option<T> {
/**
* Create a new Boolean option with the given configuration.
+ *
+ * @param prefix the prefix used for loading this option from properties
+ * @param shortName the rest of the property name
+ * @param category the category to which this option belongs
+ * @param defval the default value for the option
+ * @param description a description for the option
+ *
+ * @return a new Boolean-based Option
*/
- public static Option<Boolean> bool(String prefix, String name, Enum category, Boolean defval, String description) {
- return new BooleanOption(prefix, name, category, defval, description);
+ public static Option<Boolean> bool(String prefix, String shortName, Enum category, Boolean defval, String description) {
+ return new BooleanOption(prefix, shortName, category, defval, description);
}
/**
* Create a new Boolean option with the given configuration.
+ *
+ * @param longName the property name
+ * @param category the category to which this option belongs
+ * @param defval the default value for the option
+ * @param description a description for the option
+ *
+ * @return a new Boolean-based Option
*/
public static Option<Boolean> bool(String longName, Enum category, Boolean defval, String description) {
return new BooleanOption(longName, category, defval, description);
@@ -176,20 +269,42 @@ public abstract class Option<T> {
/**
* Create a new Integer option with the given configuration.
+ *
+ * @param prefix the prefix used for loading this option from properties
+ * @param shortName the rest of the property name
+ * @param category the category to which this option belongs
+ * @param description a description for the option
+ *
+ * @return a new Integer-based Option
*/
- public static Option<Integer> integer(String prefix, String name, Enum category, String description) {
- return new IntegerOption(prefix, name, category, null, description);
+ public static Option<Integer> integer(String prefix, String shortName, Enum category, String description) {
+ return new IntegerOption(prefix, shortName, category, null, description);
}
/**
* Create a new Integer option with the given configuration.
+ *
+ * @param prefix the prefix used for loading this option from properties
+ * @param shortName the rest of the property name
+ * @param category the category to which this option belongs
+ * @param options a list of supported for the option, or null if the set is
+ * not applicable
+ * @param description a description for the option
+ *
+ * @return a new Integer-based Option
*/
- public static Option<Integer> integer(String prefix, String name, Enum category, Integer[] options, String description) {
- return new IntegerOption(prefix, name, category, options, null, description);
+ public static Option<Integer> integer(String prefix, String shortName, Enum category, Integer[] options, String description) {
+ return new IntegerOption(prefix, shortName, category, options, null, description);
}
/**
* Create a new Integer option with the given configuration.
+ *
+ * @param longName the property name
+ * @param category the category to which this option belongs
+ * @param description a description for the option
+ *
+ * @return a new Integer-based Option
*/
public static Option<Integer> integer(String longName, Enum category, String description) {
return new IntegerOption(longName, category, null, description);
@@ -197,6 +312,14 @@ public abstract class Option<T> {
/**
* Create a new Integer option with the given configuration.
+ *
+ * @param longName the property name
+ * @param category the category to which this option belongs
+ * @param options a list of supported for the option, or null if the set is
+ * not applicable
+ * @param description a description for the option
+ *
+ * @return a new Integer-based Option
*/
public static Option<Integer> integer(String longName, Enum category, Integer[] options, String description) {
return new IntegerOption(longName, category, options, null, description);
@@ -204,13 +327,28 @@ public abstract class Option<T> {
/**
* Create a new Integer option with the given configuration.
+ *
+ * @param prefix the prefix used for loading this option from properties
+ * @param shortName the rest of the property name
+ * @param category the category to which this option belongs
+ * @param defval the default value for the option
+ * @param description a description for the option
+ *
+ * @return a new Integer-based Option
*/
- public static Option<Integer> integer(String prefix, String name, Enum category, Integer defval, String description) {
- return new IntegerOption(prefix, name, category, defval, description);
+ public static Option<Integer> integer(String prefix, String shortName, Enum category, Integer defval, String description) {
+ return new IntegerOption(prefix, shortName, category, defval, description);
}
/**
* Create a new Integer option with the given configuration.
+ *
+ * @param longName the property name
+ * @param category the category to which this option belongs
+ * @param defval the default value for the option
+ * @param description a description for the option
+ *
+ * @return a new Integer-based Option
*/
public static Option<Integer> integer(String longName, Enum category, Integer defval, String description) {
return new IntegerOption(longName, category, defval, description);
@@ -218,13 +356,32 @@ public abstract class Option<T> {
/**
* Create a new Integer option with the given configuration.
+ *
+ * @param prefix the prefix used for loading this option from properties
+ * @param shortName the rest of the property name
+ * @param category the category to which this option belongs
+ * @param options a list of supported for the option, or null if the set is
+ * not applicable
+ * @param defval the default value for the option
+ * @param description a description for the option
+ *
+ * @return a new Integer-based Option
*/
- public static Option<Integer> integer(String prefix, String name, Enum category, Integer[] options, Integer defval, String description) {
- return new IntegerOption(prefix, name, category, options, defval, description);
+ public static Option<Integer> integer(String prefix, String shortName, Enum category, Integer[] options, Integer defval, String description) {
+ return new IntegerOption(prefix, shortName, category, options, defval, description);
}
/**
* Create a new Integer option with the given configuration.
+ *
+ * @param longName the property name
+ * @param category the category to which this option belongs
+ * @param options a list of supported for the option, or null if the set is
+ * not applicable
+ * @param defval the default value for the option
+ * @param description a description for the option
+ *
+ * @return a new Integer-based Option
*/
public static Option<Integer> integer(String longName, Enum category, Integer[] options, Integer defval, String description) {
return new IntegerOption(longName, category, options, defval, description);
@@ -232,13 +389,28 @@ public abstract class Option<T> {
/**
* Create a new Enumeration-based option with the given configuration.
+ *
+ * @param <T> the type of the enum
+ * @param prefix the prefix used for loading this option from properties
+ * @param shortName the rest of the property name
+ * @param category the category to which this option belongs
+ * @param description a description for the option
+ *
+ * @return a new Enumeration-based Option
*/
- public static <T extends Enum<T>> Option<T> enumeration(String prefix, String name, Enum category, Class<T> enumClass, String description) {
- return new EnumerationOption(prefix, name, category, enumClass, null, description);
+ public static <T extends Enum<T>> Option<T> enumeration(String prefix, String shortName, Enum category, Class<T> enumClass, String description) {
+ return new EnumerationOption(prefix, shortName, category, enumClass, null, description);
}
/**
* Create a new Enumeration-based option with the given configuration.
+ *
+ * @param <T> the type of the enum
+ * @param longName the property name
+ * @param category the category to which this option belongs
+ * @param description a description for the option
+ *
+ * @return a new Enumeration-based Option
*/
public static <T extends Enum<T>> Option<T> enumeration(String longName, Enum category, Class<T> enumClass, String description) {
return new EnumerationOption(longName, category, enumClass, null, description);
@@ -246,13 +418,30 @@ public abstract class Option<T> {
/**
* Create a new Enumeration-based option with the given configuration.
+ *
+ * @param <T> the type of the enum
+ * @param prefix the prefix used for loading this option from properties
+ * @param shortName the rest of the property name
+ * @param category the category to which this option belongs
+ * @param defval the default value for the option
+ * @param description a description for the option
+ *
+ * @return a new Enumeration-based Option
*/
- public static <T extends Enum<T>> Option<T> enumeration(String prefix, String name, Enum category, T defval, String description) {
- return new EnumerationOption(prefix, name, category, defval.getClass(), defval, description);
+ public static <T extends Enum<T>> Option<T> enumeration(String prefix, String shortName, Enum category, T defval, String description) {
+ return new EnumerationOption(prefix, shortName, category, defval.getClass(), defval, description);
}
/**
* Create a new Enumeration-based option with the given configuration.
+ *
+ * @param <T> the type of the enum
+ * @param longName the property name
+ * @param category the category to which this option belongs
+ * @param defval the default value for the option
+ * @param description a description for the option
+ *
+ * @return a new Enumeration-based Option
*/
public static <T extends Enum<T>> Option<T> enumeration(String longName, Enum category, T defval, String description) {
return new EnumerationOption(longName, category, defval.getClass(), defval, description);
@@ -260,6 +449,9 @@ public abstract class Option<T> {
/**
* Format the given options to show their loaded values in the current JVM.
+ *
+ * @param options the options to format
+ * @return a formatted string representing the options
*/
public static String formatValues(Option... options) {
return formatValues(Arrays.asList(options));
@@ -267,6 +459,9 @@ public abstract class Option<T> {
/**
* Format the given options to show their loaded values in the current JVM.
+ *
+ * @param options the options to format
+ * @return a formatted string representing the options
*/
public static String formatValues(Collection<Option> options) {
StringBuilder sb = new StringBuilder();
@@ -296,6 +491,9 @@ public abstract class Option<T> {
/**
* Format the given options in a way suitable for use as a configuration
* file or documentation.
+ *
+ * @param options the options to format
+ * @return a formatted string representing the options as a config file or document
*/
public static String formatOptions(Option... options) {
return formatOptions(Arrays.asList(options));
@@ -304,6 +502,9 @@ public abstract class Option<T> {
/**
* Format the given options in a way suitable for use as a configuration
* file or documentation.
+ *
+ * @param options the options to format
+ * @return a formatted string representing the options as a config file or document
*/
public static String formatOptions(Collection<Option> options) {
StringBuilder sb = new StringBuilder();
@@ -393,6 +594,9 @@ public abstract class Option<T> {
/**
* Load the option's property, as if by calling java.lang.System#getProperty
+ *
+ * @return the option's property's current value, or a value previously forced
+ * into this option by {@link #force(String)}
*/
public synchronized String loadProperty() {
String value = forced;
@@ -409,14 +613,14 @@ public abstract class Option<T> {
}
/**
- * Return true if the option's property was specified, false otherwise.
+ * @return true if the option's property was specified, false otherwise.
*/
public boolean isSpecified() {
return specified;
}
/**
- * Return the value of the option, loading if it has not been already.
+ * @return the value of the option, loading if it has not been already.
*/
public final T load() {
if (loaded) return value;
@@ -426,6 +630,8 @@ public abstract class Option<T> {
/**
* Force a load of the option's property and return the loaded value.
+ *
+ * @return the loaded value
*/
public final synchronized T reload() {
if (loaded) return value;
@@ -438,7 +644,8 @@ public abstract class Option<T> {
/**
* Force the property value to the given value for all future loads and reloads.
- * @param value
+ *
+ * @param value a value to force for the Option's property, as if set in JVM
*/
public synchronized void force(String value) {
forced = value;
@@ -457,18 +664,22 @@ public abstract class Option<T> {
/**
* Perform the appropriate load and conversion for the option's property.
+ *
+ * @return the updated value after reload
*/
protected abstract T reloadValue();
/**
* If the option has a short name, return it. Otherwise null.
+ *
+ * @return the short name, or else null
*/
public String shortName() {
return shortName;
}
/**
- * Return the full property name for the option.
+ * @return the full property name for the option.
*/
public String propertyName() {
return longName;
@@ -476,6 +687,8 @@ public abstract class Option<T> {
/**
* If the property has a prefix, return it. Otherwise null.
+ *
+ * @return the property prefix, or else null
*/
public String prefix() {
return prefix;
@@ -483,6 +696,8 @@ public abstract class Option<T> {
/**
* The display name of the option's property, either the short name or the full name.
+ *
+ * @return the full display name of this option's property
*/
public String displayName() {
return displayName;
@@ -490,7 +705,8 @@ public abstract class Option<T> {
/**
* The type returned for the option.
- * @return
+ *
+ * @return the type of option that this is
*/
public Class<T> type() {
return type;
@@ -498,20 +714,22 @@ public abstract class Option<T> {
/**
* The array of accepted values for the option, or null if any values are accepted.
+ *
+ * @return an array of accepted values, or null if any values are allowed
*/
public T[] options() {
return options == null ? null : options.clone();
}
/**
- * The default value for the option, or null if no default is provided.
+ * @return the default value for the option, or null if no default is provided.
*/
public T defaultValue() {
return defval;
}
/**
- * The long description of the property, as for documentation and configuration file templates.
+ * @return the long description of the property, as for documentation and configuration file templates.
*/
public String description() {
return description;
=====================================
src/main/java/com/headius/options/StringOption.java
=====================================
@@ -1,4 +1,6 @@
/*
+ * Copyright 2013-2021 Charles Oliver Nutter <headius at headius.com>
+ *
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
@@ -18,8 +20,8 @@ package com.headius.options;
* A String-based Option.
*/
public class StringOption extends Option<String> {
- public StringOption(String prefix, String name, Enum category, String[] options, String defval, String description) {
- super(prefix, name, String.class, category, options, defval, description);
+ public StringOption(String prefix, String shortName, Enum category, String[] options, String defval, String description) {
+ super(prefix, shortName, String.class, category, options, defval, description);
}
public StringOption(String longName, Enum category, String[] options, String defval, String description) {
=====================================
src/main/java/com/headius/options/example/Example.java
=====================================
@@ -1,4 +1,6 @@
/*
+ * Copyright 2013-2021 Charles Oliver Nutter <headius at headius.com>
+ *
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
=====================================
src/main/java/module-info.java
=====================================
@@ -0,0 +1,21 @@
+/*
+ * Copyright 2013-2021 Charles Oliver Nutter <headius at headius.com>
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+module com.headius.options {
+ requires java.base;
+
+ exports com.headius.options;
+}
\ No newline at end of file
=====================================
src/test/java/com/headius/options/BooleanOptionTest.java
=====================================
@@ -1,3 +1,19 @@
+/*
+ * Copyright 2013-2021 Charles Oliver Nutter <headius at headius.com>
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
package com.headius.options;
import org.junit.Test;
View it on GitLab: https://salsa.debian.org/java-team/headius-options/-/compare/034197c0cdae06b85f345f0e29f8f9e805c6371a...c948d50d99f6efe50a4a059d3016299e850c092b
--
View it on GitLab: https://salsa.debian.org/java-team/headius-options/-/compare/034197c0cdae06b85f345f0e29f8f9e805c6371a...c948d50d99f6efe50a4a059d3016299e850c092b
You're receiving this email because of your account on salsa.debian.org.
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://alioth-lists.debian.net/pipermail/pkg-java-commits/attachments/20231128/62b357d8/attachment.htm>
More information about the pkg-java-commits
mailing list