001/**
002 * Copyright (C) 2006-2021 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.service.completion;
017
018import static java.lang.annotation.ElementType.METHOD;
019import static java.lang.annotation.RetentionPolicy.RUNTIME;
020
021import java.lang.annotation.Retention;
022import java.lang.annotation.Target;
023
024import org.talend.sdk.component.api.configuration.action.Proposable;
025import org.talend.sdk.component.api.meta.Documentation;
026import org.talend.sdk.component.api.service.ActionType;
027
028@ActionType(value = "dynamic_values", expectedReturnedType = Values.class)
029@Target(METHOD)
030@Retention(RUNTIME)
031@Documentation("Mark a method as being useful to fill potential values of a string option "
032        + "for a property denoted by its value. "
033        + "You can link a field as being completable using @Proposable(value). The resolution of the completion action "
034        + "is then done through the component family and value of the action. The callback doesn't take any parameter.")
035public @interface DynamicValues {
036
037    /**
038     * @return the value of the component family this action relates to.
039     */
040    String family() default "";
041
042    /**
043     * @return an identifier usable by
044     * {@link Proposable}
045     * to reference this method.
046     */
047    String value();
048}