org.lsst.ccs.config

Interface HasConfigurationParameterDescription

public interface HasConfigurationParameterDescription

Interface to be implemented by classes that wish to overwrite the configuration parameter description as specified by the ConfigurationParameter annotation. This interface gives individual instances a chance to customize the static configuration description.

Author:

The LSST CCS Team

Method Summary

Modifier and Type	Method and Description
default ConfigurationParameterDescription	getConfigurationParameterDescription(String parName) Get a custom ConfigurationParameterDescription for the specified parameter name.

Method Detail

getConfigurationParameterDescription

default ConfigurationParameterDescription getConfigurationParameterDescription(String parName)

Get a custom ConfigurationParameterDescription for the specified parameter name.

Parameters:

parName - The name of the field annotated with the ConfigurationParameter annotation.

Returns:

A ConfigurationParameterDescription for the provided field name. If not null it will be used to overwrite the parameter description as specified in the ConfigurationParameter annotation.