Package org.springframework.http
Interface HttpStatusCode
- All Superinterfaces:
Serializable
- All Known Implementing Classes:
HttpStatus
Represents an HTTP response status code. Implemented by
HttpStatus
,
but defined as an interface to allow for values not in that enumeration.- Since:
- 6.0
- Author:
- Arjen Poutsma
- See Also:
-
Method Summary
Modifier and TypeMethodDescriptionboolean
Whether this status code is in the Informational class (1xx
).boolean
Whether this status code is in the Successful class (2xx
).boolean
Whether this status code is in the Redirection class (3xx
).boolean
Whether this status code is in the Client Error class (4xx
).boolean
Whether this status code is in the Server Error class (5xx
).boolean
isError()
Whether this status code is in the Client or Server Error classdefault boolean
isSameCodeAs
(HttpStatusCode other) Whether thisHttpStatusCode
shares the same integervalue
as the other status code.int
value()
Return the integer value of this status code.static HttpStatusCode
valueOf
(int code) Return anHttpStatusCode
object for the given integer value.
-
Method Details
-
value
int value()Return the integer value of this status code. -
is1xxInformational
boolean is1xxInformational()Whether this status code is in the Informational class (1xx
).- See Also:
-
is2xxSuccessful
boolean is2xxSuccessful()Whether this status code is in the Successful class (2xx
).- See Also:
-
is3xxRedirection
boolean is3xxRedirection()Whether this status code is in the Redirection class (3xx
).- See Also:
-
is4xxClientError
boolean is4xxClientError()Whether this status code is in the Client Error class (4xx
).- See Also:
-
is5xxServerError
boolean is5xxServerError()Whether this status code is in the Server Error class (5xx
).- See Also:
-
isError
boolean isError()Whether this status code is in the Client or Server Error class- See Also:
-
- RFC 2616
- RFC 2616
(
4xx
or5xx
). is4xxClientError()
is5xxServerError()
-
isSameCodeAs
Whether thisHttpStatusCode
shares the same integervalue
as the other status code.Useful for comparisons that take deprecated aliases into account or compare arbitrary implementations of
HttpStatusCode
(for example, in place ofHttpStatus enum equality
).- Parameters:
other
- the otherHttpStatusCode
to compare- Returns:
- true if the two
HttpStatusCode
objects share the same integervalue()
, false otherwise - Since:
- 6.0.5
-
valueOf
Return anHttpStatusCode
object for the given integer value.- Parameters:
code
- the status code as integer- Returns:
- the corresponding
HttpStatusCode
- Throws:
IllegalArgumentException
- ifcode
is not a three-digit positive number
-