org.opendaylight.yangtools.sal.binding.model.api

Interface DocumentedType

All Known Subinterfaces:

Enumeration, GeneratedTransferIdentityObject, GeneratedTransferObject, GeneratedType

public interface DocumentedType

Implementing this interface allows an object to hold information which are essential for generating java doc from type definition.

Method Summary

Methods

Modifier and Type	Method and Description
String	getDescription() Returns a string that contains a human-readable textual description of type definition.
String	getModuleName() Returns the name of the module, in which generated type was specified.
String	getReference() Returns a string that is used to specify a textual cross-reference to an external document, either another module that defines related management information, or a document that provides additional information relevant to this definition.
Iterable<org.opendaylight.yangtools.yang.common.QName>	getSchemaPath() Returns a list of QNames which represent schema path in schema tree from actual concrete type to the root.

Method Detail

getDescription

String getDescription()

Returns a string that contains a human-readable textual description of type definition.

Returns:

a human-readable textual description of type definition.

getReference

String getReference()

Returns a string that is used to specify a textual cross-reference to an external document, either another module that defines related management information, or a document that provides additional information relevant to this definition.

Returns:

a textual cross-reference to an external document.

getSchemaPath

Iterable<org.opendaylight.yangtools.yang.common.QName> getSchemaPath()

Returns a list of QNames which represent schema path in schema tree from actual concrete type to the root.

Returns:

a schema path in schema tree from actual concrete schema node identifier to the root.

getModuleName

String getModuleName()

Returns the name of the module, in which generated type was specified.

Returns:

the name of the module, in which generated type was specified.