org.ldaptive.concurrent

Class QueueingSearchExecutor.SearchItem

java.lang.Object

org.ldaptive.concurrent.QueueingSearchExecutor.SearchItem

Enclosing class:

QueueingSearchExecutor

public static class QueueingSearchExecutor.SearchItem
extends Object

Contains data returned when using the QueueingSearchExecutor.

Field Summary

Fields

Modifier and Type	Field and Description
private IntermediateResponse	intermediateResponse Intermediate response contained in this blocking search item.
private SearchEntry	searchEntry Search entry contained in this blocking search item.
private Exception	searchException Exception thrown by the search operation.
private SearchReference	searchReference Search reference contained in this blocking search item.
private Response<SearchResult>	searchResponse Response contained in this blocking search item.

Constructor Summary

Constructors

Constructor and Description
SearchItem(Exception exception) Creates a new blocking search item.
SearchItem(IntermediateResponse response) Creates a new blocking search item.
SearchItem(Response<SearchResult> response) Creates a new blocking search item.
SearchItem(SearchEntry entry) Creates a new blocking search item.
SearchItem(SearchReference reference) Creates a new blocking search item.

Method Summary

Modifier and Type	Method and Description
SearchEntry	getEntry() Returns the search entry contained in this item or null if this item does not contain a search entry.
Exception	getException() Returns the exception contained in this item or null if this item does not contain an exception.
IntermediateResponse	getIntermediateResponse() Returns the intermediate response contained in this item or null if this item does not contain an intermediate response.
SearchReference	getReference() Returns the search reference contained in this item or null if this item does not contain a search reference.
Response<SearchResult>	getResponse() Returns the response contained in this item or null if this item does not contain a response.
boolean	isEntry() Returns whether this item represents a search entry.
boolean	isException() Returns whether this item represents an exception.
boolean	isIntermediateResponse() Returns whether this item represents an intermediate response.
boolean	isReference() Returns whether this item represents a search reference.
boolean	isResponse() Returns whether this item represents a response.
String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

searchEntry

private final SearchEntry searchEntry

Search entry contained in this blocking search item.

searchReference

private final SearchReference searchReference

Search reference contained in this blocking search item.

intermediateResponse

private final IntermediateResponse intermediateResponse

Intermediate response contained in this blocking search item.

searchResponse

private final Response<SearchResult> searchResponse

Response contained in this blocking search item.

searchException

private final Exception searchException

Exception thrown by the search operation.

Constructor Detail

SearchItem

public SearchItem(SearchEntry entry)

Creates a new blocking search item.

Parameters:

entry - that represents this item

SearchItem

public SearchItem(SearchReference reference)

Creates a new blocking search item.

Parameters:

reference - that represents this item

SearchItem

public SearchItem(IntermediateResponse response)

Creates a new blocking search item.

Parameters:

response - that represents this item

SearchItem

public SearchItem(Response<SearchResult> response)

Creates a new blocking search item.

Parameters:

response - that represents this item

SearchItem

public SearchItem(Exception exception)

Creates a new blocking search item.

Parameters:

exception - that represents this item

Method Detail

isEntry

public boolean isEntry()

Returns whether this item represents a search entry.

Returns:

whether this item represents a search entry

getEntry

public SearchEntry getEntry()

Returns the search entry contained in this item or null if this item does not contain a search entry.

Returns:

search entry

isReference

public boolean isReference()

Returns whether this item represents a search reference.

Returns:

whether this item represents a search reference

getReference

public SearchReference getReference()

Returns the search reference contained in this item or null if this item does not contain a search reference.

Returns:

search entry

isIntermediateResponse

public boolean isIntermediateResponse()

Returns whether this item represents an intermediate response.

Returns:

whether this item represents an intermediate response

getIntermediateResponse

public IntermediateResponse getIntermediateResponse()

Returns the intermediate response contained in this item or null if this item does not contain an intermediate response.

Returns:

intermediate response

isResponse

public boolean isResponse()

Returns whether this item represents a response.

Returns:

whether this item represents a response

getResponse

public Response<SearchResult> getResponse()

Returns the response contained in this item or null if this item does not contain a response.

Returns:

response

isException

public boolean isException()

Returns whether this item represents an exception.

Returns:

whether this item represents an exception

getException

public Exception getException()

Returns the exception contained in this item or null if this item does not contain an exception.

Returns:

exception

toString

public String toString()

Overrides:

toString in class Object