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

Go to download
Show more of this group Show more artifacts with this name
Show all versions of refcodes-mixin Show documentation
Artifact for mixins of general interest.
There is a newer version: 3.3.8
// /////////////////////////////////////////////////////////////////////////////
// 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 code property for e.g. key / code pair.
 *
 * @param  The type of the code to be used.
 */
public interface CodeAccessor {

	/**
	 * Retrieves the code from the code property.
	 * 
	 * @return The code stored by the code property.
	 */
	T getCode();

	/**
	 * Extends the {@link CodeAccessor} with a setter method.
	 * 
	 * @param  The type of the code property.
	 */
	public interface CodeMutator {

		/**
		 * Sets the code for the code property.
		 * 
		 * @param aCode The code to be stored by the code property.
		 */
		void setCode( V aCode );

	}
	
	/**
	 * Provides a builder method for a the 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 CodeBuilder> {

		/**
		 * Sets the code for the the property.
		 * 
		 * @param aCode The code to be stored by the code property.
		 * 
		 * @return The builder for applying multiple build operations.
		 */
		B withCode( V aCode );
	}

	/**
	 * Extends the {@link CodeAccessor} with a setter method.
	 * 
	 * @param  The type of the code property.
	 */
	public interface CodeProperty extends CodeAccessor, CodeMutator {}
}