View Javadoc

1   /**
2    * Licensed to jclouds, Inc. (jclouds) under one or more
3    * contributor license agreements.  See the NOTICE file
4    * distributed with this work for additional information
5    * regarding copyright ownership.  jclouds licenses this file
6    * to you under the Apache License, Version 2.0 (the
7    * "License"); you may not use this file except in compliance
8    * with the License.  You may obtain a copy of the License at
9    *
10   *   http://www.apache.org/licenses/LICENSE-2.0
11   *
12   * Unless required by applicable law or agreed to in writing,
13   * software distributed under the License is distributed on an
14   * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
15   * KIND, either express or implied.  See the License for the
16   * specific language governing permissions and limitations
17   * under the License.
18   */
19  package org.jclouds.rest.annotations;
20  
21  import static java.lang.annotation.ElementType.METHOD;
22  import static java.lang.annotation.ElementType.TYPE;
23  import static java.lang.annotation.RetentionPolicy.RUNTIME;
24  
25  import java.lang.annotation.Retention;
26  import java.lang.annotation.Target;
27  
28  import javax.ws.rs.QueryParam;
29  
30  /**
31   * Designates that default parameters will be added a map that builds the request entity.
32   * 
33   * @see QueryParam
34   * @see Payload
35   * @see MapBinder
36   * @author Adrian Cole
37   */
38  @Target( { TYPE, METHOD })
39  @Retention(RUNTIME)
40  public @interface PayloadParams {
41  
42     public static final String NULL = "MAP_PAYLOAD_NULL";
43  
44     String[] keys();
45  
46     String[] values() default NULL;
47  }