ratpack.parse.Parser Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of ratpack-core Show documentation

The core HTTP and composition mechanisms of Ratpack

There is a newer version: 2.0.0-rc-1

/*
 * Copyright 2013 the original author or authors.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *    http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package ratpack.parse;

import ratpack.api.Nullable;
import ratpack.handling.Context;
import ratpack.http.TypedData;

/**
 * A parser converts a request body into an object.
 * 
 * Parsers power the {@link Context#parse(Parse)} mechanism.
 * 

 * An individual parser parses requests of a certain content type (as advertised by {@link #getContentType()})
 * and with a particular type of object that provides any parsing options (as advertised by {@link #getOptsType()}).
 * 
 * The {@link ParserSupport} class is a convenient base; the documentation of which contains implementation examples.
 *
 * @param  the type of option object this parser accepts
 * @see Parse
 * @see ParserSupport
 * @see NoOptParserSupport
 * @see Context#parse(Parse)
 */
public interface Parser {

  /**
   * The content type that this parser knows how to deserialize.
   *
   * @return The content type that this parser knows how to deserialize.
   */
  String getContentType();

  /**
   * The type of option object that this parser accepts.
   *
   * @see ParserSupport
   * @return The type of option object that this parser accepts
   */
  Class getOptsType();

  /**
   * Deserializes the request body of the context into an object.
   *
   * @param context The context to deserialize
   * @param requestBody The request body to deserialize
   * @param parse The description of how to parse the request body
   * @param  the type of object to construct from the request body
   * @return The object representation of the request body, or {@code null} if this parser cannot parse to the requested type
   * @throws Exception if an error occurs parsing the request
   */
  @Nullable
   T parse(Context context, TypedData requestBody, Parse parse) throws Exception;

}