Class AbstractCommand

java.lang.Object

org.tasktide.core.manager.command.commands.AbstractCommand

All Implemented Interfaces:

ManagerCommand

Direct Known Subclasses:

AnnotateCommand, DeleteCommand, ExportCommand, ImportCommand, ResetCommand, SummarizeCommand

public abstract class AbstractCommand
extends Object
implements ManagerCommand

Abstract class to wrap standardize class fields across manager commands, getters/setters etc, JSON (de)serialization, wraps the execution process with a validation step. Since ManagerCommand can be built, and returned as that interface, this abstract carries a lot of useful foundational work on behalf of the implementing classes which they all can use, without stepping into the complexity of them.

Field Summary

Fields

Modifier and Type	Field	Description
protected final ManagerAction	action
protected final CommandSpec	cmdSpec
protected final CommandType	cmdType
protected final ManagerTarget	target

Constructor Summary

Constructors

Constructor	Description
AbstractCommand(ManagerAction action, ManagerTarget target, CommandSpec cmdSpec, CommandType cmdType)	Construct with requriements

Method Summary

Modifier and Type	Method	Description
Object	execute()	Execution is wrapped into the abstract validation, then runCommand calls
ManagerAction	getAction()	Get configured action for command
CommandSpec	getCmdSpec()	Get command specifications for task
CommandType	getCmdType()	Get CommandType of ManagerAction taken against the TaskTideRepository
ManagerTarget	getTarget()	Get target for command
abstract Object	runCommand()	Defines how a concrete ManagerCommand executes a validated command
String	toJsonDoc()	Represent as JSON document
String	toJsonString()	Represent as JSON string
String	toString()	Represent as string

Methods inherited from class Object

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

Methods inherited from interface ManagerCommand

validateCommand

Field Details

action

protected final ManagerAction action

target

protected final ManagerTarget target

cmdSpec

protected final CommandSpec cmdSpec

cmdType

protected final CommandType cmdType

Constructor Details

AbstractCommand

public AbstractCommand(ManagerAction action,
 ManagerTarget target,
 CommandSpec cmdSpec,
 CommandType cmdType)

Construct with requriements

Parameters:

action -

target -

cmdSpec -

cmdType -

Method Details

execute

public Object execute()

Execution is wrapped into the abstract validation, then runCommand calls

Specified by:

execute in interface ManagerCommand

Returns:

boolean

runCommand

public abstract Object runCommand()

Defines how a concrete ManagerCommand executes a validated command

Returns:

Object

getAction

public ManagerAction getAction()

Get configured action for command

Returns:

ManagerAction

getTarget

public ManagerTarget getTarget()

Get target for command

Returns:

ManagerTarget

getCmdSpec

public CommandSpec getCmdSpec()

Get command specifications for task

Returns:

CommandSpec

getCmdType

public CommandType getCmdType()

Get CommandType of ManagerAction taken against the TaskTideRepository

Returns:

CommandType

toJsonString

public String toJsonString()

Represent as JSON string

Specified by:

toJsonString in interface ManagerCommand

Returns:

String

toJsonDoc

public String toJsonDoc()

Represent as JSON document

Specified by:

toJsonDoc in interface ManagerCommand

Returns:

String

toString

public String toString()

Represent as string

Overrides:

toString in class Object

Returns:

String