org.refcodes.mixin.StateAccessor Maven / Gradle / Ivy

Go to download
// /////////////////////////////////////////////////////////////////////////////
// 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.mixin;

/**
 * Provides access to a statusCode property for e.g. key / statusCode pair.
 *
 * @param  The type of the state to be used.
 */
public interface StateAccessor {

	/**
	 * Retrieves the state from the statusCode property.
	 * 
	 * @return The statusCode stored by the state property.
	 */
	S getState();

	/**
	 * Extends the {@link StateAccessor} with a setter method.
	 * 
	 * @param  The type of the statusCode property.
	 */
	public interface StateMutator {

		/**
		 * Sets the statusCode for the state property.
		 * 
		 * @param aState The state to be stored by the state property.
		 */
		void setState( S aState );

	}

	/**
	 * Provides a builder method for a state property returning the builder for
	 * applying multiple build operations.
	 * 
	 * @param  The type of the state to be used.
	 * @param  The builder to return in order to be able to apply multiple
	 *        build operations.
	 */
	public interface StateBuilder> {

		/**
		 * Sets the state for the state property.
		 * 
		 * @param aState The state to be stored by the state property.
		 * 
		 * @return The builder for applying multiple build operations.
		 */
		B withState( S aState );
	}

	/**
	 * Extends the {@link StateAccessor} with a setter method.
	 * 
	 * @param  The type of the state property.
	 */
	public interface StateProperty extends StateAccessor, StateMutator {}
}