Package org.apache.juneau.http.entity

Class StringBody

java.lang.Object
org.apache.juneau.http.entity.StringBody
All Implemented Interfaces:
HttpBody
public final class StringBody extends Object implements HttpBody
An HttpBody backed by a UTF-8 string.

Repeatable: the same instance may be written multiple times.

Since:
9.2.1

  • Method Details

    • of

      public static StringBody of(String content)
      Creates a StringBody with the given content and text/plain; charset=UTF-8 content type.
      Parameters:
      content - The string content. Must not be null.
      Returns:
      A new instance. Never null.

    • of

      public static StringBody of(String content, String contentType)
      Creates a StringBody with the given content and content type.
      Parameters:
      content - The string content. Must not be null.
      contentType - The MIME content type (e.g. "application/json; charset=UTF-8"). May be null.
      Returns:
      A new instance. Never null.

    • getContentType

      public String getContentType()
      Description copied from interface: HttpBody
      Returns the MIME content type of this body, e.g. "application/json; charset=UTF-8".
      Specified by:
      getContentType in interface HttpBody
      Returns:
      The content type, or null if unknown.

    • getContentLength

      public long getContentLength()
      Description copied from interface: HttpBody
      Returns the content length in bytes, or -1 if unknown.

      Implementations that buffer content may return the exact length; streaming implementations should return -1 to cause the transport to use chunked transfer encoding.

      Specified by:
      getContentLength in interface HttpBody
      Returns:
      The content length, or -1 if unknown.

    • writeTo

      public void writeTo(OutputStream out) throws IOException
      Description copied from interface: HttpBody
      Writes the body content to the given output stream.

      Implementations must not close out.

      Specified by:
      writeTo in interface HttpBody
      Parameters:
      out - The stream to write to. Never null.
      Throws:
      IOException - If an I/O error occurs.

    • isRepeatable

      public boolean isRepeatable()
      Description copied from interface: HttpBody
      Returns true if this body can be written more than once.

      Streaming bodies backed by a one-shot InputStream should return false. Buffered bodies (byte arrays, strings, files) should return true.

      Specified by:
      isRepeatable in interface HttpBody
      Returns:
      true if repeatable.

    • toString

      public String toString()
      Overrides:
      toString in class Object