You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@logging.apache.org by ma...@apache.org on 2014/09/10 04:28:04 UTC
[2/2] git commit: Javadoc updates.
Javadoc updates.
Project: http://git-wip-us.apache.org/repos/asf/logging-log4j2/repo
Commit: http://git-wip-us.apache.org/repos/asf/logging-log4j2/commit/313520a9
Tree: http://git-wip-us.apache.org/repos/asf/logging-log4j2/tree/313520a9
Diff: http://git-wip-us.apache.org/repos/asf/logging-log4j2/diff/313520a9
Branch: refs/heads/master
Commit: 313520a9f794bb06aedfae4f6748a9aa7b821edc
Parents: 6d284e0
Author: Matt Sicker <ma...@apache.org>
Authored: Tue Sep 9 21:27:56 2014 -0500
Committer: Matt Sicker <ma...@apache.org>
Committed: Tue Sep 9 21:27:56 2014 -0500
----------------------------------------------------------------------
.../log4j/message/StructuredDataMessage.java | 18 +++++++++++-------
1 file changed, 11 insertions(+), 7 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/logging-log4j2/blob/313520a9/log4j-api/src/main/java/org/apache/logging/log4j/message/StructuredDataMessage.java
----------------------------------------------------------------------
diff --git a/log4j-api/src/main/java/org/apache/logging/log4j/message/StructuredDataMessage.java b/log4j-api/src/main/java/org/apache/logging/log4j/message/StructuredDataMessage.java
index 2d949c0..97d7204 100644
--- a/log4j-api/src/main/java/org/apache/logging/log4j/message/StructuredDataMessage.java
+++ b/log4j-api/src/main/java/org/apache/logging/log4j/message/StructuredDataMessage.java
@@ -14,6 +14,7 @@
* See the license for the specific language governing permissions and
* limitations under the license.
*/
+
package org.apache.logging.log4j.message;
import java.util.Map;
@@ -27,6 +28,7 @@ import org.apache.logging.log4j.util.EnglishEnums;
* When using asynchronous loggers and appenders it is not recommended to modify this message after the message is
* logged, because it is undefined whether the logged message string will contain the old values or the modified
* values.
+ * </p>
*
* @see <a href="https://tools.ietf.org/html/rfc5424">RFC 5424</a>
*/
@@ -53,7 +55,7 @@ public class StructuredDataMessage extends MapMessage {
}
/**
- * Constructor based on a String id.
+ * Creates a StructuredDataMessage using an ID (max 32 characters), message, and type (max 32 characters).
* @param id The String id.
* @param msg The message.
* @param type The message type.
@@ -64,7 +66,8 @@ public class StructuredDataMessage extends MapMessage {
this.type = type;
}
/**
- * Constructor based on a String id.
+ * Creates a StructuredDataMessage using an ID (max 32 characters), message, type (max 32 characters), and an
+ * initial map of structured data to include.
* @param id The String id.
* @param msg The message.
* @param type The message type.
@@ -79,7 +82,7 @@ public class StructuredDataMessage extends MapMessage {
}
/**
- * Constructor based on a StructuredDataId.
+ * Creates a StructuredDataMessage using a StructuredDataId, message, and type (max 32 characters).
* @param id The StructuredDataId.
* @param msg The message.
* @param type The message type.
@@ -91,7 +94,8 @@ public class StructuredDataMessage extends MapMessage {
}
/**
- * Constructor based on a StructuredDataId.
+ * Creates a StructuredDataMessage using a StructuredDataId, message, type (max 32 characters), and an initial map
+ * of structured data to include.
* @param id The StructuredDataId.
* @param msg The message.
* @param type The message type.
@@ -141,7 +145,7 @@ public class StructuredDataMessage extends MapMessage {
}
/**
- * Returns the id.
+ * Returns this message id.
* @return the StructuredDataId.
*/
public StructuredDataId getId() {
@@ -149,7 +153,7 @@ public class StructuredDataMessage extends MapMessage {
}
/**
- * Sets the id from a String.
+ * Sets the id from a String. This ID can be at most 32 characters long.
* @param id The String id.
*/
protected void setId(final String id) {
@@ -165,7 +169,7 @@ public class StructuredDataMessage extends MapMessage {
}
/**
- * Sets the type.
+ * Returns this message type.
* @return the type.
*/
public String getType() {