jdk/src/share/classes/java/beans/ConstructorProperties.java
author malenkov
Tue, 11 Sep 2012 10:58:39 +0400
changeset 13773 69665c88db93
parent 5506 202f599c92aa
child 19213 c360667a0da2
permissions -rw-r--r--
7193977: REGRESSION:Java 7's JavaBeans persistence ignoring the "transient" flag on properties Reviewed-by: rupashka
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
     1
/*
5506
202f599c92aa 6943119: Rebrand source copyright notices
ohair
parents: 2
diff changeset
     2
 * Copyright (c) 2006, Oracle and/or its affiliates. All rights reserved.
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
     3
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
90ce3da70b43 Initial load
duke
parents:
diff changeset
     4
 *
90ce3da70b43 Initial load
duke
parents:
diff changeset
     5
 * This code is free software; you can redistribute it and/or modify it
90ce3da70b43 Initial load
duke
parents:
diff changeset
     6
 * under the terms of the GNU General Public License version 2 only, as
5506
202f599c92aa 6943119: Rebrand source copyright notices
ohair
parents: 2
diff changeset
     7
 * published by the Free Software Foundation.  Oracle designates this
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
     8
 * particular file as subject to the "Classpath" exception as provided
5506
202f599c92aa 6943119: Rebrand source copyright notices
ohair
parents: 2
diff changeset
     9
 * by Oracle in the LICENSE file that accompanied this code.
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
    10
 *
90ce3da70b43 Initial load
duke
parents:
diff changeset
    11
 * This code is distributed in the hope that it will be useful, but WITHOUT
90ce3da70b43 Initial load
duke
parents:
diff changeset
    12
 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
90ce3da70b43 Initial load
duke
parents:
diff changeset
    13
 * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
90ce3da70b43 Initial load
duke
parents:
diff changeset
    14
 * version 2 for more details (a copy is included in the LICENSE file that
90ce3da70b43 Initial load
duke
parents:
diff changeset
    15
 * accompanied this code).
90ce3da70b43 Initial load
duke
parents:
diff changeset
    16
 *
90ce3da70b43 Initial load
duke
parents:
diff changeset
    17
 * You should have received a copy of the GNU General Public License version
90ce3da70b43 Initial load
duke
parents:
diff changeset
    18
 * 2 along with this work; if not, write to the Free Software Foundation,
90ce3da70b43 Initial load
duke
parents:
diff changeset
    19
 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
90ce3da70b43 Initial load
duke
parents:
diff changeset
    20
 *
5506
202f599c92aa 6943119: Rebrand source copyright notices
ohair
parents: 2
diff changeset
    21
 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
202f599c92aa 6943119: Rebrand source copyright notices
ohair
parents: 2
diff changeset
    22
 * or visit www.oracle.com if you need additional information or have any
202f599c92aa 6943119: Rebrand source copyright notices
ohair
parents: 2
diff changeset
    23
 * questions.
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
    24
 */
90ce3da70b43 Initial load
duke
parents:
diff changeset
    25
90ce3da70b43 Initial load
duke
parents:
diff changeset
    26
package java.beans;
90ce3da70b43 Initial load
duke
parents:
diff changeset
    27
90ce3da70b43 Initial load
duke
parents:
diff changeset
    28
import java.lang.annotation.*;
90ce3da70b43 Initial load
duke
parents:
diff changeset
    29
import static java.lang.annotation.ElementType.*;
90ce3da70b43 Initial load
duke
parents:
diff changeset
    30
import static java.lang.annotation.RetentionPolicy.*;
90ce3da70b43 Initial load
duke
parents:
diff changeset
    31
90ce3da70b43 Initial load
duke
parents:
diff changeset
    32
