com.couchbase.client.core.cnc.AbstractContext Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of core-io Show documentation
Show all versions of core-io Show documentation
The official Couchbase JVM Core IO Library
/*
* Copyright (c) 2018 Couchbase, Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package com.couchbase.client.core.cnc;
import com.couchbase.client.core.deps.com.fasterxml.jackson.core.type.TypeReference;
import com.couchbase.client.core.json.Mapper;
import java.util.Map;
import java.util.TreeMap;
/**
* 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 {@link #injectExportableParams(Map)} and feed
* the data they want to be extracted. The actual extraction and formatting then
* comes for free.
*/
public abstract class AbstractContext implements Context {
/**
* This method needs to be implemented by the actual context implementations to
* inject the params they need for exporting.
*
* @param input pass exportable params in here.
*/
public void injectExportableParams(final Map input) {}
@Override
public String exportAsString(final ExportFormat format) {
Map input = new TreeMap<>();
injectExportableParams(input);
return format.apply(input);
}
@Override
public Map exportAsMap() {
// Note: we round-trip to JSON as an easy way to "deep copy" the context and as a result
// avoid situations where a user modifies it by accident.
return Mapper.decodeInto(exportAsString(ExportFormat.JSON), new TypeReference