org.ldaptive
Class SearchFilter

java.lang.Object
  org.ldaptive.SearchFilter

public class SearchFilter
extends Object

Simple bean for an ldap search filter and it's parameters.

Version:

$Revision: 2885 $ $Date: 2014-02-05 16:28:49 -0500 (Wed, 05 Feb 2014) $

Author:

Middleware Services

Constructor Summary

SearchFilter()
Default constructor.

SearchFilter(String filter)
Creates a new search filter with the supplied filter.

SearchFilter(String filter, Object[] params)
Creates a new search filter with the supplied filter and parameters.

Method Summary

protected static String	encode(Object obj) Hex encodes the supplied object if it is of type byte[], otherwise the string format of the object is escaped.
static String	encodeValue(byte[] value) Hex encodes the supplied byte array for use in a search filter.
static String	encodeValue(String value) Encodes the supplied attribute value for use in a search filter.
boolean	equals(Object o)
String	format() Returns this filter with it's parameters encoded and replaced.
String	getFilter() Gets the filter.
Map<String,Object>	getParameters() Gets the filter parameters.
int	hashCode()
void	setFilter(String filter) Sets the filter.
void	setParameter(int position, Object value) Sets a positional filter parameter.
void	setParameter(String name, Object value) Sets a named filter parameter.
void	setParameters(Object[] values) Sets positional filter parameters.
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

SearchFilter

public SearchFilter()

Default constructor.

SearchFilter

public SearchFilter(String filter)

Creates a new search filter with the supplied filter.

Parameters:

filter - to set

SearchFilter

public SearchFilter(String filter,
                    Object[] params)

Creates a new search filter with the supplied filter and parameters.

Parameters:

filter - to set

params - to set

Method Detail

getFilter

public String getFilter()

Gets the filter.

Returns:

filter

setFilter

public void setFilter(String filter)

Sets the filter.

Parameters:

filter - to set

getParameters

public Map<String,Object> getParameters()

Gets the filter parameters.

Returns:

unmodifiable map of filter parameters

setParameter

public void setParameter(int position,
                         Object value)

Sets a positional filter parameter.

Parameters:

position - of the parameter in the filter

value - to set

setParameter

public void setParameter(String name,
                         Object value)

Sets a named filter parameter.

Parameters:

name - of the parameter in the filter

value - to set

setParameters

public void setParameters(Object[] values)

Sets positional filter parameters.

Parameters:

values - to set

format

public String format()

Returns this filter with it's parameters encoded and replaced. See encode(Object).

Returns:

formatted and encoded filter

encodeValue

public static String encodeValue(byte[] value)

Hex encodes the supplied byte array for use in a search filter.

Parameters:

value - to encode

Returns:

encoded value or null if supplied value is null

encodeValue

public static String encodeValue(String value)

Encodes the supplied attribute value for use in a search filter. See escape(String).

Parameters:

value - to encode

Returns:

encoded value or null if supplied value is null

encode

protected static String encode(Object obj)

Hex encodes the supplied object if it is of type byte[], otherwise the string format of the object is escaped. See escape(String).

Parameters:

obj - to encode

Returns:

encoded object

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