json/src/main/java/net/java/html/json/ModelOperation.java
author Jaroslav Tulach <jtulach@netbeans.org>
Wed, 09 Dec 2015 21:39:13 +0100
changeset 1023 4f906bde3a2e
parent 790 30f20d9c0986
permissions -rw-r--r--
#257039: @Model.instance() to allow storage of private (and non-JSON like) state in a model
     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 /** The threading model of classes generated by {@link Model @Model} requires
    51  * that all operations are perform from the originating thread - unless they
    52  * are invoked as {@link ModelOperation @ModelOperation} methods.
    53  * <p>
    54  * A method in a class annotated by {@link Model @Model} annotation may be
    55  * annotated by {@link ModelOperation @ModelOperation}. The method has
    56  * to be static (unless {@link Model#instance() instance mode} is on), 
    57  * non-private and return <code>void</code>. The first parameter
    58  * of the method must be the {@link Model#className() model class} followed
    59  * by any number of additional arguments.
    60  * <p>
    61  * As a result method of the same name and the same list of additional arguments
    62  * (e.g. without the first model class one) will be generated into the 
    63  * {@link Model#className() model class}. This method can be invoked on any
    64  * thread, any time and it is the responsibility of model manipulating
    65  * technology to ensure the model is available and only then call back to 
    66  * the original method annotated by {@link ModelOperation @ModelOperation}.
    67  * The call may happen synchronously (if possible), or be delayed and invoked
    68  * later (on appropriate dispatch thread), without blocking the caller.
    69  * <pre>
    70  * 
    71  * {@link Model @Model}(className="Names", properties={
    72  *   {@link Property @Property}(name = "names", type=String.class, array = true)
    73  * })
    74  * static class NamesModel {
    75  *   {@link ModelOperation @ModelOperation} static void <b>updateNames</b>(Names model, {@link java.util.List}&lt;String;gt; arr) {
    76  *     <em>// can safely access the model</em>
    77  *     model.getNames().addAll(arr);
    78  *   }
    79  * 
    80  *   static void initialize() {
    81  *     final Names pageModel = new Names();
    82  *     pageModel.applyBindings();
    83  * 
    84  *     <em>// spawn to different thread</em>
    85  *     {@link java.util.concurrent.Executors}.newSingleThreadExecutor().execute({
    86  *       List&lt;String&gt; arr = <em>// ... obtain the names somewhere from network</em>
    87  *       pageModel.<b>updateNames</b>(arr);
    88  *       // returns immediately, later it invokes the model operation
    89  *     });
    90  * 
    91  *   }
    92  * }
    93  * </pre>
    94  * 
    95  * @author Jaroslav Tulach
    96  */
    97 @Target(ElementType.METHOD)
    98 @Retention(RetentionPolicy.SOURCE)
    99 public @interface ModelOperation {
   100 }