Package org.opendaylight.netconf.sal.rest.doc.model.builder

Class OperationBuilder

java.lang.Object

org.opendaylight.netconf.sal.rest.doc.model.builder.OperationBuilder

public final class OperationBuilder
extends Object

Field Summary

Fields

Modifier and Type	Field	Description
static String	BODY
static String	COMPONENTS_PREFIX
static String	CONFIG
static String	CONFIG_QUERY_PARAM
static String	CONSUMES_KEY
static String	CONTENT_KEY
static String	DEFINITIONS_PREFIX
static String	DESCRIPTION_KEY
static String	IN_KEY
static String	INPUT_KEY
static String	NAME_KEY
static String	NONCONFIG_QUERY_PARAM
static String	PARAMETERS_KEY
static String	POST_SUFFIX
static String	PROPERTIES_KEY
static String	REF_KEY
static String	REQUEST_BODY_KEY
static String	RESPONSES_KEY
static String	SCHEMA_KEY
static String	SUMMARY_KEY
static String	SUMMARY_SEPARATOR
static String	TAGS_KEY
static String	TOP
static String	XML_KEY
static String	XML_SUFFIX

Method Summary

Modifier and Type	Method	Description
static com.fasterxml.jackson.databind.node.ObjectNode	buildDelete(org.opendaylight.yangtools.yang.model.api.DataSchemaNode node, String moduleName, Optional<String> deviceName, com.fasterxml.jackson.databind.node.ArrayNode pathParams, ApiDocServiceImpl.OAversion oaversion)
static com.fasterxml.jackson.databind.node.ObjectNode	buildGet(org.opendaylight.yangtools.yang.model.api.DataSchemaNode node, String moduleName, Optional<String> deviceName, com.fasterxml.jackson.databind.node.ArrayNode pathParams, String defName, boolean isConfig, ApiDocServiceImpl.URIType uriType, ApiDocServiceImpl.OAversion oaversion)
static com.fasterxml.jackson.databind.node.ObjectNode	buildPost(String parentName, String nodeName, String discriminator, String moduleName, Optional<String> deviceName, String description, com.fasterxml.jackson.databind.node.ArrayNode pathParams, ApiDocServiceImpl.OAversion oaversion)
static com.fasterxml.jackson.databind.node.ObjectNode	buildPostOperation(org.opendaylight.yangtools.yang.model.api.OperationDefinition operDef, String moduleName, Optional<String> deviceName, String parentName, DefinitionNames definitionNames, ApiDocServiceImpl.OAversion oaversion)
static com.fasterxml.jackson.databind.node.ObjectNode	buildPut(String parentName, String nodeName, String discriminator, String moduleName, Optional<String> deviceName, String description, com.fasterxml.jackson.databind.node.ArrayNode pathParams, ApiDocServiceImpl.OAversion oaversion)
static com.fasterxml.jackson.databind.node.ObjectNode	buildResponse(String description, Optional<com.fasterxml.jackson.databind.node.ObjectNode> schema, ApiDocServiceImpl.OAversion oaversion)
static com.fasterxml.jackson.databind.node.ArrayNode	buildTagsValue(Optional<String> deviceName, String moduleName)
static String	getAppropriateModelPrefix(ApiDocServiceImpl.OAversion oaversion)
static com.fasterxml.jackson.databind.node.ObjectNode	getTypeParentNode(com.fasterxml.jackson.databind.node.ObjectNode parameter, ApiDocServiceImpl.OAversion oaversion)

Methods inherited from class java.lang.Object

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

Field Detail

BODY

public static final String BODY

See Also:

Constant Field Values

CONFIG

public static final String CONFIG

See Also:

Constant Field Values

CONFIG_QUERY_PARAM

public static final String CONFIG_QUERY_PARAM

See Also:

Constant Field Values

CONSUMES_KEY

public static final String CONSUMES_KEY

See Also:

Constant Field Values

CONTENT_KEY

public static final String CONTENT_KEY

See Also:

Constant Field Values

COMPONENTS_PREFIX

public static final String COMPONENTS_PREFIX

See Also:

Constant Field Values

DEFINITIONS_PREFIX

public static final String DEFINITIONS_PREFIX

See Also:

Constant Field Values

DESCRIPTION_KEY

public static final String DESCRIPTION_KEY

See Also:

Constant Field Values

IN_KEY

public static final String IN_KEY

See Also:

Constant Field Values

INPUT_KEY

public static final String INPUT_KEY

