Package 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

BASE_PATH, MODULE_NAME_SUFFIX

Constructor Summary

Constructors

Modifier	Constructor	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	Description
protected void	appendPathKeyValue(StringBuilder builder, Object value)
protected String	getPathVersion()
String	getResourcePath(String resourceType, String context)
String	getResourcePathPart(String resourceType)
protected BaseYangSwaggerGenerator.ListPathBuilder	newListPathBuilder()

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

createHostFromUriInfo, createResourceList, createSchemaFromUriInfo, createSwaggerObject, fillDoc, generatePath, generateUrlPrefixFromInstanceID, getAllModulesDoc, getAllModulesDoc, getApiDeclaration, getApiDeclaration, getApiDeclaration, getAppropriateDoc, getResourceListing, getResourceListing, getSchemaService, getSortedModules, getSwaggerDocSpec, 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

getPathVersion

protected String getPathVersion()

Specified by:

getPathVersion in class BaseYangSwaggerGenerator

getResourcePath

public String getResourcePath(String resourceType,
                              String context)

Specified by:

getResourcePath in class BaseYangSwaggerGenerator

getResourcePathPart

public String getResourcePathPart(String resourceType)

Specified by:

getResourcePathPart 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