org.refcodes.checkerboard.BackgroundFactoryAccessor Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of refcodes-checkerboard Show documentation
Artifact for providing some easy means to visualize (state of) board games or (state of) cellular automatons.
There is a newer version: 3.3.8
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/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.checkerboard;

/**
 * Provides an accessor for a background factory property.
 *
 * @param  the generic type of the according {@link BackgroundFactory}.
 */
public interface BackgroundFactoryAccessor> {

	/**
	 * Retrieves the background factory from the background factory property.
	 * 
	 * @return The background factory stored by the background factory property.
	 */
	BF getBackgroundFactory();

	/**
	 * Provides a mutator for a background factory property.
	 *
	 * @param  the generic type
	 */
	public interface BackgroundFactoryMutator> {

		/**
		 * Sets the background factory for the background factory property.
		 * 
		 * @param aBackgroundFactory The background factory to be stored by the
		 *        background factory property.
		 */
		void setBackgroundFactory( BF aBackgroundFactory );
	}

	/**
	 * Provides a builder method for a background factory property returning the
	 * builder for applying multiple build operations.
	 *
	 * @param  the generic type
	 * @param  The builder to return in order to be able to apply multiple
	 *        build operations.
	 */
	public interface BackgroundFactoryBuilder, B extends BackgroundFactoryBuilder> {

		/**
		 * Sets the background factory for the background factory property.
		 * 
		 * @param aBackgroundFactory The background factory to be stored by the
		 *        background factory property.
		 * 
		 * @return The builder for applying multiple build operations.
		 */
		B withBackgroundFactory( BF aBackgroundFactory );
	}

	/**
	 * Provides a background factory property.
	 *
	 * @param  the generic type
	 */
	public interface BackgroundFactoryProperty> extends BackgroundFactoryAccessor, BackgroundFactoryMutator {

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