Logger.java revision 953:221a84ef44c0
1/*
2 * Copyright (c) 2010, 2014, 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 */
25package jdk.nashorn.internal.runtime.logging;
26
27import java.lang.annotation.Retention;
28import java.lang.annotation.RetentionPolicy;
29
30/**
31 * This annotation is associated with a class that has a logger.
32 * It contains a name property of the logger name. e.g. a class
33 * whose logger can be initialized by --log:fields, should be
34 * annotated @Logger(name="fields"). Multiple classes can have
35 * the same annotation, which will make them use the same logger
36 * object. Usually a class with this annotation is also a Loggable,
37 * but it is not a hard demand
38 *
39 * @see Loggable
40 */
41@Retention(RetentionPolicy.RUNTIME)
42public @interface Logger {
43    /**
44     * Get the name of the logger
45     * @return logger name
46     */
47    public String name() default "";
48}
49