logging-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From ggreg...@apache.org
Subject svn commit: r1490134 - /logging/log4j/log4j2/trunk/api/src/main/java/org/apache/logging/log4j/message/StructuredDataMessage.java
Date Thu, 06 Jun 2013 04:49:20 GMT
Author: ggregory
Date: Thu Jun  6 04:49:19 2013
New Revision: 1490134

URL: http://svn.apache.org/r1490134
Log:
Javadoc: Use the active voice.

Modified:
    logging/log4j/log4j2/trunk/api/src/main/java/org/apache/logging/log4j/message/StructuredDataMessage.java

Modified: logging/log4j/log4j2/trunk/api/src/main/java/org/apache/logging/log4j/message/StructuredDataMessage.java
URL: http://svn.apache.org/viewvc/logging/log4j/log4j2/trunk/api/src/main/java/org/apache/logging/log4j/message/StructuredDataMessage.java?rev=1490134&r1=1490133&r2=1490134&view=diff
==============================================================================
--- logging/log4j/log4j2/trunk/api/src/main/java/org/apache/logging/log4j/message/StructuredDataMessage.java
(original)
+++ logging/log4j/log4j2/trunk/api/src/main/java/org/apache/logging/log4j/message/StructuredDataMessage.java
Thu Jun  6 04:49:19 2013
@@ -144,7 +144,7 @@ public class StructuredDataMessage exten
     }
 
     /**
-     * Set the id from a String.
+     * Sets the id from a String.
      * @param id The String id.
      */
     protected void setId(final String id) {
@@ -152,7 +152,7 @@ public class StructuredDataMessage exten
     }
 
     /**
-     * Set the id.
+     * Sets the id.
      * @param id The StructuredDataId.
      */
     protected void setId(final StructuredDataId id) {
@@ -160,7 +160,7 @@ public class StructuredDataMessage exten
     }
 
     /**
-     * Set the type.
+     * Sets the type.
      * @return the type.
      */
     public String getType() {
@@ -169,10 +169,11 @@ public class StructuredDataMessage exten
 
     protected void setType(final String type) {
         if (type.length() > MAX_LENGTH) {
-            throw new IllegalArgumentException("Structured data type exceeds maximum length
of 32 characters: " + type);
+            throw new IllegalArgumentException("structured data type exceeds maximum length
of 32 characters: " + type);
         }
         this.type = type;
     }
+    
     /**
      * Returns the message.
      * @return the message.
@@ -205,7 +206,7 @@ public class StructuredDataMessage exten
     }
 
     /**
-     * Format the Structured data as described in RFC 5424.
+     * Formats the structured data as described in RFC 5424.
      *
      * @return The formatted String.
      */
@@ -215,7 +216,7 @@ public class StructuredDataMessage exten
     }
 
     /**
-     * Format the Structured data as described in RFC 5424.
+     * Formats the structured data as described in RFC 5424.
      *
      * @param format The format identifier. Ignored in this implementation.
      * @return The formatted String.
@@ -231,7 +232,7 @@ public class StructuredDataMessage exten
     }
 
     /**
-     * Format the Structured data as described in RFC 5424.
+     * Formats the structured data as described in RFC 5424.
      *
      * @param format           "full" will include the type and message. null will return
only the STRUCTURED-DATA as
      *                         described in RFC 5424
@@ -273,7 +274,7 @@ public class StructuredDataMessage exten
     }
 
     /**
-     * Format the message and return it.
+     * Formats the message and return it.
      * @return the formatted message.
      */
     @Override
@@ -282,7 +283,7 @@ public class StructuredDataMessage exten
     }
 
     /**
-     * Format the message according the the specified format.
+     * Formats the message according the the specified format.
      * @param formats An array of Strings that provide extra information about how to format
the message.
      * StructuredDataMessage accepts only a format of "FULL" which will cause the event type
to be
      * prepended and the event message to be appended. Specifying any other value will cause
only the



Mime
View raw message