org.refcodes.component.ClosedAccessor 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.component;

/**
 * Provides an accessor for a closed property.
 */
public interface ClosedAccessor {

	/**
	 * Retrieves the is-closed status. Determines whether the component's
	 * connection is closed. A component's connection is closed after being
	 * closed as of {@link Closable#close()}.
	 * 
	 * @return True in case of being closed.
	 */
	boolean isClosed();

	/**
	 * Provides a mutator for a closed property.
	 */
	public interface ClosedMutator {

		/**
		 * Sets the is-closed property for the closed property.
		 * 
		 * @param isClosed The closed property to be stored by the closed
		 *        property.
		 */
		void setClosed( boolean isClosed );
	}

	/**
	 * Provides a closed property.
	 */
	public interface ClosedProperty extends ClosedAccessor, ClosedMutator {}
}