/*
 * Copyright (c) 2016, 2018, 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 jdk.jfr;

import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;

Annotation that sets a human-readable name for an element (for example, "Maximum Throughput"). 

Use headline-style capitalization, capitalize the first and last words, and
all nouns, pronouns, adjectives, verbs and adverbs. Do not include ending
punctuation.
 The label should not be used as an identifier, see Name. 
Since:
9/**
 * Annotation that sets a human-readable name for an element (for example,
 * {@code "Maximum Throughput"}).
 * <p>
 * Use headline-style capitalization, capitalize the first and last words, and
 * all nouns, pronouns, adjectives, verbs and adverbs. Do not include ending
 * punctuation.
 * <p>
 * The label should not be used as an identifier, see {@link Name}.
 *
 * @since 9
 */
@MetadataDefinition
@Target({ ElementType.TYPE, ElementType.FIELD, ElementType.METHOD })
@Retention(RetentionPolicy.RUNTIME)
public @interface Label {
    
Returns a human-readable name for the annotated element.
Returns:
a human-readable name, not null/**
     * Returns a human-readable name for the annotated element.
     *
     * @return a human-readable name, not {@code null}
     */
    String value();
}