org.refcodes.component.Decomposeable Maven / Gradle / Ivy
Show all versions of refcodes-component Show documentation
// /////////////////////////////////////////////////////////////////////////////
// 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;
/**
* This mixin might be implemented by a component in order to provide
* decomposition facilities. No exception is thrown as decomposition must work
* always!
*
* The "decompose()" method {@link Decomposeable#decompose()} differs from the
* "destroy()" method {@link Destroyable#destroy()} in that "destroy()" shuts
* down the component in memory, whereas "decompose()" also tears down external
* resources such as files or DB schemas. This means that with "decompose()" all
* external data will be lost, as with "destroy()" external data will be kept
* (in terms that it makes sense for the actual implementation).
*/
public interface Decomposeable {
/**
* Decomposes the component. External resources might get deleted (such as
* files or DB schemas)!
*/
void decompose();
/**
* The {@link DecomposeAutomaton} interface defines those methods related to
* the decompose life-cycle.
*/
public interface DecomposeAutomaton extends Decomposeable {
/**
* Determines whether the component may get decomposed.
*
* @return True if {@link #decompose()} is possible.
*/
boolean isDecomposeable();
/**
* Determines whether the component is decomposed.
*
* @return True in case of being decomposed, else false.
*/
boolean isDecomposed();
}
}