javaquery/api/src/main/java/org/apidesign/bck2brwsr/htmlpage/api/Property.java
author Jaroslav Tulach <jaroslav.tulach@apidesign.org>
Fri, 22 Feb 2013 08:59:40 +0100
branchmodel
changeset 770 26513bd377b9
parent 760 4bd6f3bc6c64
child 1023 ad9a37489365
permissions -rw-r--r--
Introducing @Model for complex record-like types
     1 /**
     2  * Back 2 Browser Bytecode Translator
     3  * Copyright (C) 2012 Jaroslav Tulach <jaroslav.tulach@apidesign.org>
     4  *
     5  * This program is free software: you can redistribute it and/or modify
     6  * it under the terms of the GNU General Public License as published by
     7  * the Free Software Foundation, version 2 of the License.
     8  *
     9  * This program is distributed in the hope that it will be useful,
    10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
    11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
    12  * GNU General Public License for more details.
    13  *
    14  * You should have received a copy of the GNU General Public License
    15  * along with this program. Look for COPYING file in the top folder.
    16  * If not, see http://opensource.org/licenses/GPL-2.0.
    17  */
    18 package org.apidesign.bck2brwsr.htmlpage.api;
    19 
    20 import java.lang.annotation.Retention;
    21 import java.lang.annotation.RetentionPolicy;
    22 import java.lang.annotation.Target;
    23 import java.util.List;
    24 
    25 /** Represents a property. Either in a generated model of an HTML
    26  * {@link Page} or in a class defined by {@link Model}.
    27  *
    28  * @author Jaroslav Tulach <jtulach@netbeans.org>
    29  */
    30 @Retention(RetentionPolicy.SOURCE)
    31 @Target({})
    32 public @interface Property {
    33     /** Name of the property. Will be used to define proper getter and setter
    34      * in the associated class.
    35      * 
    36      * @return valid java identifier
    37      */
    38     String name();
    39     
    40     /** Type of the property. Can either be primitive type (like <code>int.class</code>,
    41      * <code>double.class</code>, etc.), {@link String} or complex model
    42      * class (defined by {@link Model} property).
    43      * 
    44      * @return the class of the property
    45      */
    46     Class<?> type();
    47     
    48     /** Is this property an array of the {@link #type()} or a single value?
    49      * If the property is an array, only its getter (returning mutable {@link List} of
    50      * the boxed {@link #type()}).
    51      * 
    52      * @return true, if this is supposed to be an array of values.
    53      */
    54     boolean array() default false;
    55 }