io.github.swagger2markup.internal.adapter

Class ParameterAdapter

java.lang.Object

io.github.swagger2markup.internal.adapter.ParameterAdapter

public class ParameterAdapter
extends java.lang.Object

Constructor Summary

Constructors

Constructor and Description
ParameterAdapter(Swagger2MarkupConverter.Context context, PathOperation operation, io.swagger.models.parameters.Parameter parameter, DocumentResolver definitionDocumentResolver)

Method Summary

Modifier and Type	Method and Description
java.lang.String	displayDefaultValue(io.github.swagger2markup.markup.builder.MarkupDocBuilder docBuilder)
java.lang.String	displayDescription(io.github.swagger2markup.markup.builder.MarkupDocBuilder markupDocBuilder)
java.lang.String	displaySchema(io.github.swagger2markup.markup.builder.MarkupDocBuilder docBuilder)
java.lang.String	displayType(io.github.swagger2markup.markup.builder.MarkupDocBuilder markupDocBuilder)
static java.lang.Object	generateExample(io.swagger.models.parameters.AbstractSerializableParameter parameter) Generate a default example value for parameter.
java.lang.String	getAccess()
java.util.Optional<java.lang.String>	getDefaultValue() Retrieves the default value of a parameter
java.lang.String	getDescription()
java.lang.String	getIn()
java.util.List<ObjectType>	getInlineDefinitions()
java.lang.String	getName()
java.lang.String	getPattern()
boolean	getRequired()
Type	getType()
java.lang.String	getUniqueName()
java.util.Map<java.lang.String,java.lang.Object>	getVendorExtensions()

Methods inherited from class java.lang.Object

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

Constructor Detail

ParameterAdapter

public ParameterAdapter(Swagger2MarkupConverter.Context context,
                        PathOperation operation,
                        io.swagger.models.parameters.Parameter parameter,
                        DocumentResolver definitionDocumentResolver)

Method Detail

generateExample

public static java.lang.Object generateExample(io.swagger.models.parameters.AbstractSerializableParameter parameter)

Generate a default example value for parameter.

Parameters:

parameter - parameter

Returns:

a generated example for the parameter

getAccess

public java.lang.String getAccess()

getName

public java.lang.String getName()

getUniqueName

public java.lang.String getUniqueName()

displaySchema

public java.lang.String displaySchema(io.github.swagger2markup.markup.builder.MarkupDocBuilder docBuilder)

displayDefaultValue

public java.lang.String displayDefaultValue(io.github.swagger2markup.markup.builder.MarkupDocBuilder docBuilder)

displayDescription

public java.lang.String displayDescription(io.github.swagger2markup.markup.builder.MarkupDocBuilder markupDocBuilder)

displayType

public java.lang.String displayType(io.github.swagger2markup.markup.builder.MarkupDocBuilder markupDocBuilder)

getDescription

public java.lang.String getDescription()

getRequired

public boolean getRequired()

getPattern

public java.lang.String getPattern()

getVendorExtensions

public java.util.Map<java.lang.String,java.lang.Object> getVendorExtensions()

getIn

public java.lang.String getIn()

getType

public Type getType()

getInlineDefinitions

public java.util.List<ObjectType> getInlineDefinitions()

getDefaultValue

public java.util.Optional<java.lang.String> getDefaultValue()

Retrieves the default value of a parameter

Returns:

the default value of the parameter