org.opendaylight.mdsal.binding.javav2.model.api

Interface AnnotationType.Parameter

Enclosing interface:

AnnotationType

@Beta
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 getSingleValue() MUST always return non- null parameter. If the Parameter holds List of values the singular getSingleValue() parameter MAY return null value.

Method Summary

Modifier and Type	Method and Description
String	getName() Returns the Name of the parameter.
String	getSingleValue() Returns value in String format if Parameter contains singular value, otherwise should return first value only.
default List<String>	getValues() Returns List of Parameter assigned values in order in which they were assigned for given parameter name.

Method Detail

getName

String getName()

Returns the Name of the parameter.

Returns:

the Name of the parameter.

getSingleValue

String getSingleValue()

Returns value in String format if Parameter contains singular value, otherwise should return first value only. Implementation should throw exception if there is no value to return.

Returns:

value in String format.

Throws:

NoSuchElementException - If such value not found

getValues

default 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. As we consider getSingleValue() as a primary method, default implementation of getValues() is provided here.

Returns:

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