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