uk.ac.starlink.ttools.mode

Class ChecksumMode

java.lang.Object

uk.ac.starlink.ttools.mode.ChecksumMode

All Implemented Interfaces:

ProcessingMode

public class ChecksumMode
extends Object
implements ProcessingMode

Processing mode for calculating a checksum of table data.

Since:

31 Aug 2021

Author:

Mark Taylor

Constructor Summary

Constructors

Constructor and Description
ChecksumMode()
ChecksumMode(java.util.function.Supplier<Checksum> checksumFactory)

Method Summary

Modifier and Type	Method and Description
TableConsumer	createConsumer(Environment env) Creates a TableConsumer, deriving any additional required configuration from a given environment.
Parameter<?>[]	getAssociatedParameters() Returns a list of any parameters which are associated with this mode.
String	getDescription() Returns a textual description of this processing mode.

Methods inherited from class java.lang.Object

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

Constructor Detail

ChecksumMode

public ChecksumMode()

ChecksumMode

public ChecksumMode(java.util.function.Supplier<Checksum> checksumFactory)

Method Detail

getDescription

public String getDescription()

Description copied from interface: ProcessingMode

Returns a textual description of this processing mode. This will be included in the user document so should be in XML.

Specified by:

getDescription in interface ProcessingMode

Returns:

textual description of this mode

getAssociatedParameters

public Parameter<?>[] getAssociatedParameters()

Description copied from interface: ProcessingMode

Returns a list of any parameters which are associated with this mode.

Specified by:

getAssociatedParameters in interface ProcessingMode

Returns:

parameter list

createConsumer

public TableConsumer createConsumer(Environment env)

Description copied from interface: ProcessingMode

Creates a TableConsumer, deriving any additional required configuration from a given environment.

Specified by:

createConsumer in interface ProcessingMode

Parameters:

env - execution environment