Class JoinedEntry
- java.lang.Object
-
- com.unboundid.ldap.sdk.Entry
-
- com.unboundid.ldap.sdk.ReadOnlyEntry
-
- 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
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 theJoinRequestControl
class for additional information and an example demonstrating its use.
NOTE: This class, and other classes within the
com.unboundid.ldap.sdk.unboundidds
package structure, are only supported for use against Ping Identity, UnboundID, and Nokia/Alcatel-Lucent 8661 server products. These classes provide support for proprietary functionality or for external specifications that are not considered stable or mature enough to be guaranteed to work in an interoperable way with other types of LDAP servers.
Joined entries are encoded as follows:JoinedEntry ::= SEQUENCE { objectName LDAPDN, attributes PartialAttributeList, nestedJoinResults SEQUENCE OF JoinedEntry OPTIONAL }
- See Also:
- Serialized Form
-
-
Constructor Summary
Constructors Constructor Description 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
All Methods Instance Methods Concrete Methods Modifier and Type Method Description 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, applyModifyDN, applyModifyDN, diff, 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
-
-
-
-
Constructor Detail
-
JoinedEntry
public JoinedEntry(@NotNull Entry entry, @Nullable 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 benull
.nestedJoinResults
- A list of nested join results for this joined entry. It may benull
or empty if there are no nested join results.
-
JoinedEntry
public JoinedEntry(@NotNull java.lang.String dn, @NotNull java.util.Collection<Attribute> attributes, @Nullable 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 benull
.attributes
- The set of attributes for this joined entry. It must not benull
.nestedJoinResults
- A list of nested join results for this joined entry. It may benull
or empty if there are no nested join results.
-
-
Method Detail
-
getNestedJoinResults
@NotNull 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(@NotNull java.lang.StringBuilder buffer)
Appends a string representation of this joined entry to the provided buffer.- Specified by:
toString
in interfaceLDIFRecord
- Overrides:
toString
in classEntry
- Parameters:
buffer
- The buffer to which the information should be appended.
-
-