org.apache.druid.query.context

Class ResponseContext.AbstractKey

java.lang.Object

org.apache.druid.query.context.ResponseContext.AbstractKey

All Implemented Interfaces:

ResponseContext.Key

Direct Known Subclasses:

ResponseContext.BooleanKey, ResponseContext.CounterKey, ResponseContext.LongKey, ResponseContext.StringKey

Enclosing class:

ResponseContext

public abstract static class ResponseContext.AbstractKey
extends Object
implements ResponseContext.Key

Abstract key class which provides most functionality except the type-specific merge logic. Parsing is provided by an associated parse function.

Method Summary

Modifier and Type	Method and Description
boolean	canDrop() Returns true if this key can be removed to reduce header size when the header would otherwise be too large.
String	getName()
boolean	includeInHeader() Whether to return the key, value pair in the response header.
Object	readValue(com.fasterxml.jackson.core.JsonParser jp) Reads a value of this key from a JSON stream.
String	toString()

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.apache.druid.query.context.ResponseContext.Key

mergeValues

Method Detail

getName

public String getName()

Specified by:

getName in interface ResponseContext.Key

includeInHeader

public boolean includeInHeader()

Description copied from interface: ResponseContext.Key

Whether to return the key, value pair in the response header. If false, the value is for internal use only.

Specified by:

includeInHeader in interface ResponseContext.Key

canDrop

public boolean canDrop()

Description copied from interface: ResponseContext.Key

Returns true if this key can be removed to reduce header size when the header would otherwise be too large.

Specified by:

canDrop in interface ResponseContext.Key

readValue

public Object readValue(com.fasterxml.jackson.core.JsonParser jp)

Description copied from interface: ResponseContext.Key

Reads a value of this key from a JSON stream. Used by ResponseContextDeserializer.

Specified by:

readValue in interface ResponseContext.Key

toString

public String toString()

Overrides:

toString in class Object