org.opendaylight.mdsal.binding.model.api

Interface AnnotationType.Parameter

Enclosing interface:

AnnotationType

public static interface AnnotationType.Parameter

Annotation Type parameter interface. For simplicity the Parameter contains values and value types as Strings. Every annotation which contains parameters could contain either single parameter or array of parameters. To model this purposes the by contract if the parameter contains single parameter the getValues() method will return empty List and getValue() MUST always return non-null parameter. If the Parameter holds List of values the singular getValue() parameter MAY return null value.

Method Summary

Modifier and Type	Method and Description
String	getName() Returns the Name of the parameter.
String	getValue() Returns value in String format if Parameter contains singular value, otherwise MAY return null.
List<String>	getValues() Returns List of Parameter assigned values in order in which they were assigned for given parameter name. If there are multiple values assigned for given parameter name the method MUST NOT return empty List.

Method Detail

getName

String getName()

Returns the Name of the parameter.

Returns:

the Name of the parameter.

getValue

String getValue()

Returns value in String format if Parameter contains singular value, otherwise MAY return null.

Returns:

value in String format if Parameter contains singular value.

getValues

List<String> getValues()

Returns List of Parameter assigned values in order in which they were assigned for given parameter name.
If there are multiple values assigned for given parameter name the method MUST NOT return empty List.

Returns:

List of Parameter assigned values in order in which they were assigned for given parameter name.