root
API
Generated with
root/play.api.test/FakeHeaders

FakeHeaders

play.api.test.FakeHeaders
case class FakeHeaders(data: Seq[(String, String)]) extends Headers

Fake HTTP headers implementation.

Value parameters

data

Headers data.

Attributes

Graph
Supertypes
trait Serializable
trait Product
trait Equals
class Headers
class Object
trait Matchable
class Any
Show all

Members list

Value members

Inherited methods

def add(headers: (String, String)*): Headers

Append the given headers

Append the given headers

Attributes

Inherited from:
Headers
def apply(key: String): String

Retrieves the first header value which is associated with the given key.

Retrieves the first header value which is associated with the given key.

Attributes

Inherited from:
Headers
override def equals(that: Any): Boolean

Compares the receiver object (this) with the argument object (that) for equivalence.

Compares the receiver object (this) with the argument object (that) for equivalence.

Any implementation of this method should be an equivalence relation:

  • It is reflexive: for any instance x of type Any, x.equals(x) should return true.
  • It is symmetric: for any instances x and y of type Any, x.equals(y) should return true if and only if y.equals(x) returns true.
  • It is transitive: for any instances x, y, and z of type Any if x.equals(y) returns true and y.equals(z) returns true, then x.equals(z) should return true.

If you override this method, you should verify that your implementation remains an equivalence relation. Additionally, when overriding this method it is usually necessary to override hashCode to ensure that objects which are "equal" (o1.equals(o2) returns true) hash to the same scala.Int. (o1.hashCode.equals(o2.hashCode)).

Value parameters

that

the object to compare against this object for equality.

Attributes

Returns

true if the receiver object is equivalent to the argument; false otherwise.

Definition Classes
Headers -> Any
Inherited from:
Headers
def get(key: String): Option[String]

Optionally returns the first header value associated with a key.

Optionally returns the first header value associated with a key.

Attributes

Inherited from:
Headers
def getAll(key: String): Seq[String]

Retrieve all header values associated with the given key.

Retrieve all header values associated with the given key.

Attributes

Inherited from:
Headers
def hasBody: Boolean

True if this request has a body, so we know if we should trigger body parsing. The base implementation simply checks for the Content-Length or Transfer-Encoding headers, but subclasses (such as fake requests) may return true in other cases so the headers need not be updated to reflect the body.

True if this request has a body, so we know if we should trigger body parsing. The base implementation simply checks for the Content-Length or Transfer-Encoding headers, but subclasses (such as fake requests) may return true in other cases so the headers need not be updated to reflect the body.

Attributes

Inherited from:
Headers
def hasHeader(headerName: String): Boolean

Checks if the given header is present.

Checks if the given header is present.

Value parameters

headerName

The name of the header (case-insensitive)

Attributes

Returns

true if the request did contain the header.

Inherited from:
Headers
override def hashCode: Int

Calculate a hash code value for the object.

Calculate a hash code value for the object.

The default hashing algorithm is platform dependent.

Note that it is allowed for two objects to have identical hash codes (o1.hashCode.equals(o2.hashCode)) yet not be equal (o1.equals(o2) returns false). A degenerate implementation could always return 0. However, it is required that if two objects are equal (o1.equals(o2) returns true) that they have identical hash codes (o1.hashCode.equals(o2.hashCode)). Therefore, when overriding this method, be sure to verify that the behavior is consistent with the equals method.

Attributes

Returns

the hash code value for this object.

Definition Classes
Headers -> Any
Inherited from:
Headers
def headers: Seq[(String, String)]

The headers as a sequence of name-value pairs.

The headers as a sequence of name-value pairs.

Attributes

Inherited from:
Headers
def keys: Set[String]

Retrieve all header keys

Retrieve all header keys

Attributes

Inherited from:
Headers
def productElementNames: Iterator[String]

Attributes

Inherited from:
Product
def productIterator: Iterator[Any]

Attributes

Inherited from:
Product
def remove(keys: String*): Headers

Remove any headers with the given keys

Remove any headers with the given keys

Attributes

Inherited from:
Headers
def replace(headers: (String, String)*): Headers

Append the given headers, replacing any existing headers having the same keys

Append the given headers, replacing any existing headers having the same keys

Attributes

Inherited from:
Headers
override def toString: String

Returns a string representation of the object.

Returns a string representation of the object.

The default representation is platform dependent.

Attributes

Returns

a string representation of the object.

Definition Classes
Headers -> Any
Inherited from:
Headers

Inherited fields

lazy val asJava: Headers

Attributes

Inherited from:
Headers
lazy val toMap: Map[String, Seq[String]]

Transform the Headers to a Map

Transform the Headers to a Map

Attributes

Inherited from:
Headers
lazy val toSimpleMap: Map[String, String]

Transform the Headers to a Map by ignoring multiple values.

Transform the Headers to a Map by ignoring multiple values.

Attributes

Inherited from:
Headers
Generated with