json/src/main/java/net/java/html/json/Property.java
author Jaroslav Tulach <jtulach@netbeans.org>
Mon, 22 Feb 2016 06:09:33 +0100
branchNonMutable258088
changeset 1054 4c40ceb185e5
parent 831 e37388a5f7d1
permissions -rw-r--r--
#258088: Introducing @Property(mutable=false) and making sure the generated Java code yields exceptions when such properties are modified after their use by the technology
     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.Retention;
    46 import java.lang.annotation.RetentionPolicy;
    47 import java.lang.annotation.Target;
    48 import java.util.List;
    49 import org.netbeans.html.context.spi.Contexts;
    50 import org.netbeans.html.json.spi.Technology;
    51 
    52 /** Represents a property in a class defined with {@link Model} annotation.
    53  *
    54  * @author Jaroslav Tulach
    55  */
    56 @Retention(RetentionPolicy.SOURCE)
    57 @Target({})
    58 public @interface Property {
    59     /** Name of the property. Will be used to define proper getter and setter
    60      * in the associated class.
    61      * 
    62      * @return valid java identifier
    63      */
    64     String name();
    65     
    66     /** Type of the property. Can either be primitive type (like <code>int.class</code>,
    67      * <code>double.class</code>, etc.), {@link String}, {@link Enum enum} or complex model
    68      * class (defined by {@link Model} property).
    69      * 
    70      * @return the class of the property
    71      */
    72     Class<?> type();
    73     
    74     /** Is this property an array of the {@link #type()} or a single value?
    75      * If the property is an array, only its getter (returning mutable {@link List} of
    76      * the boxed {@link #type()}) is generated.
    77      * 
    78      * @return true, if this property is supposed to represent an array of values
    79      */
    80     boolean array() default false;
    81 
    82     /** Can the value of the property be mutated without restriction or not.
    83      * If a property is defined as <em>not mutable</em>, it defines
    84      * semi-immutable value that can only be changed in construction time
    85      * before the object is passed to underlying {@link Technology}. 
    86      * Attempts to modify the object later yield {@link IllegalStateException}.
    87      *
    88      * Technologies may decide to represent such non-mutable
    89      * property in more effective way - for
    90      * example Knockout Java Bindings technology (with {@link Contexts.Id id} "ko4j")
    91      * uses plain JavaScript value (number, string, array, boolean) rather
    92      * than classical observable.
    93      *
    94      * @return false if the value cannot change after its <em>first use</em>
    95      * @since 1.3
    96      */
    97     boolean mutable() default true;
    98 }