blob: 985eb49bd8504025aaf633c2c923438e629e938d [file] [log] [blame]
<HTML>
<BODY BGCOLOR="white">
<PRE>
<FONT color="green">001</FONT> /*<a name="line.1"></a>
<FONT color="green">002</FONT> * Licensed to the Apache Software Foundation (ASF) under one or more<a name="line.2"></a>
<FONT color="green">003</FONT> * contributor license agreements. See the NOTICE file distributed with<a name="line.3"></a>
<FONT color="green">004</FONT> * this work for additional information regarding copyright ownership.<a name="line.4"></a>
<FONT color="green">005</FONT> * The ASF licenses this file to You under the Apache license, Version 2.0<a name="line.5"></a>
<FONT color="green">006</FONT> * (the "License"); you may not use this file except in compliance with<a name="line.6"></a>
<FONT color="green">007</FONT> * the License. You may obtain a copy of the License at<a name="line.7"></a>
<FONT color="green">008</FONT> *<a name="line.8"></a>
<FONT color="green">009</FONT> * http://www.apache.org/licenses/LICENSE-2.0<a name="line.9"></a>
<FONT color="green">010</FONT> *<a name="line.10"></a>
<FONT color="green">011</FONT> * Unless required by applicable law or agreed to in writing, software<a name="line.11"></a>
<FONT color="green">012</FONT> * distributed under the License is distributed on an "AS IS" BASIS,<a name="line.12"></a>
<FONT color="green">013</FONT> * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.<a name="line.13"></a>
<FONT color="green">014</FONT> * See the license for the specific language governing permissions and<a name="line.14"></a>
<FONT color="green">015</FONT> * limitations under the license.<a name="line.15"></a>
<FONT color="green">016</FONT> */<a name="line.16"></a>
<FONT color="green">017</FONT> package org.apache.logging.log4j;<a name="line.17"></a>
<FONT color="green">018</FONT> <a name="line.18"></a>
<FONT color="green">019</FONT> import java.io.Serializable;<a name="line.19"></a>
<FONT color="green">020</FONT> <a name="line.20"></a>
<FONT color="green">021</FONT> /**<a name="line.21"></a>
<FONT color="green">022</FONT> * Markers are objects that are used to add easily filterable information to log messages.<a name="line.22"></a>
<FONT color="green">023</FONT> *<a name="line.23"></a>
<FONT color="green">024</FONT> * Markers can be hierarchical - each Marker may have a parent. This allows for broad categories<a name="line.24"></a>
<FONT color="green">025</FONT> * being subdivided into more specific categories. An example might be a Marker named "Error" with<a name="line.25"></a>
<FONT color="green">026</FONT> * children named "SystemError" and "ApplicationError".<a name="line.26"></a>
<FONT color="green">027</FONT> */<a name="line.27"></a>
<FONT color="green">028</FONT> public interface Marker extends Serializable {<a name="line.28"></a>
<FONT color="green">029</FONT> <a name="line.29"></a>
<FONT color="green">030</FONT> /**<a name="line.30"></a>
<FONT color="green">031</FONT> * Returns the name of this Marker.<a name="line.31"></a>
<FONT color="green">032</FONT> * @return The name of the Marker.<a name="line.32"></a>
<FONT color="green">033</FONT> */<a name="line.33"></a>
<FONT color="green">034</FONT> String getName();<a name="line.34"></a>
<FONT color="green">035</FONT> <a name="line.35"></a>
<FONT color="green">036</FONT> /**<a name="line.36"></a>
<FONT color="green">037</FONT> * Returns the parent of this Marker.<a name="line.37"></a>
<FONT color="green">038</FONT> * @return The parent Marker or null if this Marker has no parent.<a name="line.38"></a>
<FONT color="green">039</FONT> */<a name="line.39"></a>
<FONT color="green">040</FONT> Marker getParent();<a name="line.40"></a>
<FONT color="green">041</FONT> <a name="line.41"></a>
<FONT color="green">042</FONT> /**<a name="line.42"></a>
<FONT color="green">043</FONT> * Checks whether this Marker is an instance of the specified Marker.<a name="line.43"></a>
<FONT color="green">044</FONT> * @param m The Marker to check.<a name="line.44"></a>
<FONT color="green">045</FONT> * @return true of this Marker or one of its ancestors is the specified Marker, false otherwise.<a name="line.45"></a>
<FONT color="green">046</FONT> */<a name="line.46"></a>
<FONT color="green">047</FONT> boolean isInstanceOf(Marker m);<a name="line.47"></a>
<FONT color="green">048</FONT> }<a name="line.48"></a>
</PRE>
</BODY>
</HTML>