Package io.vertx.config.spi

## Interface ConfigProcessor

- All Known Implementing Classes:
    `HoconProcessor`, `YamlProcessor`

      public interface ConfigProcessor

  A processor transforms a chunk of configuration retrieved from a configuration store as a `Buffer` to a `JsonObject`.
  Author:
    Clement Escoffier

- - ### Method Summary

    All Methods Instance Methods Abstract Methods
    Modifier and Type | Method | Description
    --- | --- | ---
    `String` | `name()` | Name of the processor, generally the name of the format it handles.
    `Future<JsonObject>` | `process​(Vertx vertx, JsonObject configuration, Buffer input)` | Transforms the given `input` into a `JsonObject`.

- - ### Method Detail

    - #### name

          String name()

      Name of the processor, generally the name of the format it handles.
      Returns:
        the name

    - #### process

          Future<JsonObject> process​(Vertx vertx,
                                     JsonObject configuration,
                                     Buffer input)

      Transforms the given `input` into a `JsonObject`. This is an asynchronous non-blocking transformation. If the transformation fails, the passed `AsyncResult` would be marked as failed. On success, the result contains the `JsonObject`.
      Parameters:
        `vertx` - the Vert.x instance
        `configuration` - the processor configuration, may be `null`
        `input` - the input, must not be `null`
      Returns:
        a future notified with the result