json/src/main/java/net/java/html/json/ComputedProperty.java
author Jaroslav Tulach <jaroslav.tulach@netbeans.org>
Fri, 07 Feb 2014 07:44:34 +0100
changeset 551 7ca2253fa86d
parent 549 11198031c76a
child 773 d11158498374
permissions -rw-r--r--
Updating copyright headers to mention current year
     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 /** Can be used in classes annotated with {@link Model} annotation to
    51  * define a derived property. Value of derived property is based on values
    52  * of {@link Property} as enumerated by {@link Model#properties()}.
    53  * <p>
    54  * The name of the derived property is the name of the method. The arguments
    55  * of the method must match names and types of some of the properties 
    56  * from {@link Model#properties()} list. As soon as one of these properties
    57  * changes, the method is called to recompute its new value.
    58  * <p>
    59  * Method's return type defines the type of the derived property. It may be
    60  * any primitive type, {@link String}, {@link Enum enum type} or a 
    61  * type generated by {@link Model @Model} annotation. One may 
    62  * also return an array by returning a list of such (boxed) type
    63  * (for example {@link java.util.List List}&lt;{@link String}&gt; or {@link java.util.List List}&lt;{@link Integer}&gt;).
    64  * <p>
    65  * An example testing <a target="_blank" href="http://dew.apidesign.org/dew/#7545568">
    66  * whether a number is a prime</a> using a {@link ComputedProperty} is available
    67  * on-line.
    68  *
    69  * @author Jaroslav Tulach <jtulach@netbeans.org>
    70  */
    71 @Retention(RetentionPolicy.SOURCE)
    72 @Target(ElementType.METHOD)
    73 public @interface ComputedProperty {
    74 }