org.opendaylight.netconf.sal.rest.doc.impl

Class BaseYangSwaggerGeneratorRFC8040

java.lang.Object

org.opendaylight.netconf.sal.rest.doc.impl.BaseYangSwaggerGenerator

org.opendaylight.netconf.sal.rest.doc.impl.BaseYangSwaggerGeneratorRFC8040

Direct Known Subclasses:

ApiDocGeneratorRFC8040, MountPointSwaggerGeneratorRFC8040

public abstract class BaseYangSwaggerGeneratorRFC8040
extends BaseYangSwaggerGenerator

Base class for an RFC 8040 implementation.

Author:

Thomas Pantelis

Nested Class Summary

Nested classes/interfaces inherited from class org.opendaylight.netconf.sal.rest.doc.impl.BaseYangSwaggerGenerator

BaseYangSwaggerGenerator.ListPathBuilder

Field Summary

Fields inherited from class org.opendaylight.netconf.sal.rest.doc.impl.BaseYangSwaggerGenerator

API_VERSION, SWAGGER_VERSION

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	BaseYangSwaggerGeneratorRFC8040(Optional<org.opendaylight.mdsal.dom.api.DOMSchemaService> schemaService)
protected	BaseYangSwaggerGeneratorRFC8040(Optional<org.opendaylight.mdsal.dom.api.DOMSchemaService> schemaService, String basePath)

Method Summary

Modifier and Type	Method and Description
protected void	appendPathKeyValue(StringBuilder builder, Object value)
String	getContent(String dataStore)
String	getDataStorePath(String dataStore, String context)
protected BaseYangSwaggerGenerator.ListPathBuilder	newListPathBuilder()

Methods inherited from class org.opendaylight.netconf.sal.rest.doc.impl.BaseYangSwaggerGenerator

addRpcs, createApiDeclaration, createBasePathFromUriInfo, createResourceList, generatePath, generateUrlPrefixFromInstanceID, getApiDeclaration, getApiDeclaration, getApiDeclaration, getResourceListing, getResourceListing, getSchemaService, getSortedModules, getSwaggerDocSpec

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

BaseYangSwaggerGeneratorRFC8040

protected BaseYangSwaggerGeneratorRFC8040(Optional<org.opendaylight.mdsal.dom.api.DOMSchemaService> schemaService)

BaseYangSwaggerGeneratorRFC8040

protected BaseYangSwaggerGeneratorRFC8040(Optional<org.opendaylight.mdsal.dom.api.DOMSchemaService> schemaService,
                                          String basePath)

Method Detail

getDataStorePath

public String getDataStorePath(String dataStore,
                               String context)

Specified by:

getDataStorePath in class BaseYangSwaggerGenerator

getContent

public String getContent(String dataStore)

Specified by:

getContent in class BaseYangSwaggerGenerator

newListPathBuilder

protected BaseYangSwaggerGenerator.ListPathBuilder newListPathBuilder()

Specified by:

newListPathBuilder in class BaseYangSwaggerGenerator

appendPathKeyValue

protected void appendPathKeyValue(StringBuilder builder,
                                  Object value)

Specified by:

appendPathKeyValue in class BaseYangSwaggerGenerator