org.refcodes.properties.ext.cli.ArgsParserPropertiesAccessor Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of refcodes-properties-ext-cli Show documentation
Artifact extending the refcodes-properties artifact with CLI functionality.
There is a newer version: 3.3.9
Show newest version
// /////////////////////////////////////////////////////////////////////////////
// REFCODES.ORG
// =============================================================================
// This code is copyright (c) by Siegfried Steiner, Munich, Germany, distributed
// on an "AS IS" BASIS WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, and licen-
// sed under the following (see "http://en.wikipedia.org/wiki/Multi-licensing")
// licenses:
// =============================================================================
// GNU General Public License, v3.0 ("http://www.gnu.org/licenses/gpl-3.0.html")
// together with the GPL linking exception applied; as being applied by the GNU
// Classpath ("http://www.gnu.org/software/classpath/license.html")
// =============================================================================
// Apache License, v2.0 ("http://www.apache.org/licenses/TEXT-2.0")
// =============================================================================
// Please contact the copyright holding author(s) of the software artifacts in
// question for licensing issues not being covered by the above listed licenses,
// also regarding commercial licensing models or regarding the compatibility
// with other open source licenses.
// /////////////////////////////////////////////////////////////////////////////

package org.refcodes.properties.ext.cli;

/**
 * Provides an accessor for a {@link ParseArgsProperties} property.
 */
public interface ArgsParserPropertiesAccessor {

	/**
	 * Retrieves the args-properties from the {@link ParseArgsProperties}
	 * property.
	 * 
	 * @return The args-properties stored by the {@link ParseArgsProperties}
	 *         property.
	 */
	ParseArgsProperties getArgsParserProperties();

	/**
	 * Provides a mutator for a {@link ParseArgsProperties} property.
	 */
	public interface ArgsParserPropertiesMutator {

		/**
		 * Sets the args-properties for the {@link ParseArgsProperties}
		 * property.
		 * 
		 * @param aProperties The args-properties to be stored by the
		 *        {@link ParseArgsProperties} property.
		 */
		void setArgsParserProperties( ParseArgsProperties aProperties );
	}

	/**
	 * Provides a builder method for a {@link ParseArgsProperties} property
	 * returning the builder for applying multiple build operations.
	 * 
	 * @param  The builder to return in order to be able to apply multiple
	 *        build operations.
	 */
	public interface ArgsParserPropertiesBuilder> {

		/**
		 * Sets the args-properties for the {@link ParseArgsProperties}
		 * property.
		 * 
		 * @param aProperties The args-properties to be stored by the
		 *        {@link ParseArgsProperties} property.
		 * 
		 * @return The builder for applying multiple build operations.
		 */
		B withArgsParserProperties( ParseArgsProperties aProperties );
	}

	/**
	 * Provides a {@link ParseArgsProperties} property.
	 */
	public interface ArgsParserPropertiesProperty extends ArgsParserPropertiesAccessor, ArgsParserPropertiesMutator {

		/**
		 * This method stores and passes through the given argument, which is
		 * very useful for builder APIs: Sets the given
		 * {@link ParseArgsProperties} (setter) as of
		 * {@link #setArgsParserProperties(ParseArgsProperties)} and returns the
		 * very same value (getter).
		 * 
		 * @param aParseArgsProperties The {@link ParseArgsProperties} to set
		 *        (via {@link #setArgsParserProperties(ParseArgsProperties)}).
		 * 
		 * @return Returns the value passed for it to be used in conclusive
		 *         processing steps.
		 */
		default ParseArgsProperties letArgsParserProperties( ParseArgsProperties aParseArgsProperties ) {
			setArgsParserProperties( aParseArgsProperties );
			return aParseArgsProperties;
		}
	}
}