org.jboss.resteasy.plugins.providers
Class YamlProvider

java.lang.Object
  extended by org.jboss.resteasy.plugins.providers.AbstractEntityProvider<java.lang.Object>
      extended by org.jboss.resteasy.plugins.providers.YamlProvider
All Implemented Interfaces:
MessageBodyReader<java.lang.Object>, MessageBodyWriter<java.lang.Object>

@Provider
public class YamlProvider
extends AbstractEntityProvider<java.lang.Object>

Provider for YAML <-> Object marshalling. Uses the following mime types:


   text/yaml
   text/x-yaml
   application/x-yaml

Author:
Martin Algesten

Constructor Summary
YamlProvider()
           
 
Method Summary
 boolean isReadable(java.lang.Class<?> type, java.lang.reflect.Type genericType, java.lang.annotation.Annotation[] annotations, MediaType mediaType)
          Ascertain if the MessageBodyReader can produce an instance of a particular type.
protected  boolean isValidType(java.lang.Class type)
           
 boolean isWriteable(java.lang.Class<?> type, java.lang.reflect.Type genericType, java.lang.annotation.Annotation[] annotations, MediaType mediaType)
          Ascertain if the MessageBodyWriter supports a particular type.
 java.lang.Object readFrom(java.lang.Class<java.lang.Object> type, java.lang.reflect.Type genericType, java.lang.annotation.Annotation[] annotations, MediaType mediaType, MultivaluedMap<java.lang.String,java.lang.String> httpHeaders, java.io.InputStream entityStream)
          Read a type from the InputStream.
 void writeTo(java.lang.Object t, java.lang.Class<?> type, java.lang.reflect.Type genericType, java.lang.annotation.Annotation[] annotations, MediaType mediaType, MultivaluedMap<java.lang.String,java.lang.Object> httpHeaders, java.io.OutputStream entityStream)
          Write a type to an HTTP response.
 
Methods inherited from class org.jboss.resteasy.plugins.providers.AbstractEntityProvider
getSize
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

YamlProvider

public YamlProvider()
Method Detail

isReadable

public boolean isReadable(java.lang.Class<?> type,
                          java.lang.reflect.Type genericType,
                          java.lang.annotation.Annotation[] annotations,
                          MediaType mediaType)
Description copied from interface: MessageBodyReader
Ascertain if the MessageBodyReader can produce an instance of a particular type.

Parameters:
type - the class of object to be produced.
genericType - the type of object to be produced. E.g. if the message body is to be converted into a method parameter, this will be the formal type of the method parameter as returned by Class.getGenericParameterTypes.
annotations - an array of the annotations on the declaration of the artifact that will be initialized with the produced instance. E.g. if the message body is to be converted into a method parameter, this will be the annotations on that parameter returned by Class.getParameterAnnotations.
mediaType - the media type of the HTTP entity.
Returns:
true if the type is supported, otherwise false.

readFrom

public java.lang.Object readFrom(java.lang.Class<java.lang.Object> type,
                                 java.lang.reflect.Type genericType,
                                 java.lang.annotation.Annotation[] annotations,
                                 MediaType mediaType,
                                 MultivaluedMap<java.lang.String,java.lang.String> httpHeaders,
                                 java.io.InputStream entityStream)
                          throws java.io.IOException,
                                 WebApplicationException
Description copied from interface: MessageBodyReader
Read a type from the InputStream.

Parameters:
type - the type that is to be read from the entity stream.
genericType - the type of object to be produced. E.g. if the message body is to be converted into a method parameter, this will be the formal type of the method parameter as returned by Class.getGenericParameterTypes.
annotations - an array of the annotations on the declaration of the artifact that will be initialized with the produced instance. E.g. if the message body is to be converted into a method parameter, this will be the annotations on that parameter returned by Class.getParameterAnnotations.
mediaType - the media type of the HTTP entity.
httpHeaders - the read-only HTTP headers associated with HTTP entity.
entityStream - the InputStream of the HTTP entity. The caller is responsible for ensuring that the input stream ends when the entity has been consumed. The implementation should not close the input stream.
Returns:
the type that was read from the stream.
Throws:
java.io.IOException - if an IO error arises
WebApplicationException - if a specific HTTP error response needs to be produced. Only effective if thrown prior to the response being committed.

isValidType

protected boolean isValidType(java.lang.Class type)

isWriteable

public boolean isWriteable(java.lang.Class<?> type,
                           java.lang.reflect.Type genericType,
                           java.lang.annotation.Annotation[] annotations,
                           MediaType mediaType)
Description copied from interface: MessageBodyWriter
Ascertain if the MessageBodyWriter supports a particular type.

Parameters:
type - the class of object that is to be written.
genericType - the type of object to be written, obtained either by reflection of a resource method return type or via inspection of the returned instance. GenericEntity provides a way to specify this information at runtime.
annotations - an array of the annotations on the resource method that returns the object.
mediaType - the media type of the HTTP entity.
Returns:
true if the type is supported, otherwise false.

writeTo

public void writeTo(java.lang.Object t,
                    java.lang.Class<?> type,
                    java.lang.reflect.Type genericType,
                    java.lang.annotation.Annotation[] annotations,
                    MediaType mediaType,
                    MultivaluedMap<java.lang.String,java.lang.Object> httpHeaders,
                    java.io.OutputStream entityStream)
             throws java.io.IOException,
                    WebApplicationException
Description copied from interface: MessageBodyWriter
Write a type to an HTTP response. The response header map is mutable but any changes must be made before writing to the output stream since the headers will be flushed prior to writing the response body.

Parameters:
t - the instance to write.
type - the class of object that is to be written.
genericType - the type of object to be written, obtained either by reflection of a resource method return type or by inspection of the returned instance. GenericEntity provides a way to specify this information at runtime.
annotations - an array of the annotations on the resource method that returns the object.
mediaType - the media type of the HTTP entity.
httpHeaders - a mutable map of the HTTP response headers.
entityStream - the OutputStream for the HTTP entity. The implementation should not close the output stream.
Throws:
java.io.IOException - if an IO error arises
WebApplicationException - if a specific HTTP error response needs to be produced. Only effective if thrown prior to the response being committed.


Copyright © 2009. All Rights Reserved.