Package io.muserver.openapi

Class ParameterObject

java.lang.Object

io.muserver.openapi.ParameterObject

public class ParameterObject
extends java.lang.Object

See Also:

ParameterObjectBuilder

Field Summary

Fields

Modifier and Type	Field	Description
java.lang.Boolean	allowEmptyValue	Deprecated.
java.lang.Boolean	allowReserved	Deprecated.
java.util.Map<java.lang.String,MediaTypeObject>	content	Deprecated.
java.lang.Boolean	deprecated	Deprecated.
java.lang.String	description	Deprecated.
java.lang.Object	example	Deprecated.
java.util.Map<java.lang.String,ExampleObject>	examples	Deprecated.
java.lang.Boolean	explode	Deprecated.
java.lang.String	in	Deprecated.
java.lang.String	name	Deprecated.
boolean	required	Deprecated.
SchemaObject	schema	Deprecated.
java.lang.String	style	Deprecated.

Method Summary

Modifier and Type	Method	Description
static java.util.List<java.lang.String>	allowedIns()
static java.util.List<java.lang.String>	allowedStyles()
boolean	allowEmptyValue()
boolean	allowReserved()
java.util.Map<java.lang.String,MediaTypeObject>	content()
boolean	deprecated()
java.lang.String	description()
java.lang.Object	example()
java.util.Map<java.lang.String,ExampleObject>	examples()
boolean	explode()
java.lang.String	in()
java.lang.String	name()
boolean	required()
SchemaObject	schema()
java.lang.String	style()
java.lang.String	toString()
void	writeJson(java.io.Writer writer)

Methods inherited from class java.lang.Object

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

Field Detail

name

@Deprecated
public final java.lang.String name

Deprecated.

Use name() instead

in

@Deprecated
public final java.lang.String in

Deprecated.

Use in() instead

description

@Deprecated
public final java.lang.String description

Deprecated.

Use description() instead

required

@Deprecated
public final boolean required

Deprecated.

Use required() instead

deprecated

@Deprecated
public final java.lang.Boolean deprecated

Deprecated.

Use deprecated() instead

allowEmptyValue

@Deprecated
public final java.lang.Boolean allowEmptyValue

Deprecated.

Use allowEmptyValue() instead

style

@Deprecated
public final java.lang.String style

Deprecated.

Use style() instead

explode

@Deprecated
public final java.lang.Boolean explode

Deprecated.

Use explode() instead

allowReserved

@Deprecated
public final java.lang.Boolean allowReserved

Deprecated.

Use allowReserved() instead

schema

@Deprecated
public final SchemaObject schema

Deprecated.

Use schema() instead

example

@Deprecated
public final java.lang.Object example

Deprecated.

Use example() instead

examples

@Deprecated
public final java.util.Map<java.lang.String,ExampleObject> examples

Deprecated.

Use examples() instead

content

@Deprecated
public final java.util.Map<java.lang.String,MediaTypeObject> content

Deprecated.

Use content() instead

Method Detail

allowedIns

public static java.util.List<java.lang.String> allowedIns()

Returns:

The values allowed to be passed to ParameterObjectBuilder.withIn(String)

allowedStyles

public static java.util.List<java.lang.String> allowedStyles()

Returns:

The values allowed to be passed to ParameterObjectBuilder.withStyle(String)

writeJson

public void writeJson(java.io.Writer writer)
               throws java.io.IOException

Throws:

java.io.IOException

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

name

public java.lang.String name()

Returns:

the value described by ParameterObjectBuilder.withName(java.lang.String)

in

public java.lang.String in()

Returns:

the value described by ParameterObjectBuilder.withIn(java.lang.String)

description

public java.lang.String description()

Returns:

the value described by ParameterObjectBuilder.withDescription(java.lang.String)

required

public boolean required()

Returns:

the value described by ParameterObjectBuilder.withRequired(java.lang.Boolean)

deprecated

public boolean deprecated()

Returns:

the value described by ParameterObjectBuilder.withDeprecated(java.lang.Boolean)

allowEmptyValue

public boolean allowEmptyValue()

Returns:

the value described by ParameterObjectBuilder.withAllowEmptyValue(java.lang.Boolean)

style

public java.lang.String style()

Returns:

the value described by ParameterObjectBuilder.withStyle(java.lang.String)

explode

public boolean explode()

Returns:

the value described by ParameterObjectBuilder.withExplode(java.lang.Boolean)

allowReserved

public boolean allowReserved()

Returns:

the value described by ParameterObjectBuilder.withAllowReserved(java.lang.Boolean)

schema

public SchemaObject schema()

Returns:

the value described by ParameterObjectBuilder.withSchema(io.muserver.openapi.SchemaObject)

example

public java.lang.Object example()

Returns:

the value described by ParameterObjectBuilder.withExample(java.lang.Object)

examples

public java.util.Map<java.lang.String,ExampleObject> examples()

Returns:

the value described by ParameterObjectBuilder.withExamples(java.util.Map<java.lang.String, io.muserver.openapi.ExampleObject>)

content

public java.util.Map<java.lang.String,MediaTypeObject> content()

Returns:

the value described by ParameterObjectBuilder.withContent(java.util.Map<java.lang.String, io.muserver.openapi.MediaTypeObject>)