javaquery/api/src/main/java/org/apidesign/bck2brwsr/htmlpage/api/Model.java
author Jaroslav Tulach <jaroslav.tulach@apidesign.org>
Wed, 10 Apr 2013 12:19:32 +0200
branchmodel
changeset 964 df60ba2aeb87
parent 770 26513bd377b9
child 1023 ad9a37489365
permissions -rw-r--r--
Better Javadoc with a sample code
     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.ElementType;
    21 import java.lang.annotation.Retention;
    22 import java.lang.annotation.RetentionPolicy;
    23 import java.lang.annotation.Target;
    24 
    25 /** Defines a model class named {@link #className()} which contains
    26  * defined {@link #properties()}. This class can have methods 
    27  * annotated by {@link ComputedProperty} which define derived
    28  * properties in the model class.
    29  * <p>
    30  * The {@link #className() generated class}'s <code>toString</code>
    31  * converts the state of the object into 
    32  * <a href="http://en.wikipedia.org/wiki/JSON">JSON</a> format.
    33  *
    34  * @author Jaroslav Tulach <jtulach@netbeans.org>
    35  */
    36 @Retention(RetentionPolicy.SOURCE)
    37 @Target(ElementType.TYPE)
    38 public @interface Model {
    39     /** Name of the model class */
    40     String className();
    41     /** List of properties in the model.
    42      */
    43     Property[] properties();
    44 }