io.github.pustike.web.BeanParam Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of pustike-web Show documentation

Web Application development library

The newest version!

/*
 * Copyright (c) 2021 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
 *
 * https://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 io.github.pustike.web;

import java.lang.annotation.Documented;
import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;

/**
 * The annotation that may be used to inject custom "parameter aggregator" object into a resource method parameter.
 * 
 * For example:
 * 
 * public class MyBean {
 *   @FormParam("myData")
 *   private String data;
 *
 *   @HeaderParam("myHeader")
 *   private String header;
 *
 *   @PathParam("id")
 *   public void setResourceId(String id) {...}
 *
 *   ...
 * }
 *
 * @Path("myresources")
 * public class MyResources {
 *   @POST
 *   @Path("{id}")
 *   public void post(@BeanParam MyBean myBean) {...}
 *
 *   ...
 * }
 * 
 */
@Target({ElementType.PARAMETER, ElementType.METHOD, ElementType.FIELD})
@Retention(RetentionPolicy.RUNTIME)
@Documented
public @interface BeanParam {
}