HttpEntity (Play 2.5.18)

java.lang.Object
- play.http.HttpEntity

Direct Known Subclasses:

HttpEntity.Chunked, HttpEntity.Streamed, HttpEntity.Strict
```
public abstract class HttpEntity
extends java.lang.Object
```
An HTTP entity

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`HttpEntity.Chunked` A chunked entity, backed by a source of chunks.
`static class`	`HttpEntity.Streamed` A streamed entity, backed by a source.
`static class`	`HttpEntity.Strict` A strict entity, where all the data for it is in memory.

Field Summary

Fields
Modifier and Type Field and Description

static HttpEntity NO_ENTITY
No entity.

Fields
Modifier and Type	Field and Description
`static HttpEntity`	`NO_ENTITY` No entity.

Method Summary

All Methods Static Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method and Description
`abstract HttpEntity`	`as(java.lang.String contentType)` Return the entity as the given content type.
`abstract play.api.http.HttpEntity`	`asScala()`
`static HttpEntity`	`chunked(akka.stream.javadsl.Source<akka.util.ByteString,?> data, java.util.Optional<java.lang.String> contentType)` Convert the given source of ByteStrings to a chunked entity.
`java.util.concurrent.CompletionStage<akka.util.ByteString>`	`consumeData(akka.stream.Materializer mat)` Consume the data.
`abstract java.util.Optional<java.lang.Long>`	`contentLength()` The content length, if known
`abstract java.util.Optional<java.lang.String>`	`contentType()` The content type, if defined
`abstract akka.stream.javadsl.Source<akka.util.ByteString,?>`	`dataStream()` The stream of data.
`static HttpEntity`	`fromContent(play.twirl.api.Content content, java.lang.String charset)` Create an entity from the given content.
`static HttpEntity`	`fromString(java.lang.String content, java.lang.String charset)` Create an entity from the given String.
`abstract boolean`	`isKnownEmpty()` Whether the entity is known to be empty or not.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

NO_ENTITY

public static final HttpEntity NO_ENTITY

No entity.

Method Detail

contentType

public abstract java.util.Optional<java.lang.String> contentType()

The content type, if defined

isKnownEmpty
```
public abstract boolean isKnownEmpty()
```
Whether the entity is known to be empty or not.

contentLength

public abstract java.util.Optional<java.lang.Long> contentLength()

The content length, if known

dataStream

public abstract akka.stream.javadsl.Source<akka.util.ByteString,?> dataStream()

The stream of data.

as

public abstract HttpEntity as(java.lang.String contentType)

Return the entity as the given content type.

consumeData
```
public java.util.concurrent.CompletionStage<akka.util.ByteString> consumeData(akka.stream.Materializer mat)
```
Consume the data. This method should be used carefully, since if the source represents an ephemeral stream, then the entity may not be usable after this method is invoked.

asScala

public abstract play.api.http.HttpEntity asScala()

fromContent

public static final HttpEntity fromContent(play.twirl.api.Content content,
                                           java.lang.String charset)

Create an entity from the given content.

Parameters:: content - The content.; charset - The charset.

fromString

public static final HttpEntity fromString(java.lang.String content,
                                          java.lang.String charset)

Create an entity from the given String.

Parameters:: content - The content.; charset - The charset.

chunked

public static final HttpEntity chunked(akka.stream.javadsl.Source<akka.util.ByteString,?> data,
                                       java.util.Optional<java.lang.String> contentType)

Convert the given source of ByteStrings to a chunked entity.

Parameters:: data - The source.; contentType - The optional content type.
Returns:: The ByteStrings.

Class HttpEntity