io.github.swagger2markup.internal.adapter

Class PropertyAdapter

java.lang.Object

io.github.swagger2markup.internal.adapter.PropertyAdapter

public final class PropertyAdapter
extends java.lang.Object

Constructor Summary

Constructors

Constructor and Description
PropertyAdapter(io.swagger.models.properties.Property property)

Method Summary

Modifier and Type	Method and Description
static java.lang.Object	convertExample(java.lang.String value, java.lang.String type) Convert a string value to specified type.
static java.lang.Object	generateExample(io.swagger.models.properties.Property property, io.github.swagger2markup.markup.builder.MarkupDocBuilder markupDocBuilder) Generate a default example value for property.
java.util.Optional<java.lang.Object>	getDefaultValue() Retrieves the default value of a property
java.util.Optional<java.lang.Object>	getExample(boolean generateMissingExamples, io.github.swagger2markup.markup.builder.MarkupDocBuilder markupDocBuilder) Return example display string for the given property.
boolean	getExclusiveMax() Retrieves the exclusiveMaximum value of a property
boolean	getExclusiveMin() Retrieves the exclusiveMinimum value of a property
java.util.Optional<java.lang.Number>	getMax() Retrieves the minimum value of a property
java.util.Optional<java.lang.Integer>	getMaxlength() Retrieves the maxLength of a property
java.util.Optional<java.lang.Number>	getMin() Retrieves the minimum value of a property
java.util.Optional<java.lang.Integer>	getMinlength() Retrieves the minLength of a property
java.util.Optional<java.lang.String>	getPattern() Retrieves the pattern of a property
boolean	getReadOnly() Checks if a property is read-only.
Type	getType(DocumentResolver definitionDocumentResolver) Retrieves the type and format of a property.

Methods inherited from class java.lang.Object

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

Constructor Detail

PropertyAdapter

public PropertyAdapter(io.swagger.models.properties.Property property)

Method Detail

generateExample

public static java.lang.Object generateExample(io.swagger.models.properties.Property property,
                                               io.github.swagger2markup.markup.builder.MarkupDocBuilder markupDocBuilder)

Generate a default example value for property.

Parameters:

property - property

markupDocBuilder - doc builder

Returns:

a generated example for the property

convertExample

public static java.lang.Object convertExample(java.lang.String value,
                                              java.lang.String type)

Convert a string value to specified type.

Parameters:

value - value to convert

type - target conversion type

Returns:

converted value as object

getType

public Type getType(DocumentResolver definitionDocumentResolver)

Retrieves the type and format of a property.

Parameters:

definitionDocumentResolver - the definition document resolver

Returns:

the type of the property

getDefaultValue

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

Retrieves the default value of a property

Returns:

the default value of the property

getMinlength

public java.util.Optional<java.lang.Integer> getMinlength()

Retrieves the minLength of a property

Returns:

the minLength of the property

getMaxlength

public java.util.Optional<java.lang.Integer> getMaxlength()

Retrieves the maxLength of a property

Returns:

the maxLength of the property

getPattern

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

Retrieves the pattern of a property

Returns:

the pattern of the property

getMin

public java.util.Optional<java.lang.Number> getMin()

Retrieves the minimum value of a property

Returns:

the minimum value of the property

getExclusiveMin

public boolean getExclusiveMin()

Retrieves the exclusiveMinimum value of a property

Returns:

the exclusiveMinimum value of the property

getMax

public java.util.Optional<java.lang.Number> getMax()

Retrieves the minimum value of a property

Returns:

the minimum value of the property

getExclusiveMax

public boolean getExclusiveMax()

Retrieves the exclusiveMaximum value of a property

Returns:

the exclusiveMaximum value of the property

getExample

public java.util.Optional<java.lang.Object> getExample(boolean generateMissingExamples,
                                                       io.github.swagger2markup.markup.builder.MarkupDocBuilder markupDocBuilder)

Return example display string for the given property.

Parameters:

generateMissingExamples - specifies if missing examples should be generated

markupDocBuilder - doc builder

Returns:

property example display string

getReadOnly

public boolean getReadOnly()

Checks if a property is read-only.

Returns:

true if the property is read-only