org.refcodes.filesystem.FileHandleAccessor Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of refcodes-filesystem Show documentation

Artifact for the refcodes virtual file system design.

There is a newer version: 3.3.9

// /////////////////////////////////////////////////////////////////////////////
// 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.filesystem;

/**
 * Provides an accessor for a {@link FileHandle} property.
 */
public interface FileHandleAccessor {

	/**
	 * Retrieves the file handle from the file property.
	 * 
	 * @return The file handle stored by the file handle property.
	 */
	FileHandle getFile();

	/**
	 * Provides a mutator for a {@link FileHandle} property.
	 */
	public interface FileHandleMutator {

		/**
		 * Sets the file handle for the file handle property.
		 * 
		 * @param aFile The file handle to be stored by the file handle
		 *        property.
		 */
		void setFile( String aFile );
	}

	/**
	 * Provides a {@link FileHandle} property.
	 */
	public interface FileHandleProperty extends FileHandleAccessor, FileHandleMutator {}
}