Package com.couchbase.client.core.cnc

Class AbstractContext

java.lang.Object

com.couchbase.client.core.cnc.AbstractContext

All Implemented Interfaces:

Context

Direct Known Subclasses:

CoreContext, ErrorContext, ProtostellarContext, RangeScanContext, WaitUntilReadyContext

public abstract class AbstractContext
extends Object
implements Context

Common parent method for all contexts.

Contexts are encouraged to derive from this abstract class because all they have to do then is to implement/override injectExportableParams(Map) and feed the data they want to be extracted. The actual extraction and formatting then comes for free.

Nested Class Summary

Nested classes/interfaces inherited from interface com.couchbase.client.core.cnc.Context

Context.ExportFormat

Constructor Summary

Constructors

Constructor	Description
AbstractContext()

Method Summary

Modifier and Type	Method	Description
Map<String,Object>	exportAsMap()	Export this context into a generic map.
String	exportAsString(Context.ExportFormat format)	Export this context into the specified format.
void	injectExportableParams(Map<String,Object> input)	This method needs to be implemented by the actual context implementations to inject the params they need for exporting.
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Details

AbstractContext

public AbstractContext()

Method Details

injectExportableParams

public void injectExportableParams(Map<String,Object> input)

This method needs to be implemented by the actual context implementations to inject the params they need for exporting.

Parameters:

input - pass exportable params in here.

exportAsString

public String exportAsString(Context.ExportFormat format)

Description copied from interface: Context

Export this context into the specified format.

Specified by:

exportAsString in interface Context

Parameters:

format - the format to export into.

Returns:

the exported format as a string representation.

exportAsMap

public Map<String,Object> exportAsMap()

Description copied from interface: Context

Export this context into a generic map.

Specified by:

exportAsMap in interface Context

Returns:

the exported format in a generic map representation.

toString

public String toString()

Overrides:

toString in class Object