Package org.ldaptive.filter

Class SubstringFilter

java.lang.Object

org.ldaptive.filter.SubstringFilter

All Implemented Interfaces:

Filter

public class SubstringFilter
extends Object
implements Filter

Substring search filter component defined as:

 (attributeDescription=attributeValueWithWildCard)
 

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	SubstringFilter.Substrings	Type of substring match.

Nested classes/interfaces inherited from interface org.ldaptive.filter.Filter

Filter.Type

Field Summary

Fields

Modifier and Type	Field	Description
private final String	attributeDesc	Attribute description.
private static final int	HASH_CODE_SEED	hash code seed.
private final byte[][]	subAny	Substring any .
private final byte[]	subFinal	Substring final.
private final byte[]	subInitial	Substring initial.

Constructor Summary

Constructors

Constructor	Description
SubstringFilter(String name, byte[] startsWith, byte[] endsWith, byte[]... contains)	Creates a new substring filter.
SubstringFilter(String name, String startsWith, String endsWith, String... contains)	Creates a new substring filter.

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object o)
private int	getAssertionCount()	Returns the number of assertions in this substring filter.
String	getAttributeDesc()	Returns the attribute description.
DEREncoder	getEncoder()	Returns the encoder for this filter.
byte[][]	getSubAny()	Returns the any substring assertion.
byte[]	getSubFinal()	Returns the final substring assertion.
byte[]	getSubInitial()	Returns the initial substring assertion.
int	hashCode()
String	toString()

Methods inherited from class java.lang.Object

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

Field Details

HASH_CODE_SEED

private static final int HASH_CODE_SEED

hash code seed.

See Also:

• Constant Field Values

attributeDesc

private final String attributeDesc

Attribute description.

subInitial

private final byte[] subInitial

Substring initial.

subAny

private final byte[][] subAny

Substring any .

subFinal

private final byte[] subFinal

Substring final.

Constructor Details

SubstringFilter

public SubstringFilter(String name,
 String startsWith,
 String endsWith,
 String... contains)

Creates a new substring filter.

Parameters:

name - attribute description

startsWith - substring initial

endsWith - substring final

contains - substring any

SubstringFilter

public SubstringFilter(String name,
 byte[] startsWith,
 byte[] endsWith,
 byte[]... contains)

Creates a new substring filter.

Parameters:

name - attribute description

startsWith - substring initial

endsWith - substring final

contains - substring any

Method Details

getAttributeDesc

public String getAttributeDesc()

Returns the attribute description.

Returns:

attribute description

getSubInitial

public byte[] getSubInitial()

Returns the initial substring assertion.

Returns:

initial substring assertion

getSubAny

public byte[][] getSubAny()

Returns the any substring assertion.

Returns:

any substring assertion

getSubFinal

public byte[] getSubFinal()

Returns the final substring assertion.

Returns:

final substring assertion

getAssertionCount

private int getAssertionCount()

Returns the number of assertions in this substring filter.

Returns:

assertion count

getEncoder

public DEREncoder getEncoder()

Description copied from interface: Filter

Returns the encoder for this filter.

Specified by:

getEncoder in interface Filter

Returns:

DER encoder

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