diff --git a/README.md b/README.md index c5d69fc..56a3e46 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,27 @@ -# string-value -Wrapper for an optional string value +# String value module +## Overview +Part of Zkejid's Constructor Framework. Serves as a wrapper around string values provided through any container: command line property, configuration property, etc. Includes semantics of "empty value" and "omitted value". Sometimes it is hard to say if the value of string parameter is actually an empty string, or the value is unspecified due to any reason. Sometimes both of these situationsshould be processed similarly, bot in other cases actions should be different. This module helps to process the value in strict and obvious way. + +## Usage +## API +To use the API as the publisher of the value you should request ```StringValueFactory.class``` interface in your ```ConstructorPart``` implementation: +``` + @Override + public Set> getInterfacesNecessary() { + return Set.of(StringValueFactory.class); + } +``` +For a given value to publish you should call ```make(String, InputValueType)``` method of the factory. ```String``` value contains the value to pass, ```InputValueType``` contains type of raw value obtained from the source. + +To use the API as the receiver of value you may just use ```StringValue``` object. + +## Constructor Module +String Value is the module of [Constructor Framework](https://github.com/zkejidsconstructor). +You can simply place artifacts of this module on the path of application to use its API. + +## Versioning +Artifact versions of the CliArguments Module follow the +[Semantic Versioning 2.0.0](https://semver.org/spec/v2.0.0.html) specification. + +## License +The module is provided under MIT License Copyright (c) 2020 Zkejid. \ No newline at end of file diff --git a/pom.xml b/pom.xml index 45b330d..005f44a 100644 --- a/pom.xml +++ b/pom.xml @@ -9,15 +9,25 @@ pom 1.0.0 - Wrapper for optional string values + String value wrapper + + Part of Zkejid's Constructor Framework. Serves as a wrapper around string values provided + through any container: command line property, configuration property, etc. Includes semantics + of "empty value" and "omitted value". + + https://github.com/zkejidsconstructor/string-value UTF-8 1.0.0 - 3.8.1 - 3.0.0-M4 1.0.0 5.6.2 + 3.8.1 + 3.0.0-M4 + 3.2.0 + 3.2.0 + 1.6 + 1.6.8 @@ -41,6 +51,68 @@ maven-surefire-plugin ${maven.surefire.plugin.version} + + org.apache.maven.plugins + maven-source-plugin + ${maven.source.plugin.version} + + + attach-sources + verify + + jar-no-fork + + + + + + org.apache.maven.plugins + maven-javadoc-plugin + ${maven.javadoc.plugin.version} + + + attach-javadocs + verify + + jar + + + + + + + + + + org.apache.maven.plugins + maven-gpg-plugin + ${maven.gpg.plugin.version} + + + sign-artifacts + verify + + sign + + + + ${gpg.keyname} + ${gpg.keyname} + + + + + + org.sonatype.plugins + nexus-staging-maven-plugin + ${maven.staging.plugin.version} + true + + ossrh + https://oss.sonatype.org/ + true + + @@ -78,4 +150,37 @@ + + + MIT License + http://www.opensource.org/licenses/mit-license.php + + + + + + Ivan Panfilov + developer@zkejid.com + Zkejid + https://github.com/zkejid + + + + + scm:git:git@github.com:zkejidsconstructor/string-value.git + scm:git:git@github.com:zkejidsconstructor/string-value.git + https://github.com/zkejidsconstructor/string-value + + + + + ossrh + https://oss.sonatype.org/content/repositories/snapshots + + + ossrh + https://oss.sonatype.org/service/local/staging/deploy/maven2/ + + + \ No newline at end of file diff --git a/string-value-api/pom.xml b/string-value-api/pom.xml index e6932be..e4597e7 100644 --- a/string-value-api/pom.xml +++ b/string-value-api/pom.xml @@ -11,4 +11,27 @@ string-value-api + String value wrapper: API + + Part of Zkejid's Constructor Framework. Serves as a wrapper around string values provided + through any container: command line property, configuration property, etc. Includes semantics + of "empty value" and "omitted value". + + https://github.com/zkejidsconstructor/string-value/tree/master/string-value-api + + + + MIT License + http://www.opensource.org/licenses/mit-license.php + + + + + + Ivan Panfilov + developer@zkejid.com + Zkejid + https://github.com/zkejid + + \ No newline at end of file diff --git a/string-value-impl/pom.xml b/string-value-impl/pom.xml index 5a7ae92..c5677a7 100644 --- a/string-value-impl/pom.xml +++ b/string-value-impl/pom.xml @@ -11,6 +11,14 @@ string-value-impl + String value wrapper: implementation + + Part of Zkejid's Constructor Framework. Serves as a wrapper around string values provided + through any container: command line property, configuration property, etc. Includes semantics + of "empty value" and "omitted value". + + https://github.com/zkejidsconstructor/string-value/tree/master/string-value-impl + com.zkejid.constructor @@ -37,4 +45,19 @@ + + + MIT License + http://www.opensource.org/licenses/mit-license.php + + + + + + Ivan Panfilov + developer@zkejid.com + Zkejid + https://github.com/zkejid + + \ No newline at end of file