net.adamcin.oakpal.api

Interface ProgressCheckFactory

@ConsumerType
public interface ProgressCheckFactory

A factory for creating ProgressChecks that accepts a config map.

Since:

0.5.0

Method Summary

Modifier and Type	Method and Description
ProgressCheck	newInstance(javax.json.JsonObject config) Returns a new check with the provided config.

Method Detail

newInstance

ProgressCheck newInstance(javax.json.JsonObject config)
                   throws Exception

Returns a new check with the provided config. The JsonObject parameter type is used to enforce JSON-like semantics and communicate an informal contract that nested structures should be simple maps, collections, and Java primitives.

Parameters:

config - an arbitrary config object

Returns:

new ProgressCheck, optionally taking the provided config into account.

Throws:

Exception - for whatever reason instance creation fails.