See Also:

Constant Field Values

NAME_KEY

public static final String NAME_KEY

See Also:

Constant Field Values

NONCONFIG_QUERY_PARAM

public static final String NONCONFIG_QUERY_PARAM

See Also:

Constant Field Values

PARAMETERS_KEY

public static final String PARAMETERS_KEY

See Also:

Constant Field Values

POST_SUFFIX

public static final String POST_SUFFIX

See Also:

Constant Field Values

PROPERTIES_KEY

public static final String PROPERTIES_KEY

See Also:

Constant Field Values

REF_KEY

public static final String REF_KEY

See Also:

Constant Field Values

REQUEST_BODY_KEY

public static final String REQUEST_BODY_KEY

See Also:

Constant Field Values

RESPONSES_KEY

public static final String RESPONSES_KEY

See Also:

Constant Field Values

SCHEMA_KEY

public static final String SCHEMA_KEY

See Also:

Constant Field Values

SUMMARY_KEY

public static final String SUMMARY_KEY

See Also:

Constant Field Values

SUMMARY_SEPARATOR

public static final String SUMMARY_SEPARATOR

See Also:

Constant Field Values

TAGS_KEY

public static final String TAGS_KEY

See Also:

Constant Field Values

TOP

public static final String TOP

See Also:

Constant Field Values

XML_KEY

public static final String XML_KEY

See Also:

Constant Field Values

XML_SUFFIX

public static final String XML_SUFFIX

See Also:

Constant Field Values

Method Detail

buildPost

public static com.fasterxml.jackson.databind.node.ObjectNode buildPost(String parentName,
                                                                       String nodeName,
                                                                       String discriminator,
                                                                       String moduleName,
                                                                       Optional<String> deviceName,
                                                                       String description,
                                                                       com.fasterxml.jackson.databind.node.ArrayNode pathParams,
                                                                       ApiDocServiceImpl.OAversion oaversion)

buildGet

public static com.fasterxml.jackson.databind.node.ObjectNode buildGet(org.opendaylight.yangtools.yang.model.api.DataSchemaNode node,
                                                                      String moduleName,
                                                                      Optional<String> deviceName,
                                                                      com.fasterxml.jackson.databind.node.ArrayNode pathParams,
                                                                      String defName,
                                                                      boolean isConfig,
                                                                      ApiDocServiceImpl.URIType uriType,
                                                                      ApiDocServiceImpl.OAversion oaversion)

buildPut

public static com.fasterxml.jackson.databind.node.ObjectNode buildPut(String parentName,
                                                                      String nodeName,
                                                                      String discriminator,
                                                                      String moduleName,
                                                                      Optional<String> deviceName,
                                                                      String description,
                                                                      com.fasterxml.jackson.databind.node.ArrayNode pathParams,
                                                                      ApiDocServiceImpl.OAversion oaversion)

buildDelete

public static com.fasterxml.jackson.databind.node.ObjectNode buildDelete(org.opendaylight.yangtools.yang.model.api.DataSchemaNode node,
                                                                         String moduleName,
                                                                         Optional<String> deviceName,
                                                                         com.fasterxml.jackson.databind.node.ArrayNode pathParams,
                                                                         ApiDocServiceImpl.OAversion oaversion)

buildPostOperation

public static com.fasterxml.jackson.databind.node.ObjectNode buildPostOperation(org.opendaylight.yangtools.yang.model.api.OperationDefinition operDef,
                                                                                String moduleName,
                                                                                Optional<String> deviceName,
                                                                                String parentName,
                                                                                DefinitionNames definitionNames,
                                                                                ApiDocServiceImpl.OAversion oaversion)

buildResponse

public static com.fasterxml.jackson.databind.node.ObjectNode buildResponse(String description,
                                                                           Optional<com.fasterxml.jackson.databind.node.ObjectNode> schema,
                                                                           ApiDocServiceImpl.OAversion oaversion)

buildTagsValue

public static com.fasterxml.jackson.databind.node.ArrayNode buildTagsValue(Optional<String> deviceName,
                                                                           String moduleName)

getAppropriateModelPrefix

public static String getAppropriateModelPrefix(ApiDocServiceImpl.OAversion oaversion)

getTypeParentNode

public static com.fasterxml.jackson.databind.node.ObjectNode getTypeParentNode(com.fasterxml.jackson.databind.node.ObjectNode parameter,
                                                                               ApiDocServiceImpl.OAversion oaversion)