Package org.jboss.resteasy.plugins.providers

## Class DefaultTextPlain

- java.lang.Object
- - org.jboss.resteasy.plugins.providers.DefaultTextPlain

- All Implemented Interfaces:
    `javax.ws.rs.ext.MessageBodyReader`, `javax.ws.rs.ext.MessageBodyWriter`, `AsyncMessageBodyWriter`

      @Provider
      @Produces("text/plain")
      @Consumes("text/plain")
      public class DefaultTextPlain
      extends Object
      implements javax.ws.rs.ext.MessageBodyReader, AsyncMessageBodyWriter

  Version:
    $Revision: 1 $
  Author:
    Bill Burke

- - ### Constructor Summary

    Constructors
    Constructor | Description
    --- | ---
    `DefaultTextPlain()` |

  - ### Method Summary

    All Methods Instance Methods Concrete Methods
    Modifier and Type | Method | Description
    --- | --- | ---
    `CompletionStage<Void>` | `asyncWriteTo​(Object o, Class type, Type genericType, Annotation[] annotations, javax.ws.rs.core.MediaType mediaType, javax.ws.rs.core.MultivaluedMap httpHeaders, AsyncOutputStream entityStream)` | Write a type to an HTTP message using async IO.
    `long` | `getSize​(Object o, Class type, Type genericType, Annotation[] annotations, javax.ws.rs.core.MediaType mediaType)` |
    `boolean` | `isReadable​(Class type, Type genericType, Annotation[] annotations, javax.ws.rs.core.MediaType mediaType)` |
    `boolean` | `isWriteable​(Class type, Type genericType, Annotation[] annotations, javax.ws.rs.core.MediaType mediaType)` |
    `Object` | `readFrom​(Class type, Type genericType, Annotation[] annotations, javax.ws.rs.core.MediaType mediaType, javax.ws.rs.core.MultivaluedMap httpHeaders, InputStream entityStream)` |
    `void` | `writeTo​(Object o, Class type, Type genericType, Annotation[] annotations, javax.ws.rs.core.MediaType mediaType, javax.ws.rs.core.MultivaluedMap httpHeaders, OutputStream entityStream)` |

    - ### Methods inherited from class java.lang.Object

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

- - ### Constructor Detail

    - #### DefaultTextPlain

          public DefaultTextPlain()

  - ### Method Detail

    - #### isReadable

          public boolean isReadable​(Class type,
                                    Type genericType,
                                    Annotation[] annotations,
                                    javax.ws.rs.core.MediaType mediaType)

      Specified by:
        `isReadable` in interface `javax.ws.rs.ext.MessageBodyReader`

    - #### readFrom

          public Object readFrom​(Class type,
                                 Type genericType,
                                 Annotation[] annotations,
                                 javax.ws.rs.core.MediaType mediaType,
                                 javax.ws.rs.core.MultivaluedMap httpHeaders,
                                 InputStream entityStream)
                          throws IOException,
                                 javax.ws.rs.WebApplicationException

      Specified by:
        `readFrom` in interface `javax.ws.rs.ext.MessageBodyReader`
      Throws:
        `IOException`
        `javax.ws.rs.WebApplicationException`

    - #### isWriteable

          public boolean isWriteable​(Class type,
                                     Type genericType,
                                     Annotation[] annotations,
                                     javax.ws.rs.core.MediaType mediaType)

      Specified by:
        `isWriteable` in interface `javax.ws.rs.ext.MessageBodyWriter`

    - #### getSize

          public long getSize​(Object o,
                              Class type,
                              Type genericType,
                              Annotation[] annotations,
                              javax.ws.rs.core.MediaType mediaType)

      Specified by:
        `getSize` in interface `javax.ws.rs.ext.MessageBodyWriter`

    - #### writeTo

          public void writeTo​(Object o,
                              Class type,
                              Type genericType,
                              Annotation[] annotations,
                              javax.ws.rs.core.MediaType mediaType,
                              javax.ws.rs.core.MultivaluedMap httpHeaders,
                              OutputStream entityStream)
                       throws IOException,
                              javax.ws.rs.WebApplicationException

      Specified by:
        `writeTo` in interface `javax.ws.rs.ext.MessageBodyWriter`
      Throws:
        `IOException`
        `javax.ws.rs.WebApplicationException`

    - #### asyncWriteTo

          public CompletionStage<Void> asyncWriteTo​(Object o,
                                                    Class type,
                                                    Type genericType,
                                                    Annotation[] annotations,
                                                    javax.ws.rs.core.MediaType mediaType,
                                                    javax.ws.rs.core.MultivaluedMap httpHeaders,
                                                    AsyncOutputStream entityStream)

      Description copied from interface: `AsyncMessageBodyWriter`
      Write a type to an HTTP message using async IO. The message header map is mutable but any changes must be made before writing to the async output stream since the headers will be flushed prior to writing the message body.
      Specified by:
        `asyncWriteTo` in interface `AsyncMessageBodyWriter`
      Parameters:
        `o` - the instance to write.
        `type` - the class of instance that is to be written.
        `genericType` - the type of instance to be written. `GenericEntity` provides a way to specify this information at runtime.
        `annotations` - an array of the annotations attached to the message entity instance.
        `mediaType` - the media type of the HTTP entity.
        `httpHeaders` - a mutable map of the HTTP message headers.
        `entityStream` - the `AsyncOutputStream` for the HTTP entity. The implementation should not close the output stream.
      Returns:
        a `CompletionStage` indicating completion