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	Description
YamlProcessor()

Method Summary

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.

Methods inherited from class Object

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

Constructor Details

YamlProcessor

public YamlProcessor()

Method Details

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. If the transformation fails, the passed AsyncResult would be marked as failed. On success, the result contains the JsonObject.

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

Returns:

a future notified with the result