src/java.management/share/classes/javax/management/ConstructorParameters.java
author darcy
Wed, 23 Oct 2019 13:01:40 -0700
changeset 58766 54ffb15c4839
parent 47216 71c04702a3d5
permissions -rw-r--r--
8232442: Suppress warnings on non-serializable non-transient instance fields in java.management.* Reviewed-by: rriggs, mchung
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
     1
/*
39759
427916042881 8161718: Copyright/License updates to corba, jdk
bchristi
parents: 35302
diff changeset
     2
 * Copyright (c) 2006, 2015, 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
33499
d4f084ec39eb 8139727: Define ConstructorParameters annotation type for MXBeans
jbachorik
parents: 25859
diff changeset
    26
package javax.management;
2
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
/**
33499
d4f084ec39eb 8139727: Define ConstructorParameters annotation type for MXBeans
jbachorik
parents: 25859
diff changeset
    33
 * <p>
d4f084ec39eb 8139727: Define ConstructorParameters annotation type for MXBeans
jbachorik
parents: 25859
diff changeset
    34
 * An annotation on a constructor that shows how the parameters of
d4f084ec39eb 8139727: Define ConstructorParameters annotation type for MXBeans
jbachorik
parents: 25859
diff changeset
    35
 * that constructor correspond to the constructed object's getter
d4f084ec39eb 8139727: Define ConstructorParameters annotation type for MXBeans
jbachorik
parents: 25859
diff changeset
    36
 * methods.  For example:
d4f084ec39eb 8139727: Define ConstructorParameters annotation type for MXBeans
jbachorik
parents: 25859
diff changeset
    37
 * </p>
d4f084ec39eb 8139727: Define ConstructorParameters annotation type for MXBeans
jbachorik
parents: 25859
diff changeset
    38
 * <blockquote>
d4f084ec39eb 8139727: Define ConstructorParameters annotation type for MXBeans
jbachorik
parents: 25859
diff changeset
    39
 *     <pre>
d4f084ec39eb 8139727: Define ConstructorParameters annotation type for MXBeans
jbachorik
parents: 25859
diff changeset
    40
 *         public class MemoryUsage {
d4f084ec39eb 8139727: Define ConstructorParameters annotation type for MXBeans
jbachorik
parents: 25859
diff changeset
    41
 *             // standard JavaBean conventions with getters
d4f084ec39eb 8139727: Define ConstructorParameters annotation type for MXBeans
jbachorik
parents: 25859
diff changeset
    42
 *             <b>@ConstructorParameters({"init", "used", "committed", "max"})</b>
d4f084ec39eb 8139727: Define ConstructorParameters annotation type for MXBeans
jbachorik
parents: 25859
diff changeset
    43
 *             public MemoryUsage(long init, long used,
d4f084ec39eb 8139727: Define ConstructorParameters annotation type for MXBeans
jbachorik
parents: 25859
diff changeset
    44
 *                                long committed, long max) {...}
d4f084ec39eb 8139727: Define ConstructorParameters annotation type for MXBeans
jbachorik
parents: 25859
diff changeset
    45
 *             public long getInit() {...}
d4f084ec39eb 8139727: Define ConstructorParameters annotation type for MXBeans
jbachorik
parents: 25859
diff changeset
    46
 *             public long getUsed() {...}
d4f084ec39eb 8139727: Define ConstructorParameters annotation type for MXBeans
jbachorik
parents: 25859
diff changeset
    47
 *             public long getCommitted() {...}
d4f084ec39eb 8139727: Define ConstructorParameters annotation type for MXBeans
jbachorik
parents: 25859
diff changeset
    48
 *             public long getMax() {...}
d4f084ec39eb 8139727: Define ConstructorParameters annotation type for MXBeans
jbachorik
parents: 25859
diff changeset
    49
 *         }
d4f084ec39eb 8139727: Define ConstructorParameters annotation type for MXBeans
jbachorik
parents: 25859
diff changeset
    50
 *     </pre>
d4f084ec39eb 8139727: Define ConstructorParameters annotation type for MXBeans
jbachorik
parents: 25859
diff changeset
    51
 * </blockquote>
d4f084ec39eb 8139727: Define ConstructorParameters annotation type for MXBeans
jbachorik
parents: 25859
diff changeset
    52
 * <p>
d4f084ec39eb 8139727: Define ConstructorParameters annotation type for MXBeans
jbachorik
parents: 25859
diff changeset
    53
 * The annotation shows that the first parameter of the constructor
d4f084ec39eb 8139727: Define ConstructorParameters annotation type for MXBeans
jbachorik
parents: 25859
diff changeset
    54
 * can be retrieved with the {@code getInit()} method, the second one with
d4f084ec39eb 8139727: Define ConstructorParameters annotation type for MXBeans
jbachorik
parents: 25859
diff changeset
    55
 * the {@code getUsed()} method, and so on. Since parameter names are not in
d4f084ec39eb 8139727: Define ConstructorParameters annotation type for MXBeans
jbachorik
parents: 25859
diff changeset
    56
 * general available at runtime, without the annotation there would be
d4f084ec39eb 8139727: Define ConstructorParameters annotation type for MXBeans
jbachorik
parents: 25859
diff changeset
    57
 * no way of knowing which parameter corresponds to which property.
d4f084ec39eb 8139727: Define ConstructorParameters annotation type for MXBeans
jbachorik
parents: 25859
diff changeset
    58
 * </p>
d4f084ec39eb 8139727: Define ConstructorParameters annotation type for MXBeans
jbachorik
parents: 25859
diff changeset
    59
 * <p>
d4f084ec39eb 8139727: Define ConstructorParameters annotation type for MXBeans
jbachorik
parents: 25859
diff changeset
    60
 * If a constructor is annotated by the both {@code @java.beans.ConstructorProperties}
d4f084ec39eb 8139727: Define ConstructorParameters annotation type for MXBeans
jbachorik
parents: 25859
diff changeset
    61
 * and {@code @javax.management.ConstructorParameters} annotations
d4f084ec39eb 8139727: Define ConstructorParameters annotation type for MXBeans
jbachorik
parents: 25859
diff changeset
    62
 * the JMX introspection will give an absolute precedence to the latter one.
d4f084ec39eb 8139727: Define ConstructorParameters annotation type for MXBeans
jbachorik
parents: 25859
diff changeset
    63
 * </p>
d4f084ec39eb 8139727: Define ConstructorParameters annotation type for MXBeans
jbachorik
parents: 25859
diff changeset
    64
 *
35302
e4d2275861c3 8136494: Update "@since 1.9" to "@since 9" to match java.version.specification
iris
parents: 33499
diff changeset
    65
 * @since 9
33499
d4f084ec39eb 8139727: Define ConstructorParameters annotation type for MXBeans
jbachorik
parents: 25859
diff changeset
    66
 */
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
    67
@Documented @Target(CONSTRUCTOR) @Retention(RUNTIME)
33499
d4f084ec39eb 8139727: Define ConstructorParameters annotation type for MXBeans
jbachorik
parents: 25859
diff changeset
    68
public @interface ConstructorParameters {
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
    69
    /**
33499
d4f084ec39eb 8139727: Define ConstructorParameters annotation type for MXBeans
jbachorik
parents: 25859
diff changeset
    70
     * <p>The getter names.</p>
d4f084ec39eb 8139727: Define ConstructorParameters annotation type for MXBeans
jbachorik
parents: 25859
diff changeset
    71
     *
d4f084ec39eb 8139727: Define ConstructorParameters annotation type for MXBeans
jbachorik
parents: 25859
diff changeset
    72
     * @return the getter names corresponding to the parameters in the
d4f084ec39eb 8139727: Define ConstructorParameters annotation type for MXBeans
jbachorik
parents: 25859
diff changeset
    73
     * annotated constructor.
2
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
}