javaquery/api/src/main/java/org/apidesign/bck2brwsr/htmlpage/api/Model.java
author Jaroslav Tulach <jaroslav.tulach@apidesign.org>
Fri, 22 Feb 2013 08:59:40 +0100
branchmodel
changeset 770 26513bd377b9
parent 490 javaquery/api/src/main/java/org/apidesign/bck2brwsr/htmlpage/api/Page.java@e089ef6785c0
child 964 df60ba2aeb87
permissions -rw-r--r--
Introducing @Model for complex record-like types
jaroslav@26
     1
/**
jaroslav@106
     2
 * Back 2 Browser Bytecode Translator
jaroslav@106
     3
 * Copyright (C) 2012 Jaroslav Tulach <jaroslav.tulach@apidesign.org>
jaroslav@26
     4
 *
jaroslav@26
     5
 * This program is free software: you can redistribute it and/or modify
jaroslav@26
     6
 * it under the terms of the GNU General Public License as published by
jaroslav@26
     7
 * the Free Software Foundation, version 2 of the License.
jaroslav@26
     8
 *
jaroslav@26
     9
 * This program is distributed in the hope that it will be useful,
jaroslav@26
    10
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
jaroslav@26
    11
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
jaroslav@26
    12
 * GNU General Public License for more details.
jaroslav@26
    13
 *
jaroslav@26
    14
 * You should have received a copy of the GNU General Public License
jaroslav@26
    15
 * along with this program. Look for COPYING file in the top folder.
jaroslav@26
    16
 * If not, see http://opensource.org/licenses/GPL-2.0.
jaroslav@26
    17
 */
jaroslav@26
    18
package org.apidesign.bck2brwsr.htmlpage.api;
jaroslav@26
    19
jaroslav@26
    20
import java.lang.annotation.ElementType;
jaroslav@26
    21
import java.lang.annotation.Retention;
jaroslav@26
    22
import java.lang.annotation.RetentionPolicy;
jaroslav@26
    23
import java.lang.annotation.Target;
jaroslav@26
    24
jaroslav@770
    25
/** Defines a model class named {@link #className()} which contains
jaroslav@770
    26
 * defined {@link #properties()}. This class can have methods 
jaroslav@770
    27
 * annotated by {@link ComputedProperty} which define derived
jaroslav@770
    28
 * properties in the model class.
jaroslav@770
    29
 * <p>
jaroslav@770
    30
 * The {@link #className() generated class} will have methods
jaroslav@770
    31
 * to convert the object <code>toJSON</code> and <code>fromJSON</code>.
jaroslav@26
    32
 *
jaroslav@26
    33
 * @author Jaroslav Tulach <jtulach@netbeans.org>
jaroslav@26
    34
 */
jaroslav@26
    35
@Retention(RetentionPolicy.SOURCE)
jaroslav@100
    36
@Target(ElementType.TYPE)
jaroslav@770
    37
public @interface Model {
jaroslav@770
    38
    /** Name of the model class */
jaroslav@770
    39
    String className();
jaroslav@770
    40
    /** List of properties in the model.
jaroslav@26
    41
     */
jaroslav@770
    42
    Property[] properties();
jaroslav@26
    43
}