ConfigurationProvider 24.12.0 API

All Implemented Interfaces:


public interface ConfigurationProvider

Configuration provider contract.

Nested Class Summary

Nested Classes
Modifier and Type	Class	Description

Field Summary

Fields
Modifier and Type	Field	Description

Constructor Summary

Constructors
Constructor	Description

Enum Constant Summary

Enum Constants
Enum Constant	Description

Method Summary

Modifier and Type	Method	Description
`abstract ProviderIdentifier`	`getProviderIdentifier()`	Gets the identifier string for this provider.
`abstract ProviderInputs`	`getExpectedInput()`	Gets a ProviderInputs object the represents this provider's expected inputs.
`abstract ProviderConfiguration`	`provideConfiguration(@NonNull() ProviderInputs input)`	Method to retrieve the configuration data from this provider.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
- Method Detail
  - getProviderIdentifier
```
@NonNull() abstract ProviderIdentifier getProviderIdentifier()
```
    Gets the identifier string for this provider.
    
    Returns:
    
    ProviderIdentifier that identifies this provider.
  - getExpectedInput
```
@NonNull() abstract ProviderInputs getExpectedInput()
```
    Gets a ProviderInputs object the represents this provider's expected inputs.
    
    Returns:
    
    A ProviderInputs object containing the keys of the inputs expected by this provider. An empty ProviderInputs is returned when no input is required.
  - provideConfiguration
```
@NonNull() abstract ProviderConfiguration provideConfiguration(@NonNull() ProviderInputs input)
```
    Method to retrieve the configuration data from this provider.
    
    Parameters:
    
    input - A ProviderInputs object containing user input, if any, for this provider.
    
    Returns:
    
    A ProviderConfiguration object representing the result of this attempt.