2 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
4 * Copyright 2013-2014 Oracle and/or its affiliates. All rights reserved.
6 * Oracle and Java are registered trademarks of Oracle and/or its affiliates.
7 * Other names may be trademarks of their respective owners.
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]"
29 * The Original Software is NetBeans. The Initial Developer of the Original
30 * Software is Oracle. Portions Copyright 2013-2014 Oracle. All Rights Reserved.
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.
43 package org.apidesign.html.json.spi;
45 import net.java.html.json.Model;
46 import net.java.html.json.Models;
48 /** An implementation of a binding between model classes (see {@link Model})
49 * and particular technology like <a href="http://knockoutjs.com">knockout.js</a>
50 * in a browser window, etc.
52 * @author Jaroslav Tulach <jtulach@netbeans.org>
54 public interface Technology<Data> {
55 /** Creates an object to wrap the provided model object. The model
56 * has previously been generated by annotation processor associated
57 * with {@link Model} annotation.
59 * @param model the model generated from {@link Model}
60 * @return internal object representing the model
62 public Data wrapModel(Object model);
64 /** Converts an element potentially representing a model into the model.
65 * @param modelClass expected class to convert the data to
66 * @param data the current data provided from the browser
67 * @return the instance of modelClass somehow extracted from the data, may return <code>null</code>
69 public <M> M toModel(Class<M> modelClass, Object data);
71 /** Binds a property between the model and the data as used by the technology.
73 * @param b the description of the requested binding
74 * @param model the original instance of the model
75 * @param data the data to bind with the model
77 public void bind(PropertyBinding b, Object model, Data data);
79 /** Model for given data has changed its value. The technology is
80 * supposed to update its state (for example DOM nodes associated
81 * with the model). The update usually happens asynchronously.
83 * @param data technology's own representation of the model
84 * @param propertyName name of the model property that changed
86 public void valueHasMutated(Data data, String propertyName);
88 public void expose(FunctionBinding fb, Object model, Data d);
90 /** Applies given data to current context (usually an HTML page).
91 * @param data the data to apply
93 public void applyBindings(Data data);
96 * Some technologies may require wrapping a Java array into a special
97 * object. In such case they may return it from this method.
99 * @param arr original array
100 * @return wrapped array
102 public Object wrapArray(Object[] arr);
105 * Run given runnable in a safe mode. If the runnable can be executed
106 * immediately, do it. If we need to switch to some other thread, do it
107 * and invoke r asynchronously immediately returning from the call to
110 * @param r the runnable to execute
112 public void runSafe(Runnable r);
114 /** For certain rendering technologies it may be more efficient to register
115 * property and function bindings for one instance of the model at once,
116 * rather then doing it incrementally via
117 * {@link Technology#expose(org.apidesign.html.json.spi.FunctionBinding, java.lang.Object, java.lang.Object) }
119 * {@link Technology#bind(org.apidesign.html.json.spi.PropertyBinding, java.lang.Object, java.lang.Object) }.
120 * In such case implement the {@link #wrapModel(java.lang.Object, org.apidesign.html.json.spi.PropertyBinding[], org.apidesign.html.json.spi.FunctionBinding[]) }
121 * method of this interface and it will be called instead of the
126 public static interface BatchInit<D> extends Technology<D> {
127 /** Wrap the given model into redering technology appropriate object
128 * <code>D</code> and expose given properties and functions on it.
130 * @param model the {@link Models#isModel(java.lang.Class) model} in Java
131 * @param propArr array of property bindings to expose
132 * @param funcArr array of functions to expose
133 * @return appropriate wrapper around the model
135 public D wrapModel(Object model, PropertyBinding[] propArr, FunctionBinding[] funcArr);