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.component;
017
018import static java.lang.annotation.ElementType.PACKAGE;
019import static java.lang.annotation.RetentionPolicy.RUNTIME;
020
021import java.lang.annotation.Retention;
022import java.lang.annotation.Target;
023
024/**
025 * Enable to configure the component by module (package).
026 */
027@Target(PACKAGE)
028@Retention(RUNTIME)
029public @interface Components {
030
031    /**
032     * @return the family value for all classes needing a component in this package or subpackages.
033     */
034    String family();
035
036    /**
037     * The categories of the nested components (in the package).
038     * You can use <code>${family}</code> to represent the family in the category.
039     * If not present it will be appended at the end, for example <code>Misc</code>
040     * will become <code>Misc/${family}</code>.
041     *
042     * @return the categories to associate to this component. Default to "Misc".
043     */
044    String[] categories() default { "Misc" };
045}