Package io.dropwizard.jersey.params

Class AbstractParam<T>

    • Constructor Summary

      Constructors 
      Modifier Constructor Description
      protected AbstractParam​(@Nullable String input)
      Given an input value from a client, creates a parameter wrapping its parsed value.
      protected AbstractParam​(@Nullable String input, String parameterName)
      Given an input value from a client, creates a parameter wrapping its parsed value.

    • Method Summary

      All Methods Instance Methods Abstract Methods Concrete Methods 
      Modifier and Type Method Description
      boolean equals​(Object obj)  
      protected javax.ws.rs.core.Response error​(@Nullable String input, Exception e)
      Given a string representation which was unable to be parsed and the exception thrown, produce a Response to be sent to the client.
      protected String errorMessage​(Exception e)
      Given a string representation which was unable to be parsed and the exception thrown, produce an entity to be sent to the client.
      T get()
      Returns the underlying value.
      protected javax.ws.rs.core.Response.Status getErrorStatus()
      Given a string representation which was unable to be parsed, produce a Response.Status for the Response to be sent to the client.
      int hashCode()  
      protected javax.ws.rs.core.MediaType mediaType()
      Returns the media type of the error message entity.
      protected abstract T parse​(@Nullable String input)
      Given a string representation, parse it and return an instance of the parameter type.
      String toString()  

    • Constructor Detail

      • AbstractParam

        protected AbstractParam​(@Nullable String input)
        Given an input value from a client, creates a parameter wrapping its parsed value.
        Parameters:
        input - an input value from a client request, might be null

      • AbstractParam

        protected AbstractParam​(@Nullable String input,
                        String parameterName)
        Given an input value from a client, creates a parameter wrapping its parsed value.
        Parameters:
        input - an input value from a client request, might be null
        parameterName - name of the parameter with the provided value

    • Method Detail

      • error

        protected javax.ws.rs.core.Response error​(@Nullable String input,
                                          Exception e)
        Given a string representation which was unable to be parsed and the exception thrown, produce a Response to be sent to the client. By default, generates a 400 Bad Request with a plain text entity generated by errorMessage(Exception).
        Parameters:
        input - the raw input value
        e - the exception thrown while parsing input
        Returns:
        the Response to be sent to the client

      • mediaType

        protected javax.ws.rs.core.MediaType mediaType()
        Returns the media type of the error message entity.
        Returns:
        the media type of the error message entity

      • errorMessage

        protected String errorMessage​(Exception e)
        Given a string representation which was unable to be parsed and the exception thrown, produce an entity to be sent to the client.
        Parameters:
        e - the exception thrown while parsing input
        Returns:
        the error message to be sent the client

      • getErrorStatus

        protected javax.ws.rs.core.Response.Status getErrorStatus()
        Given a string representation which was unable to be parsed, produce a Response.Status for the Response to be sent to the client.
        Returns:
        the HTTP Response.Status of the error message

      • parse

        protected abstract T parse​(@Nullable String input)
                    throws Exception
        Given a string representation, parse it and return an instance of the parameter type.
        Parameters:
        input - the raw input
        Returns:
        input, parsed as an instance of T
        Throws:
        Exception - if there is an error parsing the input

      • get

        public T get()
        Returns the underlying value.
        Returns:
        the underlying value

      • hashCode

        public int hashCode()
        Overrides:
        hashCode in class Object