MicroProfile 7.0 · org.eclipse.microprofile.openapi.models.responses.APIResponses

Modifier and Type	Field and Description
public static final String	DEFAULT

Method Summary

Modifier and Type	Method and Description
public APIResponses	Returns: APIResponses map with the added ApiResponse instance addAPIResponse(String the name of APIResponse (http status code eventually with wildcard or default) name, APIResponse the APIResponse object to be added to APIResponses map. null values will be rejected (implementation will throw an exception) or ignored. apiResponse) Adds an APIResponse in the format of the name as a key and the item as the value to APIResponses map
public default APIResponses	Returns: this ApiResponses instance defaultValue(APIResponse the default documentation of responses defaultValue) Sets the default documentation of responses for this instance of ApiResponses and return this instance of ApiResponses.
public default APIResponse	Returns: the corresponding APIResponse or null. getAPIResponse(String the name of APIResponse (http status code eventually with wildcard or default) name) Returns a APIResponse for a given name.
public Map<String, APIResponse>	Returns: all responses getAPIResponses() Returns a copy map (potentially immutable) of the APIResponses.
public APIResponse	Returns: the default documentation of responses getDefaultValue() Returns the default documentation of responses other than the ones declared for specific HTTP response codes in this instance of ApiResponses.
public default boolean	Returns: a boolean to indicate if the APIResponse is present or not. hasAPIResponse(String the name of APIResponse (http status code eventually with wildcard or default) name) Check whether a APIResponse is present in the map.
public void	removeAPIResponse(String the name of APIResponse that will be removed (http status code eventually with wildcard or default) name) Removes the given APIResponse to this APIResponses.
public void	setAPIResponses(Map<String, APIResponse> a map containing all responses. Keys are http statuses code eventually with wildcard or default. items) Set the APIResponses map to this APIResponses
public void	setDefaultValue(APIResponse the default documentation of responses defaultValue) Sets the default documentation of responses for this instance of ApiResponses.

Inherited from org.eclipse.microprofile.openapi.models.Extensible:: addExtension extensions getExtensions removeExtension setExtensions

DEFAULT	back to summary
public static final String DEFAULT

Method Detail

addAPIResponse	back to summary
public APIResponses addAPIResponse(String name, APIResponse apiResponse) Adds an APIResponse in the format of the name as a key and the item as the value to APIResponses map Parameters name:String the name of APIResponse (http status code eventually with wildcard or default) apiResponse:APIResponse the APIResponse object to be added to APIResponses map. null values will be rejected (implementation will throw an exception) or ignored. Returns:APIResponses APIResponses map with the added ApiResponse instance

addAPIResponse

back to summary

public APIResponses addAPIResponse(String name, APIResponse apiResponse)

Adds an APIResponse in the format of the name as a key and the item as the value to APIResponses map

Parameters

name:String: the name of APIResponse (http status code eventually with wildcard or default)
apiResponse:APIResponse: the APIResponse object to be added to APIResponses map. null values will be rejected (implementation will throw an exception) or ignored.

Returns:APIResponses

APIResponses map with the added ApiResponse instance

defaultValue back to summary

defaultValue	back to summary
public default APIResponses defaultValue(APIResponse defaultValue) Sets the default documentation of responses for this instance of ApiResponses and return this instance of ApiResponses. This will cover all the undeclared responses. Convenience method that is the same as calling `addAPIResponse(String, APIResponse)` with default as value for the key. Parameters defaultValue:APIResponse the default documentation of responses Returns:APIResponses this ApiResponses instance

public default APIResponses defaultValue(APIResponse defaultValue)

Sets the default documentation of responses for this instance of ApiResponses and return this instance of ApiResponses. This will cover all the undeclared responses.

Convenience method that is the same as calling addAPIResponse(String, APIResponse) with default as value for the key.

Parameters

defaultValue:APIResponse: the default documentation of responses

Returns:APIResponses

this ApiResponses instance

