Package adams.core.io.filecomplete

Class BMP

java.lang.Object

adams.core.logging.LoggingObject

adams.core.logging.CustomLoggingLevelObject

adams.core.option.AbstractOptionHandler

adams.core.io.filecomplete.AbstractFileCompleteCheck

adams.core.io.filecomplete.AbstractStrictFileCompleteCheck

adams.core.io.filecomplete.BMP

All Implemented Interfaces:

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

public class BMP
extends AbstractStrictFileCompleteCheck

Checks whether the BMP file has sufficient bytes according to its header.
See also:
https://en.wikipedia.org/wiki/BMP_file_format#File_structure

-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
 

-strict <boolean> (property: strict)
    Whether to be strict or allow trailing junk data.
    default: true
 

Author:

FracPete (fracpete at waikato dot ac dot nz)

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
static int	MIN_BYTES

Fields inherited from class adams.core.io.filecomplete.AbstractStrictFileCompleteCheck

m_Strict

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

Method Summary

Modifier and Type	Method	Description
protected boolean	checkLength(byte[] buffer, long actLen)	Checks whether the length in the header works with the actual data length.
String	globalInfo()	Returns a string describing the object.
boolean	isComplete(byte[] buffer)	Checks whether the byte buffer is complete.
boolean	isComplete(File file)	Checks whether the file is in use.
String	strictTipText()	Returns the tip text for this property.

Methods inherited from class adams.core.io.filecomplete.AbstractStrictFileCompleteCheck

defineOptions, getStrict, setStrict

Methods inherited from class adams.core.io.filecomplete.AbstractFileCompleteCheck

read

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

MIN_BYTES

public static final int MIN_BYTES

See Also:

Constant Field Values

Constructor Detail

BMP

public BMP()

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

strictTipText

public String strictTipText()

Returns the tip text for this property.

Specified by:

strictTipText in class AbstractStrictFileCompleteCheck

Returns:

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

checkLength

protected boolean checkLength(byte[] buffer,
                              long actLen)

Checks whether the length in the header works with the actual data length.

Parameters:

buffer - the header

actLen - the actual amount of data

Returns:

true if valid

isComplete

public boolean isComplete(byte[] buffer)

Checks whether the byte buffer is complete.

Specified by:

isComplete in class AbstractFileCompleteCheck

Parameters:

buffer - the buffer to check

Returns:

true if complete

isComplete

public boolean isComplete(File file)

Checks whether the file is in use.

Specified by:

isComplete in class AbstractFileCompleteCheck

Parameters:

file - the file to check

Returns:

true if complete