com.unboundid.ldap.sdk.unboundidds.controls
Class JoinedEntry

java.lang.Object
  extended by com.unboundid.ldap.sdk.Entry
      extended by com.unboundid.ldap.sdk.ReadOnlyEntry
          extended by com.unboundid.ldap.sdk.unboundidds.controls.JoinedEntry
All Implemented Interfaces:
LDIFRecord, java.io.Serializable

@NotMutable
@ThreadSafety(level=COMPLETELY_THREADSAFE)
public final class JoinedEntry
extends ReadOnlyEntry

NOTE: This class is part of the Commercial Edition of the UnboundID LDAP SDK for Java. It is not available for use in applications that include only the Standard Edition of the LDAP SDK, and is not supported for use in conjunction with non-UnboundID products.
This class provides a joined entry, which is a read-only representation of an entry that has been joined with a search result entry using the LDAP join control. See the class-level documentation for the JoinRequestControl class for additional information and an example demonstrating its use.

Joined entries are encoded as follows:
   JoinedEntry ::= SEQUENCE {
        objectName            LDAPDN,
        attributes            PartialAttributeList,
        nestedJoinResults     SEQUENCE OF JoinedEntry OPTIONAL }
 

See Also:
Serialized Form

Constructor Summary
JoinedEntry(Entry entry, java.util.List<JoinedEntry> nestedJoinResults)
          Creates a new joined entry with the specified DN, attributes, and nested join results.
JoinedEntry(java.lang.String dn, java.util.Collection<Attribute> attributes, java.util.List<JoinedEntry> nestedJoinResults)
          Creates a new joined entry with the specified DN, attributes, and nested join results.
 
Method Summary
 java.util.List<JoinedEntry> getNestedJoinResults()
          Retrieves the list of nested join results for this joined entry.
 void toString(java.lang.StringBuilder buffer)
          Appends a string representation of this joined entry to the provided buffer.
 
Methods inherited from class com.unboundid.ldap.sdk.ReadOnlyEntry
addAttribute, addAttribute, addAttribute, addAttribute, addAttribute, removeAttribute, removeAttributeValue, removeAttributeValue, removeAttributeValues, removeAttributeValues, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setDN, setDN
 
Methods inherited from class com.unboundid.ldap.sdk.Entry
addAttribute, applyModifications, applyModifications, diff, diff, duplicate, equals, getAttribute, getAttribute, getAttributes, getAttributesWithOptions, getAttributeValue, getAttributeValueAsBoolean, getAttributeValueAsDate, getAttributeValueAsDN, getAttributeValueAsInteger, getAttributeValueAsLong, getAttributeValueByteArrays, getAttributeValueBytes, getAttributeValues, getDN, getObjectClassAttribute, getObjectClassValues, getParentDN, getParentDNString, getParsedDN, getRDN, getSchema, hasAttribute, hasAttribute, hasAttribute, hasAttributeValue, hasAttributeValue, hasAttributeValue, hasAttributeValue, hashCode, hasObjectClass, intersectEntries, matchesBaseAndScope, matchesBaseAndScope, mergeEntries, removeAttributeValue, removeAttributeValue, setAttribute, toLDIF, toLDIF, toLDIF, toLDIF, toLDIFString, toLDIFString, toLDIFString, toLDIFString, toString
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
 

Constructor Detail

JoinedEntry

public JoinedEntry(Entry entry,
                   java.util.List<JoinedEntry> nestedJoinResults)
Creates a new joined entry with the specified DN, attributes, and nested join results.

Parameters:
entry - The entry containing the DN and attributes to use for this joined entry. It must not be null.
nestedJoinResults - A list of nested join results for this joined entry. It may be null or empty if there are no nested join results.

JoinedEntry

public JoinedEntry(java.lang.String dn,
                   java.util.Collection<Attribute> attributes,
                   java.util.List<JoinedEntry> nestedJoinResults)
Creates a new joined entry with the specified DN, attributes, and nested join results.

Parameters:
dn - The DN for this joined entry. It must not be null.
attributes - The set of attributes for this joined entry. It must not be null.
nestedJoinResults - A list of nested join results for this joined entry. It may be null or empty if there are no nested join results.
Method Detail

getNestedJoinResults

public java.util.List<JoinedEntry> getNestedJoinResults()
Retrieves the list of nested join results for this joined entry.

Returns:
The list of nested join results for this joined entry, or an empty list if there are none.

toString

public void toString(java.lang.StringBuilder buffer)
Appends a string representation of this joined entry to the provided buffer.

Specified by:
toString in interface LDIFRecord
Overrides:
toString in class Entry
Parameters:
buffer - The buffer to which the information should be appended.