io.vertx.config.yaml

## Class YamlProcessor

- java.lang.Object
- - io.vertx.config.yaml.YamlProcessor

- All Implemented Interfaces:
    ConfigProcessor

      public class YamlProcessor
      extends Object
      implements ConfigProcessor

  A processor using Jackson and SnakeYaml to read Yaml files.
  Author:
    Clement Escoffier

- - ### Constructor Summary

    Constructors
    Constructor and Description
    `YamlProcessor()`

  - ### Method Summary

    All Methods Instance Methods Concrete Methods
    Modifier and Type | Method and 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`.

    - ### Methods inherited from class java.lang.Object

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

    - ### Methods inherited from interface io.vertx.config.spi.ConfigProcessor

      `process`

- - ### Constructor Detail

    - #### YamlProcessor

          public YamlProcessor()

  - ### Method Detail

    - #### name

          public String name()

      Description copied from interface: `ConfigProcessor`
      Name of the processor, generally the name of the format it handles.
      Specified by:
        `name` in interface `ConfigProcessor`
      Returns:
        the name

    - #### process

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

      Description copied from interface: `ConfigProcessor`
      Transforms the given `input` into a `JsonObject`.

      This is an asynchronous non-blocking transformation.

      Specified by:
        `process` in interface `ConfigProcessor`
      Parameters:
        `vertx` - the Vert.x instance
        `configuration` - the processor configuration, may be `null`
        `input` - the input, must not be `null`

Copyright © 2023 Eclipse. All rights reserved.