public interface MaskingComponent
Modifier and Type | Field and Description |
---|---|
static char |
IDENTIFIER_SCOPING_SEPARATOR
The separator used to create fully scoped names of components, as pluginName + separator + componentName.
|
Modifier and Type | Method and Description |
---|---|
default boolean |
getAllowFurtherInstances()
Returns true if additional instances of this component may be created beyond those enumerated by
getDefaultInstances() . |
default java.util.Collection<MaskingComponent> |
getDefaultInstances()
Return a collection of objects that describe the default set of instances that should be created for this
component at plugin installation time.
|
default java.lang.String |
getDescription()
Get the short text description of this component.
|
default java.lang.String |
getDocumentation()
Get the full documentation for this component.
|
java.lang.String |
getName()
Get the recommended name of this Component.
|
default void |
setup(ComponentService serviceProvider)
Prepare this object for use.
|
default void |
tearDown()
Relinquish any resources this algorithm has acquired during its operation.
|
default void |
validate()
Requests that the component validate its configuration.
|
static final char IDENTIFIER_SCOPING_SEPARATOR
java.lang.String getName()
default java.lang.String getDescription()
default java.lang.String getDocumentation()
default java.util.Collection<MaskingComponent> getDefaultInstances()
getAllowFurtherInstances()
returns true.default boolean getAllowFurtherInstances()
getDefaultInstances()
.
Components for which this method returns true and that implement a MaskingAlgorithm interface are treated as
Algorithm Frameworks by the masking engine.default void validate() throws ComponentConfigurationException
ComponentConfigurationException
- Thrown when the component's configuration is found to be invaliddefault void setup(@Nonnull ComponentService serviceProvider)
serviceProvider
- The service provider objectdefault void tearDown()