Package 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 Description YamlProcessor()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description Stringname()Name of the processor, generally the name of the format it handles.Future<JsonObject>process(Vertx vertx, JsonObject configuration, Buffer input)Transforms the giveninputinto aJsonObject.
-
-
-
Method Detail
-
name
public String name()
Description copied from interface:ConfigProcessorName of the processor, generally the name of the format it handles.- Specified by:
namein interfaceConfigProcessor- Returns:
- the name
-
process
public Future<JsonObject> process(Vertx vertx, JsonObject configuration, Buffer input)
Description copied from interface:ConfigProcessorTransforms the giveninputinto aJsonObject. This is an asynchronous non-blocking transformation. If the transformation fails, the passedAsyncResultwould be marked as failed. On success, the result contains theJsonObject.- Specified by:
processin interfaceConfigProcessor- Parameters:
vertx- the Vert.x instanceconfiguration- the processor configuration, may benullinput- the input, must not benull- Returns:
- a future notified with the result
-
-