Package com.unboundid.ldap.listener

Class SearchEntryParer

java.lang.Object

com.unboundid.ldap.listener.SearchEntryParer

All Implemented Interfaces:

Serializable

@ThreadSafety(level=COMPLETELY_THREADSAFE)
public final class SearchEntryParer
extends Object
implements Serializable

This class provides support methods for paring search result entries based on a given set of requested attributes.

See Also:

• Serialized Form

Constructor Summary

Constructors

Constructor	Description
SearchEntryParer(List<String> requestedAttributes, Schema schema)	Creates a new search entry parer for the provided set of requested attributes.

Method Summary

Modifier and Type	Method	Description
List<String>	getRequestedAttributes()	Retrieves the set of requested attributes used to create this search entry parer.
Entry	pareEntry(Entry entry)	Retrieves a copy of the provided entry that includes only the appropriate set of requested attributes.

Methods inherited from class java.lang.Object

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

Constructor Details

SearchEntryParer

public SearchEntryParer(@NotNull
 List<String> requestedAttributes,
 @Nullable
 Schema schema)

Creates a new search entry parer for the provided set of requested attributes.

Parameters:

requestedAttributes - The list of requested attributes for use when paring entries. It must not be null, but may be empty.

schema - The schema to use when paring entries. It may be null if no schema is available.

Method Details

getRequestedAttributes

@NotNull
public List<String> getRequestedAttributes()

Retrieves the set of requested attributes used to create this search entry parer.

Returns:

The set of requested attributes used to create this search entry parer.

pareEntry

@NotNull
public Entry pareEntry(@NotNull
 Entry entry)

Retrieves a copy of the provided entry that includes only the appropriate set of requested attributes.

Parameters:

entry - The entry to be pared.

Returns:

A copy of the provided entry that includes only the appropriate set of requested attributes.