org.apache.camel.spi.ApiParam Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of spi-annotations Show documentation

Annotations for Camel Endpoint developers

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.apache.camel.spi;

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;

/**
 * Used for annotating a {@link UriParam} parameter that its for use by API based endpoints.
 *
 * The information from this annotation provides additional information such as which API method(s) the parameter
 * supports.
 */
@Retention(RetentionPolicy.RUNTIME)
@Documented
@Target({ ElementType.FIELD })
public @interface ApiParam {

    /**
     * The API methods that the API provides of this configuration class.
     */
    ApiMethod[] apiMethods();

    /**
     * Whether the parameter is optional (in some rare circumstances the parameter may be required)
     */
    boolean optional() default false;

    /**
     * Returns a description of this parameter.
     * 
     * This is used for documentation and tooling only.
     */
    String description() default "";

}