Package io.swagger.v3.oas.models.examples

Class Example

java.lang.Object

io.swagger.v3.oas.models.examples.Example

public class Example
extends Object

Example

See Also:

"https://github.com/OAI/OpenAPI-Specification/blob/3.0.4/versions/3.0.4.md#example-object", "https://github.com/OAI/OpenAPI-Specification/blob/3.1.1/versions/3.1.1.md#example-object"

Constructor Summary

Constructors

Constructor	Description
Example()

Method Summary

Modifier and Type	Method	Description
Example	$ref(String $ref)
void	addExtension(String name, Object value)
void	addExtension31(String name, Object value)
Example	description(String description)
boolean	equals(Object o)
Example	extensions(Map<String,Object> extensions)
Example	externalValue(String externalValue)
String	get$ref()
String	getDescription()	returns the description property from a Example instance.
Map<String,Object>	getExtensions()
String	getExternalValue()	returns the externalValue property from a Example instance.
String	getSummary()	returns the summary property from a Example instance.
Object	getValue()	returns the value property from a Example instance.
boolean	getValueSetFlag()
int	hashCode()
void	set$ref(String $ref)
void	setDescription(String description)
void	setExtensions(Map<String,Object> extensions)
void	setExternalValue(String externalValue)
void	setSummary(String summary)
void	setValue(Object value)
void	setValueSetFlag(boolean valueSetFlag)
Example	summary(String summary)
String	toString()
Example	value(Object value)

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

Example

public Example()

Method Detail

getSummary

public String getSummary()

returns the summary property from a Example instance.

Returns:

String summary

setSummary

public void setSummary(String summary)

summary

public Example summary(String summary)

getDescription

public String getDescription()

returns the description property from a Example instance.

Returns:

String description

setDescription

public void setDescription(String description)

description

public Example description(String description)

getValue

public Object getValue()

returns the value property from a Example instance.

Returns:

Object value

setValue

public void setValue(Object value)

value

public Example value(Object value)

getExternalValue

public String getExternalValue()

returns the externalValue property from a Example instance.

Returns:

String externalValue

setExternalValue

public void setExternalValue(String externalValue)

externalValue

public Example externalValue(String externalValue)

get$ref

public String get$ref()

set$ref

public void set$ref(String $ref)

$ref

public Example $ref(String $ref)

getExtensions

public Map<String,Object> getExtensions()

addExtension

public void addExtension(String name,
                         Object value)

addExtension31

public void addExtension31(String name,
                           Object value)

setExtensions

public void setExtensions(Map<String,Object> extensions)

extensions

public Example extensions(Map<String,Object> extensions)

getValueSetFlag

public boolean getValueSetFlag()

setValueSetFlag

public void setValueSetFlag(boolean valueSetFlag)

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object