com.unboundid.ldap.listener

Class SearchEntryParer

java.lang.Object

com.unboundid.ldap.listener.SearchEntryParer

All Implemented Interfaces:

java.io.Serializable

@ThreadSafety(level=COMPLETELY_THREADSAFE)
public final class SearchEntryParer
extends java.lang.Object
implements java.io.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 and Description
SearchEntryParer(java.util.List<java.lang.String> requestedAttributes, Schema schema) Creates a new search entry parer for the provided set of requested attributes.

Method Summary

Modifier and Type	Method and Description
java.util.List<java.lang.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 Detail

SearchEntryParer

public SearchEntryParer(@NotNull
                        java.util.List<java.lang.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 Detail

getRequestedAttributes

@NotNull
public java.util.List<java.lang.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.