ch.qos.logback.core.spi.AppenderAttachableImpl Maven / Gradle / Ivy
/**
* Logback: the reliable, generic, fast and flexible logging framework.
* Copyright (C) 1999-2009, QOS.ch. All rights reserved.
*
* This program and the accompanying materials are dual-licensed under
* either the terms of the Eclipse Public License v1.0 as published by
* the Eclipse Foundation
*
* or (per the licensee's choosing)
*
* under the terms of the GNU Lesser General Public License version 2.1
* as published by the Free Software Foundation.
*/
package ch.qos.logback.core.spi;
import java.util.ArrayList;
import java.util.Iterator;
import java.util.List;
import java.util.concurrent.locks.Lock;
import java.util.concurrent.locks.ReadWriteLock;
import java.util.concurrent.locks.ReentrantReadWriteLock;
import ch.qos.logback.core.Appender;
/**
* A ReentrantReadWriteLock based implementation of the
* {@link AppenderAttachable} interface.
*
* @author Ceki Gülcü
*/
public class AppenderAttachableImpl implements AppenderAttachable {
final private List> appenderList = new ArrayList>();
final private ReadWriteLock rwLock = new ReentrantReadWriteLock();
private final Lock r = rwLock.readLock();
private final Lock w = rwLock.writeLock();
/**
* Attach an appender. If the appender is already in the list in won't be
* added again.
*/
public void addAppender(Appender newAppender) {
if (newAppender == null) {
throw new IllegalArgumentException("Null argument disallowed");
}
w.lock();
try {
if (!appenderList.contains(newAppender)) {
appenderList.add(newAppender);
}
} finally {
w.unlock();
}
}
/**
* Call the doAppend method on all attached appenders.
*/
public int appendLoopOnAppenders(E e) {
int size = 0;
r.lock();
try {
for (Appender appender : appenderList) {
appender.doAppend(e);
size++;
}
} finally {
r.unlock();
}
return size;
}
/**
* Get all attached appenders as an Enumeration. If there are no attached
* appenders null is returned.
*
* @return Iterator An iterator of attached appenders.
*/
public Iterator> iteratorForAppenders() {
List> copy;
r.lock();
try {
copy = new ArrayList>(appenderList);
} finally {
r.unlock();
}
return copy.iterator();
}
/**
* Look for an attached appender named as name.
*
* Return the appender with that name if in the list. Return null
* otherwise.
*
*/
public Appender getAppender(String name) {
if (name == null) {
return null;
}
Appender found = null;
r.lock();
try {
for (Appender appender : appenderList) {
if (name.equals(appender.getName())) {
found = appender;
break;
}
}
} finally {
r.unlock();
}
return found;
}
/**
* Returns true if the specified appender is in the list of
* attached appenders, false otherwise.
*
* @since 1.2
*/
public boolean isAttached(Appender appender) {
if (appender == null) {
return false;
}
boolean attached = false;
r.lock();
try {
for (Appender a : appenderList) {
if (a == appender) {
attached = true;
break;
}
}
} finally {
r.unlock();
}
return attached;
}
/**
* Remove and stop all previously attached appenders.
*/
public void detachAndStopAllAppenders() {
w.lock();
try {
for (Appender a : appenderList) {
a.stop();
}
appenderList.clear();
} finally {
w.unlock();
}
}
/**
* Remove the appender passed as parameter form the list of attached
* appenders.
*/
public boolean detachAppender(Appender appender) {
if (appender == null) {
return false;
}
boolean result;
w.lock();
try {
result = appenderList.remove(appender);
} finally {
w.unlock();
}
return result;
}
/**
* Remove the appender with the name passed as parameter form the list of
* appenders.
*/
public boolean detachAppender(String name) {
if (name == null) {
return false;
}
boolean removed = false;
w.lock();
try {
for (Appender a : appenderList) {
if (name.equals((a).getName())) {
removed = appenderList.remove(a);
break;
}
}
} finally {
w.unlock();
}
return removed;
}
}