com.deltaxml.cores9api.config.moves

Class MoveDetectionConfig

java.lang.Object

com.deltaxml.cores9api.config.moves.MoveDetectionConfig

public class MoveDetectionConfig
extends java.lang.Object

This class configures move detection.

Constructor Summary

Constructors

Constructor and Description
MoveDetectionConfig() Initialise a MoveDetectionConfig without params.
MoveDetectionConfig(java.util.List<MoveCandidate> moveCandidates) Initialises an unrestricted MoveDetectionConfig with a list of move candidates.
MoveDetectionConfig(MoveDetectionType moveDetectionType, java.util.List<MoveCandidate> moveCandidates) Initialises a MoveDetectionConfig for given parameters.

Method Summary

Modifier and Type	Method and Description
java.util.List<MoveCandidate>	getMoveCandidates() Gets the list of MoveCandidates.
MoveDetectionType	getMoveDetectionType() Gets the MoveDetectionType value.
boolean	getShowMoveSource() Gets the value for showMoveSource.
boolean	isEnabled() Query if move processing is enabled.
void	setEnabled(boolean enabled) Enable or disable move processing.
void	setMoveCandidates(java.util.List<MoveCandidate> moveCandidates) Sets the list of MoveCandidates.
void	setMoveDetectionType(MoveDetectionType moveDetectionType) Sets the moveDetectionType.
void	setShowMoveSource(boolean showMoveSource) Sets showMoveSource.

Methods inherited from class java.lang.Object

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

Constructor Detail

MoveDetectionConfig

public MoveDetectionConfig()

Initialise a MoveDetectionConfig without params. Will default to unrestricted move detection and an empty list of move candidates.

MoveDetectionConfig

public MoveDetectionConfig(java.util.List<MoveCandidate> moveCandidates)

Initialises an unrestricted MoveDetectionConfig with a list of move candidates.

Parameters:

moveCandidates - A list of MoveCandidate objects.

MoveDetectionConfig

public MoveDetectionConfig(MoveDetectionType moveDetectionType,
                           java.util.List<MoveCandidate> moveCandidates)

Initialises a MoveDetectionConfig for given parameters.

Parameters:

moveDetectionType - Move detection type as defined in the MoveDetectionType enum.

moveCandidates - A list of MoveCandidate objects.

Method Detail

isEnabled

public boolean isEnabled()

Query if move processing is enabled.

Returns:

a boolean where true represents enabled, false represents disabled.

setEnabled

public void setEnabled(boolean enabled)

Enable or disable move processing.

Parameters:

enabled - Set to true to enable and false to disable moves processing.

getMoveCandidates

public java.util.List<MoveCandidate> getMoveCandidates()

Gets the list of MoveCandidates.

Returns:

List of MoveCandidates.

setMoveCandidates

public void setMoveCandidates(java.util.List<MoveCandidate> moveCandidates)

Sets the list of MoveCandidates.

Parameters:

moveCandidates - The List of MoveCandidates to be set.

getShowMoveSource

public boolean getShowMoveSource()

Gets the value for showMoveSource.

Returns:

showMoveSource boolean value.

setShowMoveSource

public void setShowMoveSource(boolean showMoveSource)

Sets showMoveSource.

Parameters:

showMoveSource - Boolean value to be set to showMoveSource.

getMoveDetectionType

public MoveDetectionType getMoveDetectionType()

Gets the MoveDetectionType value.

Returns:

Move detection type as defined the MoveDetectionType enumeration.

setMoveDetectionType

public void setMoveDetectionType(MoveDetectionType moveDetectionType)

Sets the moveDetectionType.

Parameters:

moveDetectionType - Move detection type as defined the MoveDetectionType enumeration.