org.refcodes.configuration.ext.console.ArgsParserPropertiesAccessor Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of refcodes-configuration-ext-console Show documentation

Artifact for providing event based extended functionality for the refcodes-configuration artifact.

There is a newer version: 2.0.5

Show newest version

// /////////////////////////////////////////////////////////////////////////////
// REFCODES.ORG
// =============================================================================
// This code is copyright (c) by Siegfried Steiner, Munich, Germany and licensed
// 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/LICENSE-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.configuration.ext.console;

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

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

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

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

	/**
	 * Provides a builder method for a {@link ArgsParserProperties} 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 ArgsParserProperties}
		 * property.
		 * 
		 * @param aProperties The args-properties to be stored by the
		 *        {@link ArgsParserProperties} property.
		 * 
		 * @return The builder for applying multiple build operations.
		 */
		B withArgsParserProperties( ArgsParserProperties aProperties );
	}

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