javaquery/api/src/main/java/org/apidesign/bck2brwsr/htmlpage/api/OnReceive.java
branchmodel
changeset 934 19b4ddc302a6
child 954 6448c284fe21
     1.1 --- /dev/null	Thu Jan 01 00:00:00 1970 +0000
     1.2 +++ b/javaquery/api/src/main/java/org/apidesign/bck2brwsr/htmlpage/api/OnReceive.java	Fri Apr 05 12:43:17 2013 +0200
     1.3 @@ -0,0 +1,41 @@
     1.4 +/**
     1.5 + * Back 2 Browser Bytecode Translator
     1.6 + * Copyright (C) 2012 Jaroslav Tulach <jaroslav.tulach@apidesign.org>
     1.7 + *
     1.8 + * This program is free software: you can redistribute it and/or modify
     1.9 + * it under the terms of the GNU General Public License as published by
    1.10 + * the Free Software Foundation, version 2 of the License.
    1.11 + *
    1.12 + * This program is distributed in the hope that it will be useful,
    1.13 + * but WITHOUT ANY WARRANTY; without even the implied warranty of
    1.14 + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
    1.15 + * GNU General Public License for more details.
    1.16 + *
    1.17 + * You should have received a copy of the GNU General Public License
    1.18 + * along with this program. Look for COPYING file in the top folder.
    1.19 + * If not, see http://opensource.org/licenses/GPL-2.0.
    1.20 + */
    1.21 +package org.apidesign.bck2brwsr.htmlpage.api;
    1.22 +
    1.23 +import java.lang.annotation.ElementType;
    1.24 +import java.lang.annotation.Retention;
    1.25 +import java.lang.annotation.RetentionPolicy;
    1.26 +import java.lang.annotation.Target;
    1.27 +
    1.28 +/** Static methods in classes annotated by {@link Model} or {@link Page}
    1.29 + * can be marked by this annotation establish a JSON communication point.
    1.30 + * The associated model page then gets new method to invoke a network
    1.31 + * connection 
    1.32 + * 
    1.33 + * @author Jaroslav Tulach <jtulach@netbeans.org>
    1.34 + */
    1.35 +@Retention(RetentionPolicy.SOURCE)
    1.36 +@Target(ElementType.METHOD)
    1.37 +public @interface OnReceive {
    1.38 +    /** The URL to connect to. Can contain variable names surrounded by '{' and '}'.
    1.39 +     * Those parameters will then become variables of the associated method.
    1.40 +     * 
    1.41 +     * @return the (possibly parametrized) url to connect to
    1.42 +     */
    1.43 +    String url();
    1.44 +}