org.apache.directory.ldap.client.api.search

Class SubstringFilter

java.lang.Object

org.apache.directory.ldap.client.api.search.AbstractFilter

org.apache.directory.ldap.client.api.search.SubstringFilter

All Implemented Interfaces:

Filter

final class SubstringFilter
extends AbstractFilter

A class used to manage Substring Filters.

Author:

Apache Directory Project

Field Summary

Fields

Modifier and Type	Field and Description
private String[]	any The array of any substring strings.
private String	attribute The AttributeType for this filter
private String	end The final substring string.
private String	initial The initial substring string.

Constructor Summary

Constructors

Modifier	Constructor and Description
private	SubstringFilter(String attribute, String initial, String[] any, String end) A private constructor that builds a SubstringFilter

Method Summary

Modifier and Type	Method and Description
StringBuilder	build(StringBuilder builder)
static SubstringFilter	contains(String attribute, String... parts) Create a SubstringFilter based on the filter elements.
static SubstringFilter	endsWith(String attribute, String... parts) Create a SubstringFilter based on the filter elements.
static SubstringFilter	startsWith(String attribute, String... parts) Create a SubstringFilter based on the filter elements.
static SubstringFilter	substring(String attribute, String... parts) Create a SubstringFilter based on the filter elements.

Methods inherited from class org.apache.directory.ldap.client.api.search.AbstractFilter

build

Methods inherited from class java.lang.Object

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

Field Detail

attribute

private String attribute

The AttributeType for this filter

initial

private String initial

The initial substring string. It may be null

any

private String[] any

The array of any substring strings. It may be null

end

private String end

The final substring string. It may be null

Constructor Detail

SubstringFilter

private SubstringFilter(String attribute,
                        String initial,
                        String[] any,
                        String end)

A private constructor that builds a SubstringFilter

Method Detail

startsWith

public static SubstringFilter startsWith(String attribute,
                                         String... parts)

Create a SubstringFilter based on the filter elements. Such a filter has a form like Attribute=initial*([any]*)*. We don't expect any final String.

Parameters:

attribute - The AttributeType for this filter

parts - The parts that are the initial string and zero to N any strings

Returns:

An instance of a SubstringFilter

endsWith

public static SubstringFilter endsWith(String attribute,
                                       String... parts)

Create a SubstringFilter based on the filter elements. Such a filter has a form like Attribute=*([any]*)*final. We don't expect any initial String.

Parameters:

attribute - The AttributeType for this filter

parts - The parts that are zero to N any strings followed by a final string

Returns:

An instance of a SubstringFilter

contains

public static SubstringFilter contains(String attribute,
                                       String... parts)

Create a SubstringFilter based on the filter elements. Such a filter has a form like Attribute=*([any]*)*. We don't expect any initialor final Strings.

Parameters:

attribute - The AttributeType for this filter

parts - The parts that are zero to N any strings with no initial nor final Strings

Returns:

An instance of a SubstringFilter

substring

public static SubstringFilter substring(String attribute,
                                        String... parts)

Create a SubstringFilter based on the filter elements. Such a filter has a form like Attribute=initial*([any]*)*final.

Parameters:

attribute - The AttributeType for this filter

parts - The parts that are zero to N any strings starting with an initial String and followed by a final string

Returns:

An instance of a SubstringFilter

build

public StringBuilder build(StringBuilder builder)