| <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> |
| <html lang="en"> |
| <head> |
| <title>Source code</title> |
| <link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style"> |
| </head> |
| <body> |
| <div class="sourceContainer"> |
| <pre><span class="sourceLineNo">001</span>/*<a name="line.1"></a> |
| <span class="sourceLineNo">002</span> * Licensed to the Apache Software Foundation (ASF) under one or more<a name="line.2"></a> |
| <span class="sourceLineNo">003</span> * contributor license agreements. See the NOTICE file distributed with<a name="line.3"></a> |
| <span class="sourceLineNo">004</span> * this work for additional information regarding copyright ownership.<a name="line.4"></a> |
| <span class="sourceLineNo">005</span> * The ASF licenses this file to You under the Apache license, Version 2.0<a name="line.5"></a> |
| <span class="sourceLineNo">006</span> * (the "License"); you may not use this file except in compliance with<a name="line.6"></a> |
| <span class="sourceLineNo">007</span> * the License. You may obtain a copy of the License at<a name="line.7"></a> |
| <span class="sourceLineNo">008</span> *<a name="line.8"></a> |
| <span class="sourceLineNo">009</span> * http://www.apache.org/licenses/LICENSE-2.0<a name="line.9"></a> |
| <span class="sourceLineNo">010</span> *<a name="line.10"></a> |
| <span class="sourceLineNo">011</span> * Unless required by applicable law or agreed to in writing, software<a name="line.11"></a> |
| <span class="sourceLineNo">012</span> * distributed under the License is distributed on an "AS IS" BASIS,<a name="line.12"></a> |
| <span class="sourceLineNo">013</span> * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.<a name="line.13"></a> |
| <span class="sourceLineNo">014</span> * See the license for the specific language governing permissions and<a name="line.14"></a> |
| <span class="sourceLineNo">015</span> * limitations under the license.<a name="line.15"></a> |
| <span class="sourceLineNo">016</span> */<a name="line.16"></a> |
| <span class="sourceLineNo">017</span>package org.apache.logging.log4j;<a name="line.17"></a> |
| <span class="sourceLineNo">018</span><a name="line.18"></a> |
| <span class="sourceLineNo">019</span>import java.io.Serializable;<a name="line.19"></a> |
| <span class="sourceLineNo">020</span><a name="line.20"></a> |
| <span class="sourceLineNo">021</span>/**<a name="line.21"></a> |
| <span class="sourceLineNo">022</span> * Markers are objects that are used to add easily filterable information to log messages.<a name="line.22"></a> |
| <span class="sourceLineNo">023</span> *<a name="line.23"></a> |
| <span class="sourceLineNo">024</span> * Markers can be hierarchical - each Marker may have a parent. This allows for broad categories being subdivided into<a name="line.24"></a> |
| <span class="sourceLineNo">025</span> * more specific categories. An example might be a Marker named "Error" with children named "SystemError" and<a name="line.25"></a> |
| <span class="sourceLineNo">026</span> * "ApplicationError".<a name="line.26"></a> |
| <span class="sourceLineNo">027</span> */<a name="line.27"></a> |
| <span class="sourceLineNo">028</span>public interface Marker extends Serializable {<a name="line.28"></a> |
| <span class="sourceLineNo">029</span><a name="line.29"></a> |
| <span class="sourceLineNo">030</span> /**<a name="line.30"></a> |
| <span class="sourceLineNo">031</span> * Adds a Marker as a parent to this Marker.<a name="line.31"></a> |
| <span class="sourceLineNo">032</span> * <a name="line.32"></a> |
| <span class="sourceLineNo">033</span> * @param markers The parent markers to add.<a name="line.33"></a> |
| <span class="sourceLineNo">034</span> * @return The current Marker object, thus allowing multiple adds to be concatenated.<a name="line.34"></a> |
| <span class="sourceLineNo">035</span> * @throws IllegalArgumentException if the argument is {@code null}<a name="line.35"></a> |
| <span class="sourceLineNo">036</span> */<a name="line.36"></a> |
| <span class="sourceLineNo">037</span> Marker addParents(Marker... markers);<a name="line.37"></a> |
| <span class="sourceLineNo">038</span><a name="line.38"></a> |
| <span class="sourceLineNo">039</span> /**<a name="line.39"></a> |
| <span class="sourceLineNo">040</span> * Returns true if the given marker has the same name as this marker.<a name="line.40"></a> |
| <span class="sourceLineNo">041</span> *<a name="line.41"></a> |
| <span class="sourceLineNo">042</span> * @param obj the reference object with which to compare.<a name="line.42"></a> |
| <span class="sourceLineNo">043</span> * @return true if the given marker has the same name as this marker.<a name="line.43"></a> |
| <span class="sourceLineNo">044</span> * @since 2.4<a name="line.44"></a> |
| <span class="sourceLineNo">045</span> */<a name="line.45"></a> |
| <span class="sourceLineNo">046</span> @Override<a name="line.46"></a> |
| <span class="sourceLineNo">047</span> boolean equals(Object obj);<a name="line.47"></a> |
| <span class="sourceLineNo">048</span><a name="line.48"></a> |
| <span class="sourceLineNo">049</span> /**<a name="line.49"></a> |
| <span class="sourceLineNo">050</span> * Returns the name of this Marker.<a name="line.50"></a> |
| <span class="sourceLineNo">051</span> * <a name="line.51"></a> |
| <span class="sourceLineNo">052</span> * @return The name of the Marker.<a name="line.52"></a> |
| <span class="sourceLineNo">053</span> */<a name="line.53"></a> |
| <span class="sourceLineNo">054</span> String getName();<a name="line.54"></a> |
| <span class="sourceLineNo">055</span><a name="line.55"></a> |
| <span class="sourceLineNo">056</span> /**<a name="line.56"></a> |
| <span class="sourceLineNo">057</span> * Returns a list of parents of this Marker.<a name="line.57"></a> |
| <span class="sourceLineNo">058</span> * <a name="line.58"></a> |
| <span class="sourceLineNo">059</span> * @return The parent Markers or {@code null} if this Marker has no parents.<a name="line.59"></a> |
| <span class="sourceLineNo">060</span> */<a name="line.60"></a> |
| <span class="sourceLineNo">061</span> Marker[] getParents();<a name="line.61"></a> |
| <span class="sourceLineNo">062</span><a name="line.62"></a> |
| <span class="sourceLineNo">063</span> /**<a name="line.63"></a> |
| <span class="sourceLineNo">064</span> * Returns a hash code value based on the name of this marker. Markers are equal if they have the same name.<a name="line.64"></a> |
| <span class="sourceLineNo">065</span> * <a name="line.65"></a> |
| <span class="sourceLineNo">066</span> * @return the computed hash code<a name="line.66"></a> |
| <span class="sourceLineNo">067</span> * @since 2.4<a name="line.67"></a> |
| <span class="sourceLineNo">068</span> */<a name="line.68"></a> |
| <span class="sourceLineNo">069</span> @Override<a name="line.69"></a> |
| <span class="sourceLineNo">070</span> int hashCode();<a name="line.70"></a> |
| <span class="sourceLineNo">071</span><a name="line.71"></a> |
| <span class="sourceLineNo">072</span> /**<a name="line.72"></a> |
| <span class="sourceLineNo">073</span> * Indicates whether this Marker has references to any other Markers.<a name="line.73"></a> |
| <span class="sourceLineNo">074</span> * <a name="line.74"></a> |
| <span class="sourceLineNo">075</span> * @return {@code true} if the Marker has parent Markers<a name="line.75"></a> |
| <span class="sourceLineNo">076</span> */<a name="line.76"></a> |
| <span class="sourceLineNo">077</span> boolean hasParents();<a name="line.77"></a> |
| <span class="sourceLineNo">078</span><a name="line.78"></a> |
| <span class="sourceLineNo">079</span> /**<a name="line.79"></a> |
| <span class="sourceLineNo">080</span> * Checks whether this Marker is an instance of the specified Marker.<a name="line.80"></a> |
| <span class="sourceLineNo">081</span> * <a name="line.81"></a> |
| <span class="sourceLineNo">082</span> * @param m The Marker to check.<a name="line.82"></a> |
| <span class="sourceLineNo">083</span> * @return {@code true} if this Marker or one of its ancestors is the specified Marker, {@code false} otherwise.<a name="line.83"></a> |
| <span class="sourceLineNo">084</span> * @throws IllegalArgumentException if the argument is {@code null}<a name="line.84"></a> |
| <span class="sourceLineNo">085</span> */<a name="line.85"></a> |
| <span class="sourceLineNo">086</span> boolean isInstanceOf(Marker m);<a name="line.86"></a> |
| <span class="sourceLineNo">087</span><a name="line.87"></a> |
| <span class="sourceLineNo">088</span> /**<a name="line.88"></a> |
| <span class="sourceLineNo">089</span> * Checks whether this Marker is an instance of the specified Marker.<a name="line.89"></a> |
| <span class="sourceLineNo">090</span> * <a name="line.90"></a> |
| <span class="sourceLineNo">091</span> * @param name The name of the Marker.<a name="line.91"></a> |
| <span class="sourceLineNo">092</span> * @return {@code true} if this Marker or one of its ancestors matches the specified name, {@code false} otherwise.<a name="line.92"></a> |
| <span class="sourceLineNo">093</span> * @throws IllegalArgumentException if the argument is {@code null}<a name="line.93"></a> |
| <span class="sourceLineNo">094</span> */<a name="line.94"></a> |
| <span class="sourceLineNo">095</span> boolean isInstanceOf(String name);<a name="line.95"></a> |
| <span class="sourceLineNo">096</span><a name="line.96"></a> |
| <span class="sourceLineNo">097</span> /**<a name="line.97"></a> |
| <span class="sourceLineNo">098</span> * Removes the specified Marker as a parent of this Marker.<a name="line.98"></a> |
| <span class="sourceLineNo">099</span> * <a name="line.99"></a> |
| <span class="sourceLineNo">100</span> * @param marker The marker to remove.<a name="line.100"></a> |
| <span class="sourceLineNo">101</span> * @return {@code true} if the marker was removed.<a name="line.101"></a> |
| <span class="sourceLineNo">102</span> * @throws IllegalArgumentException if the argument is {@code null}<a name="line.102"></a> |
| <span class="sourceLineNo">103</span> */<a name="line.103"></a> |
| <span class="sourceLineNo">104</span> boolean remove(Marker marker);<a name="line.104"></a> |
| <span class="sourceLineNo">105</span><a name="line.105"></a> |
| <span class="sourceLineNo">106</span> /**<a name="line.106"></a> |
| <span class="sourceLineNo">107</span> * Replaces the set of parent Markers with the provided Markers.<a name="line.107"></a> |
| <span class="sourceLineNo">108</span> * <a name="line.108"></a> |
| <span class="sourceLineNo">109</span> * @param markers The new set of parent Markers or {@code null} to clear the parents.<a name="line.109"></a> |
| <span class="sourceLineNo">110</span> * @return The current Marker object.<a name="line.110"></a> |
| <span class="sourceLineNo">111</span> */<a name="line.111"></a> |
| <span class="sourceLineNo">112</span> Marker setParents(Marker... markers);<a name="line.112"></a> |
| <span class="sourceLineNo">113</span>}<a name="line.113"></a> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| </pre> |
| </div> |
| </body> |
| </html> |
