Package adams.core.io.filecomplete

Class AbstractFileCompleteCheck

java.lang.Object

adams.core.logging.LoggingObject

adams.core.logging.CustomLoggingLevelObject

adams.core.option.AbstractOptionHandler

adams.core.io.filecomplete.AbstractFileCompleteCheck

All Implemented Interfaces:

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

Direct Known Subclasses:

AbstractStrictFileCompleteCheck, JSON, NoCheck, XML

public abstract class AbstractFileCompleteCheck
extends AbstractOptionHandler

Ancestor for classes that check whether a file is complete.

Author:

FracPete (fracpete at waikato dot ac dot nz)

See Also:

Serialized Form

Field Summary

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
AbstractFileCompleteCheck()

Method Summary

Modifier and Type	Method	Description
abstract boolean	isComplete(byte[] buffer)	Checks whether the byte buffer is complete.
abstract boolean	isComplete(File file)	Checks whether the file is complete.
protected byte[]	read(File file, int pos, int num)	Reads the specified number of bytes from the file.

Methods inherited from class adams.core.option.AbstractOptionHandler

cleanUpOptions, defineOptions, destroy, finishInit, getDefaultLoggingLevel, getOptionManager, globalInfo, 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

Constructor Detail

AbstractFileCompleteCheck

public AbstractFileCompleteCheck()

Method Detail

isComplete

public abstract boolean isComplete(byte[] buffer)

Checks whether the byte buffer is complete.

Parameters:

buffer - the buffer to check

Returns:

true if complete

read

protected byte[] read(File file,
                      int pos,
                      int num)
               throws IOException

Reads the specified number of bytes from the file.

Parameters:

file - the file to read from

pos - the starting position, -1 if from end of file

num - the number of bytes to read

Returns:

the bytes

Throws:

IOException - if reading fails

isComplete

public abstract boolean isComplete(File file)

Checks whether the file is complete.

Parameters:

file - the file to check

Returns:

true if complete