mcconnell 2003/02/04 22:15:35
Modified: src/java/org/apache/log/output AsyncLogTarget.java
AbstractTarget.java AbstractOutputTarget.java
Log:
Checkstyle corrections and javadoc additions.
Revision Changes Path
1.11 +13 -0
jakarta-avalon-logkit/src/java/org/apache/log/output/AsyncLogTarget.java
Index: AsyncLogTarget.java
===================================================================
RCS file:
/home/cvs/jakarta-avalon-logkit/src/java/org/apache/log/output/AsyncLogTarget.java,v
retrieving revision 1.10
retrieving revision 1.11
diff -u -r1.10 -r1.11
--- AsyncLogTarget.java 3 Feb 2003 17:40:13 -0000 1.10
+++ AsyncLogTarget.java 5 Feb 2003 06:15:35 -0000 1.11
@@ -75,6 +75,7 @@
* logger.setLogTargets( new LogTarget[] { asyncTarget } );
* </pre>
*
+ * @author <a href="mailto:[EMAIL PROTECTED]";>Avalon Development
Team</a>
* @author <a href="mailto:[EMAIL PROTECTED]";>Peter Donald</a>
*/
public class AsyncLogTarget
@@ -85,11 +86,20 @@
private final int m_queueSize;
private final LogTarget m_logTarget;
+ /**
+ * Creation of a new async log target.
+ * @param logTarget the underlying target
+ */
public AsyncLogTarget( final LogTarget logTarget )
{
this( logTarget, 15 );
}
+ /**
+ * Creation of a new async log target.
+ * @param logTarget the underlying target
+ * @param queueSize the queue size
+ */
public AsyncLogTarget( final LogTarget logTarget, final int queueSize )
{
m_logTarget = logTarget;
@@ -148,6 +158,9 @@
}
}
+ /**
+ * Thread startup.
+ */
public void run()
{
//set this variable when thread is interupted
1.8 +11 -1
jakarta-avalon-logkit/src/java/org/apache/log/output/AbstractTarget.java
Index: AbstractTarget.java
===================================================================
RCS file:
/home/cvs/jakarta-avalon-logkit/src/java/org/apache/log/output/AbstractTarget.java,v
retrieving revision 1.7
retrieving revision 1.8
diff -u -r1.7 -r1.8
--- AbstractTarget.java 3 Feb 2003 17:40:13 -0000 1.7
+++ AbstractTarget.java 5 Feb 2003 06:15:35 -0000 1.8
@@ -76,11 +76,17 @@
///Flag indicating that log session is finished (aka target has been closed)
private boolean m_isOpen;
+ /**
+ * AbstractTarget constructor.
+ */
public AbstractTarget()
{
-
}
+ /**
+ * AbstractTarget constructor.
+ * @param errorHandler the error handler
+ */
public AbstractTarget( final ErrorHandler errorHandler )
{
if( errorHandler == null )
@@ -100,6 +106,10 @@
m_errorHandler = errorHandler;
}
+ /**
+ * Return the open state of the target.
+ * @return TRUE if the target is open else FALSE
+ */
protected synchronized boolean isOpen()
{
return m_isOpen;
1.13 +9 -0
jakarta-avalon-logkit/src/java/org/apache/log/output/AbstractOutputTarget.java
Index: AbstractOutputTarget.java
===================================================================
RCS file:
/home/cvs/jakarta-avalon-logkit/src/java/org/apache/log/output/AbstractOutputTarget.java,v
retrieving revision 1.12
retrieving revision 1.13
diff -u -r1.12 -r1.13
--- AbstractOutputTarget.java 3 Feb 2003 17:40:13 -0000 1.12
+++ AbstractOutputTarget.java 5 Feb 2003 06:15:35 -0000 1.13
@@ -82,6 +82,11 @@
{
}
+
+ /**
+ * Creation of a new abstract output target instance.
+ * @param formatter the formatter to apply
+ */
public AbstractOutputTarget( final Formatter formatter )
{
m_formatter = formatter;
@@ -133,6 +138,10 @@
{
}
+ /**
+ * Process a log event.
+ * @param event the event to process
+ */
protected void doProcessEvent( LogEvent event )
{
final String data = format( event );
---------------------------------------------------------------------
To unsubscribe, e-mail: [EMAIL PROTECTED]
For additional commands, e-mail: [EMAIL PROTECTED]
