io.muserver.openapi

Class ExampleObject

java.lang.Object

io.muserver.openapi.ExampleObject

public class ExampleObject
extends Object

See Also:

ExampleObjectBuilder

Field Summary

Fields

Modifier and Type	Field and Description
String	description Deprecated. use description() instead
URI	externalValue Deprecated. use externalValue() instead
String	summary Deprecated. use summary() instead
Object	value Deprecated. use value() instead

Method Summary

Modifier and Type	Method and Description
String	description()
URI	externalValue()
String	summary()
Object	value()
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

summary

@Deprecated
public final String summary

Deprecated. use summary() instead

description

@Deprecated
public final String description

Deprecated. use description() instead

value

@Deprecated
public final Object value

Deprecated. use value() instead

externalValue

@Deprecated
public final URI externalValue

Deprecated. use externalValue() 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

summary

public String summary()

Returns:

the value described by ExampleObjectBuilder.withSummary(java.lang.String)

description

public String description()

Returns:

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

value

public Object value()

Returns:

the value described by ExampleObjectBuilder.withValue(java.lang.Object)

externalValue

public URI externalValue()

Returns:

the value described by ExampleObjectBuilder.withExternalValue(java.net.URI)