mcconnell 2003/02/05 00:29:55
Modified: src/java/org/apache/log/output/jms TextMessageBuilder.java
PropertyInfo.java ObjectMessageBuilder.java
MessageBuilder.java
Log:
Checkstyle corrections and javadoc additions.
Revision Changes Path
1.9 +23 -0
jakarta-avalon-logkit/src/java/org/apache/log/output/jms/TextMessageBuilder.java
Index: TextMessageBuilder.java
===================================================================
RCS file:
/home/cvs/jakarta-avalon-logkit/src/java/org/apache/log/output/jms/TextMessageBuilder.java,v
retrieving revision 1.8
retrieving revision 1.9
diff -u -r1.8 -r1.9
--- TextMessageBuilder.java 3 Feb 2003 17:40:15 -0000 1.8
+++ TextMessageBuilder.java 5 Feb 2003 08:29:54 -0000 1.9
@@ -67,6 +67,7 @@
/**
* Basic message factory that stores LogEvent in Message.
*
+ * @author <a href="mailto:avalon-dev@jakarta.apache.org";>Avalon Development
Team</a>
* @author <a href="mailto:[EMAIL PROTECTED]">Peter Donald</a>
*/
public class TextMessageBuilder
@@ -75,12 +76,21 @@
private final PropertyInfo[] m_properties;
private final Formatter m_formatter;
+ /**
+ * Creation of a new text message builder.
+ * @param formatter the message formatter
+ */
public TextMessageBuilder( final Formatter formatter )
{
m_properties = new PropertyInfo[ 0 ];
m_formatter = formatter;
}
+ /**
+ * Creation of a new text message builder.
+ * @param properties the property info set
+ * @param formatter the message formatter
+ */
public TextMessageBuilder( final PropertyInfo[] properties,
final Formatter formatter )
{
@@ -88,6 +98,13 @@
m_formatter = formatter;
}
+ /**
+ * Build a message from the supplied session for the supplied event
+ * @param session the session
+ * @param event the log event
+ * @return the message
+ * @exception JMSException if a messaging related error occurs
+ */
public Message buildMessage( final Session session, final LogEvent event
)
throws JMSException
{
@@ -105,6 +122,12 @@
}
}
+ /**
+ * Set a property
+ * @param message the text message
+ * @param index the index
+ * @param event the log event
+ */
private void setProperty( final TextMessage message,
final int index,
final LogEvent event )
1.5 +19 -0
jakarta-avalon-logkit/src/java/org/apache/log/output/jms/PropertyInfo.java
Index: PropertyInfo.java
===================================================================
RCS file:
/home/cvs/jakarta-avalon-logkit/src/java/org/apache/log/output/jms/PropertyInfo.java,v
retrieving revision 1.4
retrieving revision 1.5
diff -u -r1.4 -r1.5
--- PropertyInfo.java 3 Feb 2003 17:40:15 -0000 1.4
+++ PropertyInfo.java 5 Feb 2003 08:29:54 -0000 1.5
@@ -57,6 +57,7 @@
/**
* A descriptor for each message property.
*
+ * @author <a href="mailto:avalon-dev@jakarta.apache.org";>Avalon Development
Team</a>
* @author <a href="mailto:[EMAIL PROTECTED]">Mircea Toma</a>
*/
public class PropertyInfo
@@ -70,6 +71,12 @@
///Auxilliary parameters (ie constant or sub-format)
private final String m_aux; //may be null
+ /**
+ * Creation of a new property info instance.
+ * @param name the property
+ * @param type the property type
+ * @param aux auxillary property value
+ */
public PropertyInfo( final String name, final int type, final String aux
)
{
m_type = type;
@@ -77,16 +84,28 @@
m_name = name;
}
+ /**
+ * Return the property name
+ * @return the name
+ */
public String getName()
{
return m_name;
}
+ /**
+ * Return the property type
+ * @return the type
+ */
public int getType()
{
return m_type;
}
+ /**
+ * Return the property auxilliary information
+ * @return the information
+ */
public String getAux()
{
return m_aux;
1.5 +1 -1
jakarta-avalon-logkit/src/java/org/apache/log/output/jms/ObjectMessageBuilder.java
Index: ObjectMessageBuilder.java
===================================================================
RCS file:
/home/cvs/jakarta-avalon-logkit/src/java/org/apache/log/output/jms/ObjectMessageBuilder.java,v
retrieving revision 1.4
retrieving revision 1.5
diff -u -r1.4 -r1.5
--- ObjectMessageBuilder.java 5 Feb 2003 07:02:00 -0000 1.4
+++ ObjectMessageBuilder.java 5 Feb 2003 08:29:54 -0000 1.5
@@ -75,7 +75,7 @@
* @param session the session against which the message will be created
* @param event the log event
* @return the message
- * @exeption JMSException if a messaging error occurs
+ * @exception JMSException if a messaging error occurs
*/
public Message buildMessage( Session session, LogEvent event )
throws JMSException
1.8 +1 -1
jakarta-avalon-logkit/src/java/org/apache/log/output/jms/MessageBuilder.java
Index: MessageBuilder.java
===================================================================
RCS file:
/home/cvs/jakarta-avalon-logkit/src/java/org/apache/log/output/jms/MessageBuilder.java,v
retrieving revision 1.7
retrieving revision 1.8
diff -u -r1.7 -r1.8
--- MessageBuilder.java 5 Feb 2003 07:03:06 -0000 1.7
+++ MessageBuilder.java 5 Feb 2003 08:29:55 -0000 1.8
@@ -73,7 +73,7 @@
* @param session the session against which the message will be created
* @param event the log event
* @return the message
- * @exeption JMSException if a messaging error occurs
+ * @exception JMSException if a messaging error occurs
*/
Message buildMessage( Session session, LogEvent event )
throws JMSException;
---------------------------------------------------------------------
To unsubscribe, e-mail: [EMAIL PROTECTED]
For additional commands, e-mail: [EMAIL PROTECTED]
