Package uk.gov.gchq.gaffer.federated.simple.operation

Class RemoveGraph

java.lang.Object

uk.gov.gchq.gaffer.federated.simple.operation.RemoveGraph

All Implemented Interfaces:

Closeable, AutoCloseable, Operation

public class RemoveGraph
extends Object
implements Operation

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	RemoveGraph.Builder

Nested classes/interfaces inherited from interface uk.gov.gchq.gaffer.operation.Operation

Operation.BaseBuilder<OP extends Operation,B extends Operation.BaseBuilder<OP,?>>

Constructor Summary

Constructors

Constructor	Description
RemoveGraph()

Method Summary

Modifier and Type	Method	Description
boolean	getDeleteAllData()	Get whether to delete all the data.
String	getGraphId()	Get the graph ID of the graph to remove.
Map<String,String>	getOptions()
void	setDeleteAllData(boolean deleteAllData)	Set whether to delete all data as well.
void	setGraphId(String graphId)	Set the graph ID of the graph to remove.
void	setOptions(Map<String,String> options)
Operation	shallowClone()	Operation implementations should ensure a ShallowClone method is implemented.

Methods inherited from class java.lang.Object

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

Methods inherited from interface uk.gov.gchq.gaffer.operation.Operation

_getNullOrOptions, addOption, close, containsOption, getOption, getOption, validate, validateRequiredFieldPresent

Constructor Detail

RemoveGraph

public RemoveGraph()

Method Detail

getGraphId

public String getGraphId()

Get the graph ID of the graph to remove.

Returns:

The graph ID.

getDeleteAllData

public boolean getDeleteAllData()

Get whether to delete all the data.

Returns:

True if deleting all.

setGraphId

public void setGraphId(String graphId)

Set the graph ID of the graph to remove.

Parameters:

graphId - The graph ID.

setDeleteAllData

public void setDeleteAllData(boolean deleteAllData)

Set whether to delete all data as well.

Parameters:

deleteAllData - Delete all.

getOptions

public Map<String,String> getOptions()

Specified by:

getOptions in interface Operation

Returns:

the operation options. This may contain store specific options such as authorisation strings or and other properties required for the operation to be executed. Note these options will probably not be interpreted in the same way by every store implementation.

setOptions

public void setOptions(Map<String,String> options)

Specified by:

setOptions in interface Operation

Parameters:

options - the operation options. This may contain store specific options such as authorisation strings or and other properties required for the operation to be executed. Note these options will probably not be interpreted in the same way by every store implementation.

shallowClone

public Operation shallowClone()
                       throws org.apache.commons.lang3.exception.CloneFailedException

Description copied from interface: Operation

Operation implementations should ensure a ShallowClone method is implemented. Performs a shallow clone. Creates a new instance and copies the fields across. It does not clone the fields. If the operation contains nested operations, these must also be cloned.

Specified by:

shallowClone in interface Operation

Returns:

shallow clone

Throws:

org.apache.commons.lang3.exception.CloneFailedException - if a Clone error occurs