|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.unboundid.ldap.sdk.Entry
com.unboundid.ldap.sdk.ReadOnlyEntry
com.unboundid.ldap.sdk.SearchResultEntry
public final class SearchResultEntry
This class provides a data structure for representing an LDAP search result
entry. This is a ReadOnlyEntry
object that may also include zero
or more controls included with the entry returned from the server.
Field Summary |
---|
Fields inherited from interface com.unboundid.ldap.protocol.LDAPResponse |
---|
NO_CONTROLS |
Constructor Summary | |
---|---|
SearchResultEntry(Entry entry,
Control... controls)
Creates a new search result entry from the provided entry. |
|
SearchResultEntry(int messageID,
Entry entry,
Control... controls)
Creates a new search result entry from the provided entry. |
|
SearchResultEntry(int messageID,
java.lang.String dn,
Attribute[] attributes,
Control... controls)
Creates a new search result entry with the provided information. |
|
SearchResultEntry(int messageID,
java.lang.String dn,
java.util.Collection<Attribute> attributes,
Control... controls)
Creates a new search result entry with the provided information. |
|
SearchResultEntry(int messageID,
java.lang.String dn,
Schema schema,
Attribute[] attributes,
Control... controls)
Creates a new search result entry with the provided information. |
|
SearchResultEntry(int messageID,
java.lang.String dn,
Schema schema,
java.util.Collection<Attribute> attributes,
Control... controls)
Creates a new search result entry with the provided information. |
|
SearchResultEntry(java.lang.String dn,
Attribute[] attributes,
Control... controls)
Creates a new search result entry with the provided information. |
|
SearchResultEntry(java.lang.String dn,
java.util.Collection<Attribute> attributes,
Control... controls)
Creates a new search result entry with the provided information. |
Method Summary | |
---|---|
boolean |
equals(java.lang.Object o)
Indicates whether the provided object is equal to this entry. |
Control |
getControl(java.lang.String oid)
Retrieves the control with the specified OID. |
Control[] |
getControls()
Retrieves the set of controls returned with this search result entry. |
int |
getMessageID()
Retrieves the message ID for the LDAP message containing this response. |
int |
hashCode()
Generates a hash code for this entry. |
void |
toString(java.lang.StringBuilder buffer)
Appends a string representation of this 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 java.lang.Object |
---|
clone, finalize, getClass, notify, notifyAll, wait, wait, wait |
Constructor Detail |
---|
public SearchResultEntry(java.lang.String dn, Attribute[] attributes, Control... controls)
dn
- The DN for this search result entry. It must not be
null
.attributes
- The set of attributes to include in this search result
entry. It must not be null
.controls
- The set of controls for this search result entry. It
must not be null
.public SearchResultEntry(int messageID, java.lang.String dn, Attribute[] attributes, Control... controls)
messageID
- The message ID for the LDAP message containing this
response.dn
- The DN for this search result entry. It must not be
null
.attributes
- The set of attributes to include in this search result
entry. It must not be null
.controls
- The set of controls for this search result entry. It
must not be null
.public SearchResultEntry(int messageID, java.lang.String dn, Schema schema, Attribute[] attributes, Control... controls)
messageID
- The message ID for the LDAP message containing this
response.dn
- The DN for this search result entry. It must not be
null
.schema
- The schema to use for operations involving this entry.
It may be null
if no schema is available.attributes
- The set of attributes to include in this search result
entry. It must not be null
.controls
- The set of controls for this search result entry. It
must not be null
.public SearchResultEntry(java.lang.String dn, java.util.Collection<Attribute> attributes, Control... controls)
dn
- The DN for this search result entry. It must not be
null
.attributes
- The set of attributes to include in this search result
entry. It must not be null
.controls
- The set of controls for this search result entry. It
must not be null
.public SearchResultEntry(int messageID, java.lang.String dn, java.util.Collection<Attribute> attributes, Control... controls)
messageID
- The message ID for the LDAP message containing this
response.dn
- The DN for this search result entry. It must not be
null
.attributes
- The set of attributes to include in this search result
entry. It must not be null
.controls
- The set of controls for this search result entry. It
must not be null
.public SearchResultEntry(int messageID, java.lang.String dn, Schema schema, java.util.Collection<Attribute> attributes, Control... controls)
messageID
- The message ID for the LDAP message containing this
response.dn
- The DN for this search result entry. It must not be
null
.schema
- The schema to use for operations involving this entry.
It may be null
if no schema is available.attributes
- The set of attributes to include in this search result
entry. It must not be null
.controls
- The set of controls for this search result entry. It
must not be null
.public SearchResultEntry(Entry entry, Control... controls)
entry
- The entry to use to create this search result entry. It
must not be null
.controls
- The set of controls for this search result entry. It
must not be null
.public SearchResultEntry(int messageID, Entry entry, Control... controls)
messageID
- The message ID for the LDAP message containing this
response.entry
- The entry to use to create this search result entry. It
must not be null
.controls
- The set of controls for this search result entry. It
must not be null
.Method Detail |
---|
public int getMessageID()
getMessageID
in interface LDAPResponse
public Control[] getControls()
get
method in the response control class.
public Control getControl(java.lang.String oid)
oid
- The OID of the control to retrieve.
null
if there is no
such control for this search result entry.public int hashCode()
hashCode
in class Entry
public boolean equals(java.lang.Object o)
equals
in class Entry
o
- The object for which to make the determination.
true
if the provided object is considered equal to this
entry, or false
if not.public void toString(java.lang.StringBuilder buffer)
toString
in interface LDAPResponse
toString
in interface LDIFRecord
toString
in class Entry
buffer
- The buffer to which to append the string representation of
this entry.
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |