From 1e74b0f8f046cc9e69ba9eddbc180bf10ab83e06 Mon Sep 17 00:00:00 2001
From: Mark Craig <mark.craig@forgerock.com>
Date: Thu, 20 Sep 2012 16:58:20 +0000
Subject: [PATCH] CR-701 Fix for OPENDJ-596: Include more examples in LDAP SDK Javadoc
---
opendj3/opendj-ldap-sdk/src/main/java/org/forgerock/opendj/ldap/TreeMapEntry.java | 15 ++++++++++++++-
1 files changed, 14 insertions(+), 1 deletions(-)
diff --git a/opendj3/opendj-ldap-sdk/src/main/java/org/forgerock/opendj/ldap/TreeMapEntry.java b/opendj3/opendj-ldap-sdk/src/main/java/org/forgerock/opendj/ldap/TreeMapEntry.java
index f0779f7..515a731 100644
--- a/opendj3/opendj-ldap-sdk/src/main/java/org/forgerock/opendj/ldap/TreeMapEntry.java
+++ b/opendj3/opendj-ldap-sdk/src/main/java/org/forgerock/opendj/ldap/TreeMapEntry.java
@@ -39,7 +39,20 @@
* for storing attributes. Attributes are returned in ascending order of
* attribute description, with {@code objectClass} first, then all user
* attributes, and finally any operational attributes. All operations are
- * supported by this implementation.
+ * supported by this implementation. For example, you can build an entry like
+ * this:
+ *
+ * <pre>
+ * Entry entry = new TreeMapEntry("cn=Bob,ou=People,dc=example,dc=com")
+ * .addAttribute("cn", "Bob")
+ * .addAttribute("objectclass", "top")
+ * .addAttribute("objectclass", "person")
+ * .addAttribute("objectclass", "organizationalPerson")
+ * .addAttribute("objectclass", "inetOrgPerson")
+ * .addAttribute("mail", "subgenius@example.com")
+ * .addAttribute("sn", "Dobbs");
+ * </pre>
+ *
* <p>
* A {@code TreeMapEntry} stores references to attributes which have been added
* using the {@link #addAttribute} methods. Attributes sharing the same
--
Gitblit v1.10.0