SearchResult (Ldaptive 1.2.4 API)

java.lang.Object
- org.ldaptive.AbstractLdapBean
- - org.ldaptive.SearchResult

All Implemented Interfaces:

Serializable
```
public class SearchResult
extends AbstractLdapBean
```
Simple bean representing an ldap search result. Contains a map of entry DN to ldap entry.

See Also:

Serialized Form

Field Summary

Fields
Modifier and Type	Field and Description
`private static int`	`HASH_CODE_SEED` hash code seed.
`private Map<String,LdapEntry>`	`resultEntries` Entries contained in this result.
`private Collection<SearchReference>`	`searchReferences` References contained in this result.
`private static long`	`serialVersionUID` serial version uid.

Constructor Summary

Constructors
Constructor and Description
`SearchResult()` Default constructor.
`SearchResult(Collection<LdapEntry> entries)` Creates a new search result.
`SearchResult(LdapEntry... entry)` Creates a new search result.
`SearchResult(SortBehavior sb)` Creates a new search result.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addEntries(Collection<LdapEntry> entries)` Adds entry(s) to this search result.
`void`	`addEntry(LdapEntry... entry)` Adds an entry to this search result.
`void`	`addReference(SearchReference... reference)` Adds a reference to this search result.
`void`	`addReferences(Collection<SearchReference> references)` Adds references(s) to this search result.
`void`	`clear()` Removes all the entries in this search result.
`boolean`	`equals(Object o)`
`Collection<LdapEntry>`	`getEntries()` Returns a collection of ldap entry.
`LdapEntry`	`getEntry()` Returns a single entry of this result.
`LdapEntry`	`getEntry(String dn)` Returns the ldap in this result with the supplied DN.
`String[]`	`getEntryDns()` Returns the entry DNs in this result.
`SearchReference`	`getReference()` Returns a single search reference of this result.
`Collection<SearchReference>`	`getReferences()` Returns a collection of ldap entry.
`int`	`hashCode()`
`static SearchResult`	`mergeEntries(SearchResult result)` Merges the entries in the supplied result into a single entry.
`void`	`removeEntries(Collection<LdapEntry> entries)` Removes the entry(s) from this search result.
`void`	`removeEntry(LdapEntry... entry)` Removes an entry from this search result.
`void`	`removeEntry(String dn)` Removes the entry with the supplied dn from this search result.
`void`	`removeReference(SearchReference... reference)` Removes a reference from this search result.
`void`	`removeReferences(Collection<SearchReference> references)` Removes the references(s) from this search result.
`int`	`size()` Returns the number of entries in this search result.
`SearchResult`	`subResult(int fromIndex, int toIndex)` Returns a portion of this result between the specified fromIndex, inclusive, and toIndex, exclusive.
`String`	`toString()`

Methods inherited from class org.ldaptive.AbstractLdapBean
getSortBehavior

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- Field Detail
  - HASH_CODE_SEED
```
private static final int HASH_CODE_SEED
```
    hash code seed.
    
    See Also:
    
    Constant Field Values
  - serialVersionUID
```
private static final long serialVersionUID
```
    serial version uid.
    
    See Also:
    
    Constant Field Values
  - resultEntries
```
private final Map<String,LdapEntry> resultEntries
```
    Entries contained in this result.
  - searchReferences
```
private final Collection<SearchReference> searchReferences
```
    References contained in this result.
- Constructor Detail
  - SearchResult
```
public SearchResult()
```
    Default constructor.
  - SearchResult
```
public SearchResult(SortBehavior sb)
```
    Creates a new search result.
    
    Parameters:
    
    sb - sort behavior of the results
  - SearchResult
```
public SearchResult(LdapEntry... entry)
```
    Creates a new search result.
    
    Parameters:
    
    entry - ldap entry
  - SearchResult
```
public SearchResult(Collection<LdapEntry> entries)
```
    Creates a new search result.
    
    Parameters:
    
    entries - collection of ldap entries
- Method Detail
  - getEntries
```
public Collection<LdapEntry> getEntries()
```
    Returns a collection of ldap entry.
    
    Returns:
    
    collection of ldap entry
  - getEntry
```
public LdapEntry getEntry()
```
    Returns a single entry of this result. If multiple entries exist the first entry returned by the underlying iterator is used. If no entries exist null is returned.
    
    Returns:
    
    single entry
  - getEntry
```
public LdapEntry getEntry(String dn)
```
    Returns the ldap in this result with the supplied DN.
    
    Parameters:
    
    dn - of the entry to return
    
    Returns:
    
    ldap entry
  - getEntryDns
```
public String[] getEntryDns()
```
    Returns the entry DNs in this result.
    
    Returns:
    
    string array of entry DNs
  - addEntry
```
public void addEntry(LdapEntry... entry)
```
    Adds an entry to this search result.
    
    Parameters:
    
    entry - entry to add
  - addEntries
```
public void addEntries(Collection<LdapEntry> entries)
```
    Adds entry(s) to this search result.
    
    Parameters:
    
    entries - collection of entries to add
  - removeEntry
```
public void removeEntry(LdapEntry... entry)
```
    Removes an entry from this search result.
    
    Parameters:
    
    entry - entry to remove
  - removeEntry
```
public void removeEntry(String dn)
```
    Removes the entry with the supplied dn from this search result.
    
    Parameters:
    
    dn - of entry to remove
  - removeEntries
```
public void removeEntries(Collection<LdapEntry> entries)
```
    Removes the entry(s) from this search result.
    
    Parameters:
    
    entries - collection of ldap entries to remove
  - getReferences
```
public Collection<SearchReference> getReferences()
```
    Returns a collection of ldap entry.
    
    Returns:
    
    collection of ldap entry
  - getReference
```
public SearchReference getReference()
```
    Returns a single search reference of this result. If multiple references exist the first references returned by the underlying iterator is used. If no references exist null is returned.
    
    Returns:
    
    single search references
  - addReference
```
public void addReference(SearchReference... reference)
```
    Adds a reference to this search result.
    
    Parameters:
    
    reference - reference to add
  - addReferences
```
public void addReferences(Collection<SearchReference> references)
```
    Adds references(s) to this search result.
    
    Parameters:
    
    references - collection of references to add
  - removeReference
```
public void removeReference(SearchReference... reference)
```
    Removes a reference from this search result.
    
    Parameters:
    
    reference - reference to remove
  - removeReferences
```
public void removeReferences(Collection<SearchReference> references)
```
    Removes the references(s) from this search result.
    
    Parameters:
    
    references - collection of search references to remove
  - subResult
```
public SearchResult subResult(int fromIndex,
                              int toIndex)
