Package org.eclipse.microprofile.openapi.models.responses

Interface APIResponses

    • Method Detail

      • addApiResponse

        @Deprecated
default APIResponses addApiResponse​(java.lang.String name,
                                    APIResponse apiResponse)
        Deprecated.
        since 1.1, use addAPIResponse(String, APIResponse) instead
        Adds an APIResponse in the format of the name as a key and the item as the value to APIResponses map
        Parameters:
        name - the name of APIResponse (http status code eventually with wildcard or "default")
        apiResponse - the APIResponse object to be added to APIResponses map. null values will be rejected (implementation will throw an exception) or ignored.
        Returns:
        APIResponses map with the added ApiResponse instance

      • addAPIResponse

        APIResponses addAPIResponse​(java.lang.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 - the name of APIResponse (http status code eventually with wildcard or "default")
        apiResponse - the APIResponse object to be added to APIResponses map. null values will be rejected (implementation will throw an exception) or ignored.
        Returns:
        APIResponses map with the added ApiResponse instance

      • removeAPIResponse

        void removeAPIResponse​(java.lang.String name)
        Removes the given APIResponse to this APIResponses.
        Parameters:
        name - the name of APIResponse that will be removed (http status code eventually with wildcard or "default")

      • getAPIResponses

        java.util.Map<java.lang.String,​APIResponse> getAPIResponses()
        Returns a copy map (potentially immutable) of the APIResponses.
        Returns:
        all responses

      • setAPIResponses

        void setAPIResponses​(java.util.Map<java.lang.String,​APIResponse> items)
        Set the APIResponses map to this APIResponses
        Parameters:
        items - a map containing all responses. Keys are http statuses code eventually with wildcard or "default".

      • hasAPIResponse

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

      • getAPIResponse

        default APIResponse getAPIResponse​(java.lang.String name)
        Returns a APIResponse for a given name. This is a convenience method for getAPIResponses().get(name)
        Parameters:
        name - the name of APIResponse (http status code eventually with wildcard or "default")
        Returns:
        the corresponding APIResponse or null.

      • get

        @Deprecated
APIResponse get​(java.lang.Object key)
        Deprecated.
        since 1.1
        In the next version, APIResponses will no longer extends Map, this method will no longer be present. Use getAPIResponse(String) instead.
        Specified by:
        get in interface java.util.Map<java.lang.String,​APIResponse>

      • containsKey

        @Deprecated
boolean containsKey​(java.lang.Object key)
        Deprecated.
        since 1.1
        In the next version, APIResponses will no longer extends Map, this method will no longer be present. Use hasAPIResponse(String) instead.
        Specified by:
        containsKey in interface java.util.Map<java.lang.String,​APIResponse>

      • putAll

        @Deprecated
void putAll​(java.util.Map<? extends java.lang.String,​? extends APIResponse> m)
        Deprecated.
        since 1.1
        In the next version, APIResponses will no longer extends Map, this method will no longer be present. Use setAPIResponses(Map) instead.
        Specified by:
        putAll in interface java.util.Map<java.lang.String,​APIResponse>

      • remove

        @Deprecated
APIResponse remove​(java.lang.Object key)
        Deprecated.
        since 1.1
        In the next version, APIResponses will no longer extends Map, this method will no longer be present. Use removeAPIResponse(String) instead.
        Specified by:
        remove in interface java.util.Map<java.lang.String,​APIResponse>

      • getDefault

        @Deprecated
default APIResponse getDefault()
        Deprecated.
        since 1.1, use @link getDefaultValue() instead
        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 get(Object) on the map with "default" as value for the key.

        Returns:
        the default documentation of responses

      • getDefaultValue

        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 get(Object) on the map with "default" as value for the key.

        Returns:
        the default documentation of responses

      • setDefaultValue

        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 - the default documentation of responses

      • defaultValue

        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 - the default documentation of responses
        Returns:
        this ApiResponses instance