1 /*
2 * The contents of this file are subject to the terms of the Common Development and
3 * Distribution License (the License). You may not use this file except in compliance with the
4 * License.
5 *
6 * You can obtain a copy of the License at legal/CDDLv1.0.txt. See the License for the
7 * specific language governing permission and limitations under the License.
8 *
9 * When distributing Covered Software, include this CDDL Header Notice in each file and include
10 * the License file at legal/CDDLv1.0.txt. If applicable, add the following below the CDDL
11 * Header, with the fields enclosed by brackets [] replaced by your own identifying
12 * information: "Portions copyright [year] [name of copyright owner]".
13 *
14 * Copyright 2016 ForgeRock AS.
15 */
16
17 package org.forgerock.api.annotations;
18
19 import org.forgerock.api.enums.ParameterSource;
20
21 /**
22 * A extra parameter to an operation.
23 */
24 public @interface Parameter {
25 /** The name of the parameter. */
26 String name();
27 /** The type semantics of the String value. */
28 String type();
29 /** The default value, if applicable. Should not be an empty string. */
30 String defaultValue() default "";
31 /** A description of the parameter. */
32 String description() default "";
33 /** The source of the parameter. Defaults to {@code PATH}. */
34 ParameterSource source() default ParameterSource.PATH;
35 /** Whether the parameter is required. Defaults to {@code true}. */
36 boolean required() default true;
37 /** Enumeration of acceptable values, if required. */
38 String[] enumValues() default {};
39 /** Titles of enumeration values. */
40 String[] enumTitles() default {};
41 }