```
    Returns a portion of this result between the specified fromIndex, inclusive, and toIndex, exclusive. If fromIndex and toIndex are equal, the return result is empty. The result of this method is undefined for unordered results.
    
    Parameters:
    
    fromIndex - low endpoint of the search result (inclusive)
    
    toIndex - high endpoint of the search result (exclusive)
    
    Returns:
    
    portion of this search result
    
    Throws:
    
    IndexOutOfBoundsException - for illegal index values
  - size
```
public int size()
```
    Returns the number of entries in this search result.
    
    Returns:
    
    number of entries in this search result
  - clear
```
public void clear()
```
    Removes all the entries in this search result.
  - equals
```
public boolean equals(Object o)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - mergeEntries
```
public static SearchResult mergeEntries(SearchResult result)
```
    Merges the entries in the supplied result into a single entry. This method always returns a search result of size zero or one.
    
    Parameters:
    
    result - search result containing entries to merge
    
    Returns:
    
    search result containing a single merged entry

Class SearchResult

Field Summary

Constructor Summary

Method Summary

Methods inherited from class org.ldaptive.AbstractLdapBean

Methods inherited from class java.lang.Object

Field Detail

HASH_CODE_SEED

serialVersionUID

resultEntries

searchReferences

Constructor Detail

SearchResult

SearchResult

SearchResult

SearchResult

Method Detail

getEntries

getEntry

getEntry

getEntryDns

addEntry

addEntries

removeEntry

removeEntry

removeEntries

getReferences

getReference

addReference

addReferences

removeReference

removeReferences

subResult

size

clear

equals

hashCode

toString

mergeEntries