RequestParameter.java

/*-
 * #%L
 * Slice - Mapper API
 * %%
 * Copyright (C) 2012 Cognifide Limited
 * %%
 * 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.
 * #L%
 */
package com.cognifide.slice.mapper.annotation;

import java.lang.annotation.*;

/**
 * Indicates that a given field should be mapped from a request parameter . The
 * name of the request parameter is indicated by the name of the field or value of {@link RequestParameter} (if
 * specified). Only a type of string is allowed
 * Example:
 *
 * <pre>
 * {@literal @}SliceResource
 * public class ExampleModel {
 *
 *   {@literal @}RequestParameter
 *   private String myParameter;
 *
 *   {@literal @}RequestParameter("second-parameter")
 *   private String secondParameter;
 * }
 * </pre>
 *
 * @author roy.teeuwen
 *
 */
@Documented
@Target(ElementType.FIELD)
@Retention(RetentionPolicy.RUNTIME)
public @interface RequestParameter {

    /**
     * Custom request parameter name. If empty, property name is read from field's name.
     *
     * @return value
     */
    String value() default "";
}