17ba0605dc97fb81bde8311510d27b3ccba170008Ceki Gulcu/** 27ba0605dc97fb81bde8311510d27b3ccba170008Ceki Gulcu * Copyright (c) 2004-2011 QOS.ch 388c4c456766193e012eb890e2208473d99b91f83Ceki Gulcu * All rights reserved. 47ba0605dc97fb81bde8311510d27b3ccba170008Ceki Gulcu * 588c4c456766193e012eb890e2208473d99b91f83Ceki Gulcu * Permission is hereby granted, free of charge, to any person obtaining 688c4c456766193e012eb890e2208473d99b91f83Ceki Gulcu * a copy of this software and associated documentation files (the 788c4c456766193e012eb890e2208473d99b91f83Ceki Gulcu * "Software"), to deal in the Software without restriction, including 888c4c456766193e012eb890e2208473d99b91f83Ceki Gulcu * without limitation the rights to use, copy, modify, merge, publish, 988c4c456766193e012eb890e2208473d99b91f83Ceki Gulcu * distribute, sublicense, and/or sell copies of the Software, and to 1088c4c456766193e012eb890e2208473d99b91f83Ceki Gulcu * permit persons to whom the Software is furnished to do so, subject to 1188c4c456766193e012eb890e2208473d99b91f83Ceki Gulcu * the following conditions: 127ba0605dc97fb81bde8311510d27b3ccba170008Ceki Gulcu * 1388c4c456766193e012eb890e2208473d99b91f83Ceki Gulcu * The above copyright notice and this permission notice shall be 1488c4c456766193e012eb890e2208473d99b91f83Ceki Gulcu * included in all copies or substantial portions of the Software. 157ba0605dc97fb81bde8311510d27b3ccba170008Ceki Gulcu * 1688c4c456766193e012eb890e2208473d99b91f83Ceki Gulcu * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, 1788c4c456766193e012eb890e2208473d99b91f83Ceki Gulcu * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF 1888c4c456766193e012eb890e2208473d99b91f83Ceki Gulcu * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND 1988c4c456766193e012eb890e2208473d99b91f83Ceki Gulcu * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE 2088c4c456766193e012eb890e2208473d99b91f83Ceki Gulcu * LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION 2188c4c456766193e012eb890e2208473d99b91f83Ceki Gulcu * OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION 2288c4c456766193e012eb890e2208473d99b91f83Ceki Gulcu * WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. 237ba0605dc97fb81bde8311510d27b3ccba170008Ceki Gulcu * 2488c4c456766193e012eb890e2208473d99b91f83Ceki Gulcu */ 2588c4c456766193e012eb890e2208473d99b91f83Ceki Gulcupackage org.slf4j; 2688c4c456766193e012eb890e2208473d99b91f83Ceki Gulcu 2788c4c456766193e012eb890e2208473d99b91f83Ceki Gulcu/** 2832b9a928b342acb37098771b185ffc464efbb504Craig P. Motlin * Implementations of this interface are used to manufacture {@link Marker} 2988c4c456766193e012eb890e2208473d99b91f83Ceki Gulcu * instances. 3088c4c456766193e012eb890e2208473d99b91f83Ceki Gulcu * 3188c4c456766193e012eb890e2208473d99b91f83Ceki Gulcu * <p>See the section <a href="http://slf4j.org/faq.html#3">Implementing 329f10490a05f7344f4b3ef657e8991f5d51934e2fCeki Gulcu * the SLF4J API</a> in the FAQ for details on how to make your logging 3388c4c456766193e012eb890e2208473d99b91f83Ceki Gulcu * system conform to SLF4J. 3488c4c456766193e012eb890e2208473d99b91f83Ceki Gulcu * 3588c4c456766193e012eb890e2208473d99b91f83Ceki Gulcu * @author Ceki Gülcü 3688c4c456766193e012eb890e2208473d99b91f83Ceki Gulcu */ 3788c4c456766193e012eb890e2208473d99b91f83Ceki Gulcupublic interface IMarkerFactory { 3888c4c456766193e012eb890e2208473d99b91f83Ceki Gulcu 3931212435723e2dfd5d6716d1f6a7b0e66a1e6b38Ceki Gulcu /** 4031212435723e2dfd5d6716d1f6a7b0e66a1e6b38Ceki Gulcu * Manufacture a {@link Marker} instance by name. If the instance has been 4131212435723e2dfd5d6716d1f6a7b0e66a1e6b38Ceki Gulcu * created earlier, return the previously created instance. 4231212435723e2dfd5d6716d1f6a7b0e66a1e6b38Ceki Gulcu * 4331212435723e2dfd5d6716d1f6a7b0e66a1e6b38Ceki Gulcu * <p>Null name values are not allowed. 4431212435723e2dfd5d6716d1f6a7b0e66a1e6b38Ceki Gulcu * 4531212435723e2dfd5d6716d1f6a7b0e66a1e6b38Ceki Gulcu * @param name the name of the marker to be created, null value is 4631212435723e2dfd5d6716d1f6a7b0e66a1e6b38Ceki Gulcu * not allowed. 4731212435723e2dfd5d6716d1f6a7b0e66a1e6b38Ceki Gulcu * 4831212435723e2dfd5d6716d1f6a7b0e66a1e6b38Ceki Gulcu * @return a Marker instance 4931212435723e2dfd5d6716d1f6a7b0e66a1e6b38Ceki Gulcu */ 5031212435723e2dfd5d6716d1f6a7b0e66a1e6b38Ceki Gulcu Marker getMarker(String name); 5131212435723e2dfd5d6716d1f6a7b0e66a1e6b38Ceki Gulcu 5231212435723e2dfd5d6716d1f6a7b0e66a1e6b38Ceki Gulcu /** 5331212435723e2dfd5d6716d1f6a7b0e66a1e6b38Ceki Gulcu * Checks if the marker with the name already exists. If name is null, then false 5431212435723e2dfd5d6716d1f6a7b0e66a1e6b38Ceki Gulcu * is returned. 5531212435723e2dfd5d6716d1f6a7b0e66a1e6b38Ceki Gulcu * 5631212435723e2dfd5d6716d1f6a7b0e66a1e6b38Ceki Gulcu * @param name logger name to check for 5731212435723e2dfd5d6716d1f6a7b0e66a1e6b38Ceki Gulcu * @return true id the marker exists, false otherwise. 5831212435723e2dfd5d6716d1f6a7b0e66a1e6b38Ceki Gulcu */ 5931212435723e2dfd5d6716d1f6a7b0e66a1e6b38Ceki Gulcu boolean exists(String name); 6031212435723e2dfd5d6716d1f6a7b0e66a1e6b38Ceki Gulcu 6131212435723e2dfd5d6716d1f6a7b0e66a1e6b38Ceki Gulcu /** 6231212435723e2dfd5d6716d1f6a7b0e66a1e6b38Ceki Gulcu * Detach an existing marker. 6331212435723e2dfd5d6716d1f6a7b0e66a1e6b38Ceki Gulcu * <p> 6431212435723e2dfd5d6716d1f6a7b0e66a1e6b38Ceki Gulcu * Note that after a marker is detached, there might still be "dangling" references 6531212435723e2dfd5d6716d1f6a7b0e66a1e6b38Ceki Gulcu * to the detached marker. 6631212435723e2dfd5d6716d1f6a7b0e66a1e6b38Ceki Gulcu * 6731212435723e2dfd5d6716d1f6a7b0e66a1e6b38Ceki Gulcu * 6831212435723e2dfd5d6716d1f6a7b0e66a1e6b38Ceki Gulcu * @param name The name of the marker to detach 6931212435723e2dfd5d6716d1f6a7b0e66a1e6b38Ceki Gulcu * @return whether the marker could be detached or not 7031212435723e2dfd5d6716d1f6a7b0e66a1e6b38Ceki Gulcu */ 7131212435723e2dfd5d6716d1f6a7b0e66a1e6b38Ceki Gulcu boolean detachMarker(String name); 7231212435723e2dfd5d6716d1f6a7b0e66a1e6b38Ceki Gulcu 7331212435723e2dfd5d6716d1f6a7b0e66a1e6b38Ceki Gulcu /** 7431212435723e2dfd5d6716d1f6a7b0e66a1e6b38Ceki Gulcu * Create a marker which is detached (even at birth) from this IMarkerFactory. 7531212435723e2dfd5d6716d1f6a7b0e66a1e6b38Ceki Gulcu * 7631212435723e2dfd5d6716d1f6a7b0e66a1e6b38Ceki Gulcu * @param name marker name 7731212435723e2dfd5d6716d1f6a7b0e66a1e6b38Ceki Gulcu * @return a dangling marker 7831212435723e2dfd5d6716d1f6a7b0e66a1e6b38Ceki Gulcu * @since 1.5.1 7931212435723e2dfd5d6716d1f6a7b0e66a1e6b38Ceki Gulcu */ 8031212435723e2dfd5d6716d1f6a7b0e66a1e6b38Ceki Gulcu Marker getDetachedMarker(String name); 8188c4c456766193e012eb890e2208473d99b91f83Ceki Gulcu} 82