com.couchbase.client.core.cnc.Context Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of core-io Show documentation

The official Couchbase JVM Core IO Library

There is a newer version: 2.7.0

/*
 * 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.json.Mapper;

import java.util.Map;
import java.util.function.Function;

/**
 * Context represents some state that is passed throughout the system.
 *
 * There are various stages of context that can extend or embed each other. The
 * important part is that it can be inspected and exported into other formats.
 */
public interface Context {

  /**
   * Export this context into the specified format.
   *
   * @param format the format to export into.
   * @return the exported format as a string representation.
   */
  String exportAsString(final ExportFormat format);

  /**
   * Export this context into a generic map.
   *
   * @return the exported format in a generic map representation.
   */
  Map exportAsMap();

  /**
   * The format into which the context can be exported.
   */
  @FunctionalInterface
  interface ExportFormat extends Function, String> {
    /**
     * Compact JSON.
     */
    ExportFormat JSON = Mapper::encodeAsString;

    /**
     * Verbose, Pretty JSON.
     */
    ExportFormat JSON_PRETTY = Mapper::encodeAsStringPretty;

    /**
     * Java "toString" basically.
     */
    ExportFormat STRING = Object::toString;
  }
}