org.jclouds.rest.annotations.PayloadParams Maven / Gradle / Ivy

Go to download

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

Core components to access jclouds services

The newest version!

/*
 * Licensed to the Apache Software Foundation (ASF) under one or more
 * contributor license agreements.  See the NOTICE file distributed with
 * this work for additional information regarding copyright ownership.
 * The ASF licenses this file to You 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 org.jclouds.rest.annotations;

import static java.lang.annotation.ElementType.METHOD;
import static java.lang.annotation.ElementType.TYPE;
import static java.lang.annotation.RetentionPolicy.RUNTIME;

import java.lang.annotation.Retention;
import java.lang.annotation.Target;

/**
 * Designates that default parameters will be added a map that builds the request entity.
 * 
 * @see QueryParam
 * @see Payload
 * @see MapBinder
 * @author Adrian Cole
 */
@Target( { TYPE, METHOD })
@Retention(RUNTIME)
public @interface PayloadParams {

   public static final String NULL = "MAP_PAYLOAD_NULL";

   String[] keys();

   String[] values() default NULL;
}