Package org.apache.pekko.http.scaladsl.model

Class StatusCodes.CustomStatusCode

java.lang.Object
org.apache.pekko.http.javadsl.model.StatusCode
org.apache.pekko.http.scaladsl.model.StatusCode
org.apache.pekko.http.scaladsl.model.StatusCodes.CustomStatusCode
All Implemented Interfaces:
Serializable, LazyValueBytesRenderable, Renderable, scala.Equals, scala.Product
Enclosing class:
StatusCodes
public static final class StatusCodes.CustomStatusCode extends StatusCode implements scala.Product, Serializable
See Also:

  • Constructor Summary

    Constructors
    Constructor
    Description
    CustomStatusCode(int intValue, String reason, String defaultMessage, boolean isSuccess, boolean allowsEntity)
     

  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
    allowsEntity()
    Returns if a response with this status-code is allowed to be accompanied with a non-empty entity.
    String
    defaultMessage()
    Returns the default message to be included as the content of an Http response with this status-code.
    int
    intValue()
    Returns the numeric code of this status code.
    boolean
    isFailure()
    Returns if the status-code represents failure.
    boolean
    isRedirection()
    Returns if the status-code is a redirection status code.
    boolean
    isSuccess()
    Returns if the status-code represents success.
    String
    reason()
    Returns the reason message for this status code.

    Methods inherited from class org.apache.pekko.http.scaladsl.model.StatusCode

    int2StatusCode, value

    Methods inherited from class java.lang.Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    Methods inherited from interface scala.Equals

    canEqual, equals

    Methods inherited from interface org.apache.pekko.http.impl.util.LazyValueBytesRenderable

    render, toString, valueBytes

    Methods inherited from interface scala.Product

    productArity, productElement, productElementName, productElementNames, productIterator, productPrefix

  • Constructor Details

    • CustomStatusCode

      public CustomStatusCode(int intValue, String reason, String defaultMessage, boolean isSuccess, boolean allowsEntity)

  • Method Details

    • intValue

      public int intValue()
      Description copied from class: StatusCode
      Returns the numeric code of this status code.
      Specified by:
      intValue in class StatusCode

    • reason

      public String reason()
      Description copied from class: StatusCode
      Returns the reason message for this status code.
      Specified by:
      reason in class StatusCode

    • defaultMessage

      public String defaultMessage()
      Description copied from class: StatusCode
      Returns the default message to be included as the content of an Http response with this status-code.
      Specified by:
      defaultMessage in class StatusCode

    • isSuccess

      public boolean isSuccess()
      Description copied from class: StatusCode
      Returns if the status-code represents success.
      Specified by:
      isSuccess in class StatusCode

    • allowsEntity

      public boolean allowsEntity()
      Description copied from class: StatusCode
      Returns if a response with this status-code is allowed to be accompanied with a non-empty entity.
      Specified by:
      allowsEntity in class StatusCode

    • isFailure

      public boolean isFailure()
      Description copied from class: StatusCode
      Returns if the status-code represents failure.
      Specified by:
      isFailure in class StatusCode

    • isRedirection

      public boolean isRedirection()
      Description copied from class: StatusCode
      Returns if the status-code is a redirection status code.
      Specified by:
      isRedirection in class StatusCode