/**
90ce3da70b43 Initial load
duke
parents:
diff changeset
    33
   <p>An annotation on a constructor that shows how the parameters of
90ce3da70b43 Initial load
duke
parents:
diff changeset
    34
   that constructor correspond to the constructed object's getter
90ce3da70b43 Initial load
duke
parents:
diff changeset
    35
   methods.  For example:
90ce3da70b43 Initial load
duke
parents:
diff changeset
    36
90ce3da70b43 Initial load
duke
parents:
diff changeset
    37
   <blockquote>
90ce3da70b43 Initial load
duke
parents:
diff changeset
    38
<pre>
90ce3da70b43 Initial load
duke
parents:
diff changeset
    39
   public class Point {
90ce3da70b43 Initial load
duke
parents:
diff changeset
    40
       &#64;ConstructorProperties({"x", "y"})
90ce3da70b43 Initial load
duke
parents:
diff changeset
    41
       public Point(int x, int y) {
90ce3da70b43 Initial load
duke
parents:
diff changeset
    42
           this.x = x;
90ce3da70b43 Initial load
duke
parents:
diff changeset
    43
           this.y = y;
90ce3da70b43 Initial load
duke
parents:
diff changeset
    44
       }
90ce3da70b43 Initial load
duke
parents:
diff changeset
    45
90ce3da70b43 Initial load
duke
parents:
diff changeset
    46
       public int getX() {
90ce3da70b43 Initial load
duke
parents:
diff changeset
    47
           return x;
90ce3da70b43 Initial load
duke
parents:
diff changeset
    48
       }
90ce3da70b43 Initial load
duke
parents:
diff changeset
    49
90ce3da70b43 Initial load
duke
parents:
diff changeset
    50
       public int getY() {
90ce3da70b43 Initial load
duke
parents:
diff changeset
    51
           return y;
90ce3da70b43 Initial load
duke
parents:
diff changeset
    52
       }
90ce3da70b43 Initial load
duke
parents:
diff changeset
    53
90ce3da70b43 Initial load
duke
parents:
diff changeset
    54
       private final int x, y;
90ce3da70b43 Initial load
duke
parents:
diff changeset
    55
   }
90ce3da70b43 Initial load
duke
parents:
diff changeset
    56
</pre>
90ce3da70b43 Initial load
duke
parents:
diff changeset
    57
</blockquote>
90ce3da70b43 Initial load
duke
parents:
diff changeset
    58
90ce3da70b43 Initial load
duke
parents:
diff changeset
    59
   The annotation shows that the first parameter of the constructor
90ce3da70b43 Initial load
duke
parents:
diff changeset
    60
   can be retrieved with the {@code getX()} method and the second with
90ce3da70b43 Initial load
duke
parents:
diff changeset
    61
   the {@code getY()} method.  Since parameter names are not in
90ce3da70b43 Initial load
duke
parents:
diff changeset
    62
   general available at runtime, without the annotation there would be
90ce3da70b43 Initial load
duke
parents:
diff changeset
    63
   no way to know whether the parameters correspond to {@code getX()}
90ce3da70b43 Initial load
duke
parents:
diff changeset
    64
   and {@code getY()} or the other way around.</p>
90ce3da70b43 Initial load
duke
parents:
diff changeset
    65
90ce3da70b43 Initial load
duke
parents:
diff changeset
    66
   @since 1.6
90ce3da70b43 Initial load
duke
parents:
diff changeset
    67
*/
90ce3da70b43 Initial load
duke
parents:
diff changeset
    68
@Documented @Target(CONSTRUCTOR) @Retention(RUNTIME)
90ce3da70b43 Initial load
duke
parents:
diff changeset
    69
public @interface ConstructorProperties {
90ce3da70b43 Initial load
duke
parents:
diff changeset
    70
    /**
90ce3da70b43 Initial load
duke
parents:
diff changeset
    71
       <p>The getter names.</p>
90ce3da70b43 Initial load
duke
parents:
diff changeset
    72
       @return the getter names corresponding to the parameters in the
90ce3da70b43 Initial load
duke
parents:
diff changeset
    73
       annotated constructor.
90ce3da70b43 Initial load
duke
parents:
diff changeset
    74
    */
90ce3da70b43 Initial load
duke
parents:
diff changeset
    75
    String[] value();
90ce3da70b43 Initial load
duke
parents:
diff changeset
    76
}