Package adams.core.io.fileuse

Class MultiCheck

java.lang.Object

adams.core.logging.LoggingObject

adams.core.logging.CustomLoggingLevelObject

adams.core.option.AbstractOptionHandler

adams.core.io.fileuse.AbstractFileUseCheck

adams.core.io.fileuse.MultiCheck

All Implemented Interfaces:

Destroyable, GlobalInfoSupporter, LoggingLevelHandler, LoggingSupporter, OptionHandler, SizeOfHandler, Serializable

public class MultiCheck
extends AbstractFileUseCheck

Applies the specified checks sequentially, stops as soon one of them returns that the file is 'in use'.

-logging-level <OFF|SEVERE|WARNING|INFO|CONFIG|FINE|FINER|FINEST> (property: loggingLevel)
    The logging level for outputting errors and debugging output.
    default: WARNING
 

-check <adams.core.io.fileuse.AbstractFileUseCheck> [-check ...] (property: checks)
    The schemes to use for checking the 'in use' state.
    default: 
 

Version:

$Revision$

Author:

FracPete (fracpete at waikato dot ac dot nz)

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
protected AbstractFileUseCheck[]	m_Checks	the checks to use.

Fields inherited from class adams.core.option.AbstractOptionHandler

m_OptionManager

Fields inherited from class adams.core.logging.LoggingObject

m_Logger, m_LoggingIsEnabled, m_LoggingLevel

Constructor Summary

Constructors

Constructor	Description
MultiCheck()

Method Summary

Modifier and Type	Method	Description
String	checksTipText()	Returns the tip text for this property.
void	defineOptions()	Adds options to the internal list of options.
AbstractFileUseCheck[]	getChecks()	Returns the check schemes to use.
String	globalInfo()	Returns a string describing the object.
boolean	isInUse(File file)	Checks whether the file is in use.
void	setChecks(AbstractFileUseCheck[] value)	Sets the check schemes to use.

Methods inherited from class adams.core.option.AbstractOptionHandler

cleanUpOptions, destroy, finishInit, getDefaultLoggingLevel, getOptionManager, initialize, loggingLevelTipText, newOptionManager, reset, setLoggingLevel, toCommandLine, toString

Methods inherited from class adams.core.logging.LoggingObject

configureLogger, getLogger, getLoggingLevel, initializeLogging, isLoggingEnabled, sizeOf

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface adams.core.logging.LoggingLevelHandler

getLoggingLevel

Field Detail

m_Checks

protected AbstractFileUseCheck[] m_Checks

the checks to use.

Constructor Detail

MultiCheck

public MultiCheck()

Method Detail

globalInfo

public String globalInfo()

Returns a string describing the object.

Specified by:

globalInfo in interface GlobalInfoSupporter

Specified by:

globalInfo in class AbstractOptionHandler

Returns:

a description suitable for displaying in the gui

defineOptions

public void defineOptions()

Adds options to the internal list of options.

Specified by:

defineOptions in interface OptionHandler

Overrides:

defineOptions in class AbstractOptionHandler

setChecks

public void setChecks(AbstractFileUseCheck[] value)

Sets the check schemes to use.

Parameters:

value - the checks

getChecks

public AbstractFileUseCheck[] getChecks()

Returns the check schemes to use.

Returns:

the checks

checksTipText

public String checksTipText()

Returns the tip text for this property.

Returns:

tip text for this property suitable for displaying in the GUI or for listing the options.

isInUse

public boolean isInUse(File file)

Checks whether the file is in use.

Specified by:

isInUse in class AbstractFileUseCheck

Parameters:

file - the file to check

Returns:

true if in use