json/src/main/java/net/java/html/json/Component.java
author Jaroslav Tulach <jtulach@netbeans.org>
Tue, 15 Dec 2015 23:19:35 +0100
branchComponent257162
changeset 1035 3534e15dc446
permissions -rw-r--r--
Introducing @Component annotation, adding basic annotation and providing its (reflection based) implementation in ko4j module.
     1 /**
     2  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
     3  *
     4  * Copyright 2013-2014 Oracle and/or its affiliates. All rights reserved.
     5  *
     6  * Oracle and Java are registered trademarks of Oracle and/or its affiliates.
     7  * Other names may be trademarks of their respective owners.
     8  *
     9  * The contents of this file are subject to the terms of either the GNU
    10  * General Public License Version 2 only ("GPL") or the Common
    11  * Development and Distribution License("CDDL") (collectively, the
    12  * "License"). You may not use this file except in compliance with the
    13  * License. You can obtain a copy of the License at
    14  * http://www.netbeans.org/cddl-gplv2.html
    15  * or nbbuild/licenses/CDDL-GPL-2-CP. See the License for the
    16  * specific language governing permissions and limitations under the
    17  * License.  When distributing the software, include this License Header
    18  * Notice in each file and include the License file at
    19  * nbbuild/licenses/CDDL-GPL-2-CP.  Oracle designates this
    20  * particular file as subject to the "Classpath" exception as provided
    21  * by Oracle in the GPL Version 2 section of the License file that
    22  * accompanied this code. If applicable, add the following below the
    23  * License Header, with the fields enclosed by brackets [] replaced by
    24  * your own identifying information:
    25  * "Portions Copyrighted [year] [name of copyright owner]"
    26  *
    27  * Contributor(s):
    28  *
    29  * The Original Software is NetBeans. The Initial Developer of the Original
    30  * Software is Oracle. Portions Copyright 2013-2014 Oracle. All Rights Reserved.
    31  *
    32  * If you wish your version of this file to be governed by only the CDDL
    33  * or only the GPL Version 2, indicate your decision by adding
    34  * "[Contributor] elects to include this software in this distribution
    35  * under the [CDDL or GPL Version 2] license." If you do not indicate a
    36  * single choice of license, a recipient has the option to distribute
    37  * your version of this file under either the CDDL, the GPL Version 2 or
    38  * to extend the choice of license to its licensees as provided above.
    39  * However, if you add GPL Version 2 code and therefore, elected the GPL
    40  * Version 2 license, then the option applies only if the new code is
    41  * made subject to such option by the copyright holder.
    42  */
    43 package net.java.html.json;
    44 
    45 import java.lang.annotation.ElementType;
    46 import java.lang.annotation.Retention;
    47 import java.lang.annotation.RetentionPolicy;
    48 import java.lang.annotation.Target;
    49 
    50 /** Defines a reusable piece of code and UI. Put the annotation on a
    51  * method that accepts a class generated by the {@link Model} annotation
    52  * and returns another class generated with the help of the
    53  * {@link Model} annotation. The first annotation describes the
    54  * input parameters. The latter one the internal structure of the
    55  * {@link #template() declarative UI snippet}.
    56  */
    57 @Target(ElementType.METHOD)
    58 @Retention(RetentionPolicy.SOURCE)
    59 public @interface Component {
    60     /**
    61      * Gives the component a name.
    62      * @return name that one uses from the UI to reference this component
    63      */
    64     public String name();
    65     /**
    66      * Location of associated file with UI. Usually (but not always) a fragment
    67      * of HTML that
    68      * @return
    69      */
    70     public String template();
    71     /**
    72      * Technologies that should be preferred when processing the
    73      * {@link #template} of this component.
    74      * @return ids of technologies to prefer inside of the component
    75      */
    76     public String[] techIds() default {};
    77 }