001/**
002 * Copyright (C) 2006-2022 Talend Inc. - www.talend.com
003 *
004 * Licensed under the Apache License, Version 2.0 (the "License");
005 * you may not use this file except in compliance with the License.
006 * You may obtain a copy of the License at
007 *
008 * http://www.apache.org/licenses/LICENSE-2.0
009 *
010 * Unless required by applicable law or agreed to in writing, software
011 * distributed under the License is distributed on an "AS IS" BASIS,
012 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
013 * See the License for the specific language governing permissions and
014 * limitations under the License.
015 */
016package org.talend.sdk.component.api.configuration.action;
017
018import static java.lang.annotation.ElementType.FIELD;
019import static java.lang.annotation.ElementType.PARAMETER;
020import static java.lang.annotation.RetentionPolicy.RUNTIME;
021
022import java.lang.annotation.Retention;
023import java.lang.annotation.Target;
024
025import org.talend.sdk.component.api.configuration.action.meta.ActionRef;
026import org.talend.sdk.component.api.meta.Documentation;
027
028@ActionRef(Object.class)
029@Documentation("Mark the decorated field as supporting suggestions, i.e. dynamically get a list of valid values the user can use. "
030        + "It is however different from `@Suggestable` by looking up the implementation in the current application "
031        + "and not the services. Finally, it is important to note that it can do nothing in some environments too and "
032        + "that there is no guarantee the specified action is supported.")
033@Target({ FIELD, PARAMETER })
034@Retention(RUNTIME)
035public @interface BuiltInSuggestable {
036
037    /**
038     * @return name of the environment action to use.
039     */
040    Name value();
041
042    /**
043     * @return name of the environment action to use if value is {@link Name#CUSTOM}.
044     */
045    String name() default "";
046
047    // no parameter yet, this is intended since it would be too dependent on the environment for now.
048
049    enum Name {
050        CUSTOM,
051        INCOMING_SCHEMA_ENTRY_NAMES
052    }
053}