getAPIResponse back to summary

getAPIResponse	back to summary
public default APIResponse getAPIResponse(String name) Returns a APIResponse for a given name. This is a convenience method for `getAPIResponses().get(name)` Parameters name:String the name of APIResponse (http status code eventually with wildcard or default) Returns:APIResponse the corresponding APIResponse or null.

public default APIResponse getAPIResponse(String name)

Returns a APIResponse for a given name. This is a convenience method for getAPIResponses().get(name)

Parameters

name:String: the name of APIResponse (http status code eventually with wildcard or default)

Returns:APIResponse

the corresponding APIResponse or null.

getAPIResponses	back to summary
public Map<String, APIResponse> getAPIResponses() Returns a copy map (potentially immutable) of the APIResponses. Returns:Map<String, APIResponse> all responses

getAPIResponses

back to summary

public Map<String, APIResponse> getAPIResponses()

Returns a copy map (potentially immutable) of the APIResponses.

Returns:Map<String, APIResponse>: all responses

getDefaultValue back to summary

getDefaultValue	back to summary
public APIResponse getDefaultValue() Returns the default documentation of responses other than the ones declared for specific HTTP response codes in this instance of ApiResponses. Convenience method that is the same as calling `getAPIResponse(String)` on the map with default as value for the key. Returns:APIResponse the default documentation of responses

public APIResponse getDefaultValue()

Returns the default documentation of responses other than the ones declared for specific HTTP response codes in this instance of ApiResponses.

Convenience method that is the same as calling getAPIResponse(String) on the map with default as value for the key.

Returns:APIResponse: the default documentation of responses

hasAPIResponse back to summary

hasAPIResponse	back to summary
public default boolean hasAPIResponse(String name) Check whether a APIResponse is present in the map. This is a convenience method for `getAPIResponses().containsKey(name)` Parameters name:String the name of APIResponse (http status code eventually with wildcard or default) Returns:boolean a boolean to indicate if the APIResponse is present or not.

public default boolean hasAPIResponse(String name)

Check whether a APIResponse is present in the map. This is a convenience method for getAPIResponses().containsKey(name)

Parameters

name:String: the name of APIResponse (http status code eventually with wildcard or default)

Returns:boolean

a boolean to indicate if the APIResponse is present or not.

removeAPIResponse	back to summary
public void removeAPIResponse(String name) Removes the given APIResponse to this APIResponses. Parameters name:String the name of APIResponse that will be removed (http status code eventually with wildcard or default)

removeAPIResponse

back to summary

public void removeAPIResponse(String name)

Removes the given APIResponse to this APIResponses.

Parameters

name:String: the name of APIResponse that will be removed (http status code eventually with wildcard or default)

setAPIResponses	back to summary
public void setAPIResponses(Map<String, APIResponse> items) Set the APIResponses map to this APIResponses Parameters items:Map<String, APIResponse> a map containing all responses. Keys are http statuses code eventually with wildcard or default.

setAPIResponses

back to summary

public void setAPIResponses(Map<String, APIResponse> items)

Set the APIResponses map to this APIResponses

Parameters

items:Map<String, APIResponse>: a map containing all responses. Keys are http statuses code eventually with wildcard or default.

setDefaultValue back to summary

setDefaultValue	back to summary
public void setDefaultValue(APIResponse defaultValue) Sets the default documentation of responses for this instance of ApiResponses. This will cover all the undeclared responses. Convenience method that is the same as calling `addAPIResponse(String, APIResponse)` with default as value for the key. Parameters defaultValue:APIResponse the default documentation of responses

public void setDefaultValue(APIResponse defaultValue)

Sets the default documentation of responses for this instance of ApiResponses. This will cover all the undeclared responses.

Convenience method that is the same as calling addAPIResponse(String, APIResponse) with default as value for the key.

Parameters

defaultValue:APIResponse: the default documentation of responses

public Interface APIResponses

Field Summary

Method Summary

Field Detail

Method Detail