Package uk.gov.gchq.gaffer.store.operation

Class GetTraits

java.lang.Object

uk.gov.gchq.gaffer.store.operation.GetTraits

All Implemented Interfaces:

Closeable, AutoCloseable, Output<Set<StoreTrait>>, Operation

public class GetTraits
extends Object
implements Operation, Output<Set<StoreTrait>>

An Operation used for getting traits from the Store.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	GetTraits.Builder

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

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

Field Summary

Fields

Modifier and Type	Field	Description
static boolean	DEFAULT_CURRENT_TRAITS

Constructor Summary

Constructors

Constructor	Description
GetTraits()

Method Summary

Modifier and Type	Method	Description
Map<String,String>	getOptions()
com.fasterxml.jackson.core.type.TypeReference<Set<StoreTrait>>	getOutputTypeReference()
boolean	isCurrentTraits()
void	setCurrentTraits(boolean currentTraits)
void	setOptions(Map<String,String> options)
GetTraits	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

Methods inherited from interface uk.gov.gchq.gaffer.operation.io.Output

castToOutputType, getOutputClass, getOutputType

Field Detail

DEFAULT_CURRENT_TRAITS

public static final boolean DEFAULT_CURRENT_TRAITS

See Also:

Constant Field Values

Constructor Detail

GetTraits

public GetTraits()

Method Detail

shallowClone

public GetTraits 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

isCurrentTraits

public boolean isCurrentTraits()

setCurrentTraits

public void setCurrentTraits(boolean currentTraits)

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.

getOutputTypeReference

public com.fasterxml.jackson.core.type.TypeReference<Set<StoreTrait>> getOutputTypeReference()

Specified by:

getOutputTypeReference in interface Output<Set<StoreTrait>>