ConfigParameterInfo (Ametys 4.3.x - API)

java.lang.Object
- org.ametys.runtime.config.ConfigParameterInfo

public class ConfigParameterInfo
extends Object

Information on a configuration parameter.

Field Summary

Fields
Modifier and Type Field Description

private Configuration _conf

private String _id

private String _pluginName

Constructor Summary

Constructors
Constructor Description

ConfigParameterInfo(String id, String pluginName, Configuration conf)
Create a configuration parameter info.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`Configuration`	`getConfiguration()`	Get the declaring configuration.
`String`	`getId()`	Get the parameter ID.
`String`	`getPluginName()`	Get the declaring plugin name.

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

- Field Detail
  - _id
```
private final String _id
```
  - _pluginName
```
private final String _pluginName
```
  - _conf
```
private final Configuration _conf
```
- Constructor Detail
  - ConfigParameterInfo
```
public ConfigParameterInfo(String id,
                           String pluginName,
                           Configuration conf)
```
    Create a configuration parameter info.
    
    Parameters:
    
    id - the parameter id.
    
    pluginName - the declaring plugin name.
    
    conf - the configuration.
- Method Detail
  - getId
```
public String getId()
```
    Get the parameter ID.
    
    Returns:
    
    the parameter ID.
  - getPluginName
```
public String getPluginName()
```
    Get the declaring plugin name.
    
    Returns:
    
    the declaring plugin name.
  - getConfiguration
```
public Configuration getConfiguration()
```
    Get the declaring configuration.
    
    Returns:
    
    the declaring configuration.