MicroProfile 7.0 · org.eclipse.microprofile.openapi.models.Extensible

Method Summary

Modifier and Type	Method and Description
public T	Returns: the current instance addExtension(String the key used to access the extension object. Always prefixed by "x-". name, Object data not required by the specification. null values will be rejected (implementation will throw an exception) or ignored. value) Adds the given object to this Extensible's map of extensions, with the given name as its key.
public default T	Returns: the current instance extensions(Map<String, Object> map containing keys which start with "x-" and values which provide additional information extensions) Sets this Extensible's extensions property to the given map of extensions.
public Map<String, Object>	Returns: a map containing keys which start with "x-" and values which provide additional information getExtensions() Returns the extensions property from an Extensible instance.
public void	removeExtension(String the key used to access the extension object. Always prefixed by "x-". name) Removes the given object to this Extensible's map of extensions, with the given name as its key.
public void	setExtensions(Map<String, Object> map containing keys which start with "x-" and values which provide additional information extensions) Sets this Extensible's extensions property to the given map of extensions.

addExtension	back to summary
public T addExtension(String name, Object value) Adds the given object to this Extensible's map of extensions, with the given name as its key. Parameters name:String the key used to access the extension object. Always prefixed by "x-". value:Object data not required by the specification. null values will be rejected (implementation will throw an exception) or ignored. Returns:T the current instance

addExtension

public T addExtension(String name, Object value)

Adds the given object to this Extensible's map of extensions, with the given name as its key.

Parameters

name:String: the key used to access the extension object. Always prefixed by "x-".
value:Object: data not required by the specification. null values will be rejected (implementation will throw an exception) or ignored.

Returns:T

the current instance

extensions	back to summary
public default T extensions(Map<String, Object> extensions) Sets this Extensible's extensions property to the given map of extensions. Parameters extensions:Map<String, Object> map containing keys which start with "x-" and values which provide additional information Returns:T the current instance

extensions

public default T extensions(Map<String, Object> extensions)

Sets this Extensible's extensions property to the given map of extensions.

Parameters

extensions:Map<String, Object>: map containing keys which start with "x-" and values which provide additional information

Returns:T

the current instance

getExtensions	back to summary
public Map<String, Object> getExtensions() Returns the extensions property from an Extensible instance. Returns:Map<String, Object> a map containing keys which start with "x-" and values which provide additional information

getExtensions

public Map<String, Object> getExtensions()

Returns the extensions property from an Extensible instance.

Returns:Map<String, Object>: a map containing keys which start with "x-" and values which provide additional information

removeExtension	back to summary
public void removeExtension(String name) Removes the given object to this Extensible's map of extensions, with the given name as its key. Parameters name:String the key used to access the extension object. Always prefixed by "x-".

removeExtension

public void removeExtension(String name)

Removes the given object to this Extensible's map of extensions, with the given name as its key.

Parameters

name:String: the key used to access the extension object. Always prefixed by "x-".

setExtensions	back to summary
public void setExtensions(Map<String, Object> extensions) Sets this Extensible's extensions property to the given map of extensions. Parameters extensions:Map<String, Object> map containing keys which start with "x-" and values which provide additional information

setExtensions

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

Sets this Extensible's extensions property to the given map of extensions.

Parameters

extensions:Map<String, Object>: map containing keys which start with "x-" and values which provide additional information