Filter.java revision 4ff539dbc5a809ef3eacbe2d9f2b97f640b7e9cf 
1/*
2 * Copyright (c) 2000, 2013, 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
26
27package java.util.logging;
28
29/**
30 * A Filter can be used to provide fine grain control over
31 * what is logged, beyond the control provided by log levels.
32 * <p>
33 * Each Logger and each Handler can have a filter associated with it.
34 * The Logger or Handler will call the isLoggable method to check
35 * if a given LogRecord should be published.  If isLoggable returns
36 * false, the LogRecord will be discarded.
37 *
38 * @since 1.4
39 */
40@FunctionalInterface
41public interface Filter {
42
43    /**
44     * Check if a given log record should be published.
45     * @param record  a LogRecord
46     * @return true if the log record should be published.
47     */
48    public boolean isLoggable(LogRecord record);
49}
50