Package io.vertx.config.spi
Interface ConfigProcessor
-
- All Known Implementing Classes:
HoconProcessor,YamlProcessor
public interface ConfigProcessorA processor transforms a chunk of configuration retrieved from a configuration store as aBufferto aJsonObject.- Author:
- Clement Escoffier
-
-
Method Summary
All Methods Instance Methods Abstract 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
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 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.- Parameters:
vertx- the Vert.x instanceconfiguration- the processor configuration, may benullinput- the input, must not benull- Returns:
- a future notified with the result
-
-