MicroProfile 7.0 · org.eclipse.microprofile.openapi.models.examples.Example

Method Summary

Modifier and Type	Method and Description
public default Example	Returns: the current Example object description(String long description of the example description) Sets this Example's description property to the given string.
public default Example	Returns: the current Example object externalValue(String URL that points to the literal example externalValue) Sets this Example's externalValue property to the given string.
public String	Returns: long description of the example getDescription() Returns the description property from an Example instance.
public String	Returns: URL that points to the literal example getExternalValue() Returns the externalValue property from an Example instance.
public String	Returns: short description of the example getSummary() Returns the summary property from an Example instance.
public Object	Returns: embedded literal example object getValue() Returns the value property from an Example instance.
public void	setDescription(String long description of the example description) Sets this Example's description property to the given string.
public void	setExternalValue(String URL that points to the literal example externalValue) Sets this Example's externalValue property to the given string.
public void	setSummary(String short description of the example summary) Sets this Example's summary property to the given string.
public void	setValue(Object a literal example object value) Sets this Example's value property to the given value.
public default Example	Returns: the current Example object summary(String short description of the example summary) Sets this Example's summary property to the given string.
public default Example	Returns: the current Example object value(Object a literal example object value) Sets this Example's value property to the given value.

Inherited from org.eclipse.microprofile.openapi.models.Extensible:: addExtension extensions getExtensions removeExtension setExtensions
Inherited from org.eclipse.microprofile.openapi.models.Reference:: getRef ref setRef

Method Detail

description	back to summary
public default Example description(String description) Sets this Example's description property to the given string. Parameters description:String long description of the example Returns:Example the current Example object

description

back to summary

public default Example description(String description)

Sets this Example's description property to the given string.

Parameters

description:String: long description of the example

Returns:Example

the current Example object

externalValue	back to summary
public default Example externalValue(String externalValue) Sets this Example's externalValue property to the given string. The value field and externalValue field are mutually exclusive. Parameters externalValue:String URL that points to the literal example Returns:Example the current Example object

externalValue

back to summary

public default Example externalValue(String externalValue)

Sets this Example's externalValue property to the given string. The value field and externalValue field are mutually exclusive.

Parameters

externalValue:String: URL that points to the literal example

Returns:Example

the current Example object

getDescription	back to summary
public String getDescription() Returns the description property from an Example instance. Returns:String long description of the example

getDescription

back to summary

public String getDescription()

Returns the description property from an Example instance.

Returns:String: long description of the example

getExternalValue	back to summary
public String getExternalValue() Returns the externalValue property from an Example instance. Returns:String URL that points to the literal example

getExternalValue

back to summary

public String getExternalValue()

Returns the externalValue property from an Example instance.

Returns:String: URL that points to the literal example

getSummary	back to summary
public String getSummary() Returns the summary property from an Example instance. Returns:String short description of the example

getSummary

back to summary

public String getSummary()

Returns the summary property from an Example instance.

Returns:String: short description of the example

getValue	back to summary
public Object getValue() Returns the value property from an Example instance. Returns:Object embedded literal example object

getValue

back to summary

public Object getValue()

Returns the value property from an Example instance.

Returns:Object: embedded literal example object

setDescription	back to summary
public void setDescription(String description) Sets this Example's description property to the given string. Parameters description:String long description of the example

setDescription

back to summary

public void setDescription(String description)

Sets this Example's description property to the given string.

Parameters

description:String: long description of the example

setExternalValue	back to summary
public void setExternalValue(String externalValue) Sets this Example's externalValue property to the given string. The value field and externalValue field are mutually exclusive. Parameters externalValue:String URL that points to the literal example

setExternalValue

back to summary

public void setExternalValue(String externalValue)

Sets this Example's externalValue property to the given string. The value field and externalValue field are mutually exclusive.

Parameters

externalValue:String: URL that points to the literal example

setSummary	back to summary
public void setSummary(String summary) Sets this Example's summary property to the given string. Parameters summary:String short description of the example

setSummary

back to summary

public void setSummary(String summary)

Sets this Example's summary property to the given string.

Parameters

summary:String: short description of the example

setValue	back to summary
public void setValue(Object value) Sets this Example's value property to the given value. The value field and externalValue field are mutually exclusive. Parameters value:Object a literal example object

setValue

back to summary

public void setValue(Object value)

Sets this Example's value property to the given value. The value field and externalValue field are mutually exclusive.

Parameters

value:Object: a literal example object

summary	back to summary
public default Example summary(String summary) Sets this Example's summary property to the given string. Parameters summary:String short description of the example Returns:Example the current Example object

summary

back to summary

public default Example summary(String summary)

Sets this Example's summary property to the given string.

Parameters

summary:String: short description of the example

Returns:Example

the current Example object

value	back to summary
public default Example value(Object value) Sets this Example's value property to the given value. The value field and externalValue field are mutually exclusive. Parameters value:Object a literal example object Returns:Example the current Example object

value

back to summary

public default Example value(Object value)

Sets this Example's value property to the given value. The value field and externalValue field are mutually exclusive.

Parameters

value:Object: a literal example object

Returns:Example

the current Example object

public Interface Example

Method Summary

Method Detail