io.muserver.openapi

Class ServerVariableObject

java.lang.Object

io.muserver.openapi.ServerVariableObject

public class ServerVariableObject
extends Object

See Also:

ServerVariableObjectBuilder

Field Summary

Fields

Modifier and Type	Field and Description
String	defaultValue Deprecated. use defaultValue() instead
String	description Deprecated. use description() instead
List<String>	enumValues Deprecated. use enumValues() instead

Method Summary

Modifier and Type	Method and Description
String	defaultValue()
String	description()
List<String>	enumValues()
void	writeJson(Writer writer) Writes this object as a JSON Object

Methods inherited from class java.lang.Object

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

Field Detail

enumValues

@Deprecated
public final List<String> enumValues

Deprecated. use enumValues() instead

defaultValue

@Deprecated
public final String defaultValue

Deprecated. use defaultValue() instead

description

@Deprecated
public final String description

Deprecated. use description() instead

Method Detail

writeJson

public void writeJson(Writer writer)
               throws IOException

Writes this object as a JSON Object

Parameters:

writer - The writer to write to

Throws:

IOException - Thrown if the writer throws this while writing

enumValues

public List<String> enumValues()

Returns:

the value described by ServerVariableObjectBuilder.withEnumValues(java.util.List<java.lang.String>)

defaultValue

public String defaultValue()

Returns:

the value described by ServerVariableObjectBuilder.withDefaultValue(java.lang.String)

description

public String description()

Returns:

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