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

Class BaseYangSwaggerGeneratorDraft02

java.lang.Object

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

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

Direct Known Subclasses:

ApiDocGeneratorDraftO2, MountPointSwaggerGeneratorDraft02

public abstract class BaseYangSwaggerGeneratorDraft02
extends BaseYangSwaggerGenerator

Base class for a bierman draft02 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

Modifier and Type	Field and Description
protected static String	DEFAULT_BASE_PATH

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

API_VERSION, SWAGGER_VERSION

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	BaseYangSwaggerGeneratorDraft02(Optional<org.opendaylight.mdsal.dom.api.DOMSchemaService> schemaService)
protected	BaseYangSwaggerGeneratorDraft02(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

Field Detail

DEFAULT_BASE_PATH

protected static final String DEFAULT_BASE_PATH

See Also:

Constant Field Values

Constructor Detail

BaseYangSwaggerGeneratorDraft02

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

BaseYangSwaggerGeneratorDraft02

protected BaseYangSwaggerGeneratorDraft02(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