Package org.apache.juneau.httppart.bean

Class ResponseBeanMeta

java.lang.Object
org.apache.juneau.httppart.bean.ResponseBeanMeta
public class ResponseBeanMeta extends Object
Represents the metadata gathered from a parameter or class annotated with Response.
See Also:

  • Field Details

  • Method Details

    • create

      public static ResponseBeanMeta create(Type t, AnnotationWorkList annotations)
      Create metadata from specified class.
      Parameters:
      t - The class annotated with Response.
      annotations - The annotations to apply to any new part serializers or parsers.
      Returns:
      Metadata about the class, or null if class not annotated with Response.

    • create

      public static ResponseBeanMeta create(MethodInfo m, AnnotationWorkList annotations)
      Create metadata from specified method return.
      Parameters:
      m - The method annotated with Response.
      annotations - The annotations to apply to any new part serializers or parsers.
      Returns:
      Metadata about the class, or null if class not annotated with Response.

    • create

      public static ResponseBeanMeta create(ParamInfo mpi, AnnotationWorkList annotations)
      Create metadata from specified method parameter.
      Parameters:
      mpi - The method parameter.
      annotations - The annotations to apply to any new part serializers or parsers.
      Returns:
      Metadata about the class, or null if class not annotated with Response.

    • getCode

      public int getCode()
      Returns the HTTP status code.
      Returns:
      The HTTP status code.

    • getSchema

      public HttpPartSchema getSchema()
      Returns the schema information about the response object.
      Returns:
      The schema information about the response object.

    • getHeaderMethods

      public Collection<ResponseBeanPropertyMeta> getHeaderMethods()
      Returns metadata about the @Header-annotated methods.
      Returns:
      Metadata about the @Header-annotated methods, or an empty collection if none exist.

    • getContentMethod

      public ResponseBeanPropertyMeta getContentMethod()
      Returns the @Content-annotated method.
      Returns:
      The @Content-annotated method, or null if it doesn't exist.

    • getStatusMethod

      public ResponseBeanPropertyMeta getStatusMethod()
      Returns the @StatusCode-annotated method.
      Returns:
      The @StatusCode-annotated method, or null if it doesn't exist.

    • getPartSerializer

      public Optional<HttpPartSerializer> getPartSerializer()
      Returns the part serializer to use to serialize this response.
      Returns:
      The part serializer to use to serialize this response.

    • getClassMeta

      public ClassMeta<?> getClassMeta()
      Returns metadata about the class.
      Returns:
      Metadata about the class.

    • getProperty

      public ResponseBeanPropertyMeta getProperty(String name)
      Returns metadata about the bean property with the specified method getter name.
      Parameters:
      name - The bean method getter name.
      Returns:
      Metadata about the bean property, or null if none found.

    • getProperties

      public Collection<ResponseBeanPropertyMeta> getProperties()
      Returns all the annotated methods on this bean.
      Returns:
      All the annotated methods on this bean.