Package adams.core.io.fileuse

Class FileIncomplete

java.lang.Object

adams.core.logging.LoggingObject

adams.core.logging.CustomLoggingLevelObject

adams.core.option.AbstractOptionHandler

adams.core.io.fileuse.AbstractFileUseCheck

adams.core.io.fileuse.FileIncomplete

All Implemented Interfaces:

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

public class FileIncomplete
extends AbstractFileUseCheck

Assumes the file to be in use when not complete, i.e., still being written.

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

-check <adams.core.io.filecomplete.AbstractFileCompleteCheck> (property: check)
    The check scheme to use for checking the 'in use' state (incomplete -> in
    use).
    default: adams.core.io.filecomplete.NoCheck
 

Author:

fracpete (fracpete at waikato dot ac dot nz)

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
protected AbstractFileCompleteCheck	m_Check	the check 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
FileIncomplete()

Method Summary

Modifier and Type	Method	Description
String	checkTipText()	Returns the tip text for this property.
void	defineOptions()	Adds options to the internal list of options.
AbstractFileCompleteCheck	getCheck()	Returns the file check to use for checking the completeness.
String	globalInfo()	Returns a string describing the object.
boolean	isInUse(File file)	Checks whether the file is in use.
void	setCheck(AbstractFileCompleteCheck value)	Sets the file check to use for checking the completeness.

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_Check

protected AbstractFileCompleteCheck m_Check

the check to use.

Constructor Detail

FileIncomplete

public FileIncomplete()

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

setCheck

public void setCheck(AbstractFileCompleteCheck value)

Sets the file check to use for checking the completeness.

Parameters:

value - the check

getCheck

public AbstractFileCompleteCheck getCheck()

Returns the file check to use for checking the completeness.

Returns:

the check

checkTipText

public String checkTipText()

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