json/src/main/java/net/java/html/json/ComputedProperty.java
author Jaroslav Tulach <jtulach@netbeans.org>
Sat, 02 Aug 2014 12:59:31 +0200
changeset 790 30f20d9c0986
parent 788 f8ac4d547ad3
child 951 5ce0aab2c03c
permissions -rw-r--r--
Fixing Javadoc to succeed on JDK8
jtulach@0
     1
/**
jaroslav@358
     2
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
jtulach@0
     3
 *
jaroslav@551
     4
 * Copyright 2013-2014 Oracle and/or its affiliates. All rights reserved.
jtulach@0
     5
 *
jaroslav@358
     6
 * Oracle and Java are registered trademarks of Oracle and/or its affiliates.
jaroslav@358
     7
 * Other names may be trademarks of their respective owners.
jtulach@0
     8
 *
jaroslav@358
     9
 * The contents of this file are subject to the terms of either the GNU
jaroslav@358
    10
 * General Public License Version 2 only ("GPL") or the Common
jaroslav@358
    11
 * Development and Distribution License("CDDL") (collectively, the
jaroslav@358
    12
 * "License"). You may not use this file except in compliance with the
jaroslav@358
    13
 * License. You can obtain a copy of the License at
jaroslav@358
    14
 * http://www.netbeans.org/cddl-gplv2.html
jaroslav@358
    15
 * or nbbuild/licenses/CDDL-GPL-2-CP. See the License for the
jaroslav@358
    16
 * specific language governing permissions and limitations under the
jaroslav@358
    17
 * License.  When distributing the software, include this License Header
jaroslav@358
    18
 * Notice in each file and include the License file at
jaroslav@358
    19
 * nbbuild/licenses/CDDL-GPL-2-CP.  Oracle designates this
jaroslav@358
    20
 * particular file as subject to the "Classpath" exception as provided
jaroslav@358
    21
 * by Oracle in the GPL Version 2 section of the License file that
jaroslav@358
    22
 * accompanied this code. If applicable, add the following below the
jaroslav@358
    23
 * License Header, with the fields enclosed by brackets [] replaced by
jaroslav@358
    24
 * your own identifying information:
jaroslav@358
    25
 * "Portions Copyrighted [year] [name of copyright owner]"
jaroslav@358
    26
 *
jaroslav@358
    27
 * Contributor(s):
jaroslav@358
    28
 *
jaroslav@358
    29
 * The Original Software is NetBeans. The Initial Developer of the Original
jaroslav@551
    30
 * Software is Oracle. Portions Copyright 2013-2014 Oracle. All Rights Reserved.
jaroslav@358
    31
 *
jaroslav@358
    32
 * If you wish your version of this file to be governed by only the CDDL
jaroslav@358
    33
 * or only the GPL Version 2, indicate your decision by adding
jaroslav@358
    34
 * "[Contributor] elects to include this software in this distribution
jaroslav@358
    35
 * under the [CDDL or GPL Version 2] license." If you do not indicate a
jaroslav@358
    36
 * single choice of license, a recipient has the option to distribute
jaroslav@358
    37
 * your version of this file under either the CDDL, the GPL Version 2 or
jaroslav@358
    38
 * to extend the choice of license to its licensees as provided above.
jaroslav@358
    39
 * However, if you add GPL Version 2 code and therefore, elected the GPL
jaroslav@358
    40
 * Version 2 license, then the option applies only if the new code is
jaroslav@358
    41
 * made subject to such option by the copyright holder.
jtulach@0
    42
 */
jtulach@0
    43
package net.java.html.json;
jtulach@0
    44
jtulach@0
    45
import java.lang.annotation.ElementType;
jtulach@0
    46
import java.lang.annotation.Retention;
jtulach@0
    47
import java.lang.annotation.RetentionPolicy;
jtulach@0
    48
import java.lang.annotation.Target;
jtulach@0
    49
jaroslav@32
    50
/** Can be used in classes annotated with {@link Model} annotation to
jtulach@0
    51
 * define a derived property. Value of derived property is based on values
jaroslav@32
    52
 * of {@link Property} as enumerated by {@link Model#properties()}.
jtulach@0
    53
 * <p>
jtulach@0
    54
 * The name of the derived property is the name of the method. The arguments
jaroslav@235
    55
 * of the method must match names and types of some of the properties 
jaroslav@235
    56
 * from {@link Model#properties()} list. As soon as one of these properties
jtulach@788
    57
 * changes, the method is called to recompute its new value. 
jtulach@788
    58
 * This applies to inner changes in derived properties as well - e.g.
jtulach@788
    59
 * if the dependant property is another type generated by {@link Model @Model} annotation -
jtulach@788
    60
 * changes in its own properties trigger recomputation of this derived 
jtulach@788
    61
 * property as well (since version 0.9).
jaroslav@235
    62
 * <p>
jaroslav@235
    63
 * Method's return type defines the type of the derived property. It may be
jaroslav@235
    64
 * any primitive type, {@link String}, {@link Enum enum type} or a 
jaroslav@235
    65
 * type generated by {@link Model @Model} annotation. One may 
jaroslav@235
    66
 * also return an array by returning a list of such (boxed) type
jaroslav@235
    67
 * (for example {@link java.util.List List}&lt;{@link String}&gt; or {@link java.util.List List}&lt;{@link Integer}&gt;).
jaroslav@549
    68
 * <p>
jaroslav@549
    69
 * An example testing <a target="_blank" href="http://dew.apidesign.org/dew/#7545568">
jaroslav@549
    70
 * whether a number is a prime</a> using a {@link ComputedProperty} is available
jaroslav@549
    71
 * on-line.
jtulach@0
    72
 *
jtulach@790
    73
 * @author Jaroslav Tulach
jtulach@0
    74
 */
jtulach@0
    75
@Retention(RetentionPolicy.SOURCE)
jtulach@0
    76
@Target(ElementType.METHOD)
jtulach@0
    77
public @interface ComputedProperty {
jtulach@0
    78
}