jdk/src/java.desktop/share/classes/java/beans/ConstructorProperties.java
changeset 25859 3317bb8137f4
parent 19213 c360667a0da2
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/jdk/src/java.desktop/share/classes/java/beans/ConstructorProperties.java	Sun Aug 17 15:54:13 2014 +0100
@@ -0,0 +1,76 @@
+/*
+ * Copyright (c) 2006, 2013, Oracle and/or its affiliates. All rights reserved.
+ * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
+ *
+ * This code is free software; you can redistribute it and/or modify it
+ * under the terms of the GNU General Public License version 2 only, as
+ * published by the Free Software Foundation.  Oracle designates this
+ * particular file as subject to the "Classpath" exception as provided
+ * by Oracle in the LICENSE file that accompanied this code.
+ *
+ * This code is distributed in the hope that it will be useful, but WITHOUT
+ * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
+ * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
+ * version 2 for more details (a copy is included in the LICENSE file that
+ * accompanied this code).
+ *
+ * You should have received a copy of the GNU General Public License version
+ * 2 along with this work; if not, write to the Free Software Foundation,
+ * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
+ *
+ * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
+ * or visit www.oracle.com if you need additional information or have any
+ * questions.
+ */
+
+package java.beans;
+
+import java.lang.annotation.*;
+import static java.lang.annotation.ElementType.*;
+import static java.lang.annotation.RetentionPolicy.*;
+
+/**
+   <p>An annotation on a constructor that shows how the parameters of
+   that constructor correspond to the constructed object's getter
+   methods.  For example:
+
+   <blockquote>
+<pre>
+   public class Point {
+       &#64;ConstructorProperties({"x", "y"})
+       public Point(int x, int y) {
+           this.x = x;
+           this.y = y;
+       }
+
+       public int getX() {
+           return x;
+       }
+
+       public int getY() {
+           return y;
+       }
+
+       private final int x, y;
+   }
+</pre>
+</blockquote>
+
+   The annotation shows that the first parameter of the constructor
+   can be retrieved with the {@code getX()} method and the second with
+   the {@code getY()} method.  Since parameter names are not in
+   general available at runtime, without the annotation there would be
+   no way to know whether the parameters correspond to {@code getX()}
+   and {@code getY()} or the other way around.
+
+   @since 1.6
+*/
+@Documented @Target(CONSTRUCTOR) @Retention(RUNTIME)
+public @interface ConstructorProperties {
+    /**
+       <p>The getter names.</p>
+       @return the getter names corresponding to the parameters in the
+       annotated constructor.
+    */
+    String[] value();
+}