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 */ 25 package jdk.nashorn.internal.runtime.logging; 26 27 import jdk.nashorn.internal.runtime.Context; 28 29 /** 30 * Interface implemented by classes that are loggable. 31 * Their instances will provide functionality for initializing 32 * a logger (usually by asking Global for it, with a reference 33 * to this.getClass()) and a method to return the logger in 34 * use 35 * 36 * Typically a class implementing this interface also has the 37 * Logger annotation 38 * 39 * @see Logger 40 */ 41 public interface Loggable { 42 /** 43 * Initialize a logger, by asking Context to get or create it 44 * and then keep it in a table by name 45 * 46 * @param context context 47 * @return the initialized logger 48 */ initLogger(final Context context)49 public DebugLogger initLogger(final Context context); 50 51 /** 52 * Return the logger in use 53 * @return logger 54 */ getLogger()55 public DebugLogger getLogger(); 56 } 57