xref: /openjdk9/nashorn/src/jdk.scripting.nashorn/share/classes/jdk/nashorn/internal/runtime/logging/Logger.java

/*
 * Copyright (c) 2010, 2014, 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.nashorn.internal.runtime.logging;

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

/**
 * This annotation is associated with a class that has a logger.
 * It contains a name property of the logger name. e.g. a class
 * whose logger can be initialized by --log:fields, should be
 * annotated @Logger(name="fields"). Multiple classes can have
 * the same annotation, which will make them use the same logger
 * object. Usually a class with this annotation is also a Loggable,
 * but it is not a hard demand
 *
 * @see Loggable
 */
@Retention(RetentionPolicy.RUNTIME)
public @interface Logger {
    /**
     * Get the name of the logger
     * @return logger name
     */
    public String name() default "";
}