Package org.apache.directory.api.dsmlv2.request

Class SubstringFilter

java.lang.Object

org.apache.directory.api.dsmlv2.request.Filter

org.apache.directory.api.dsmlv2.request.SubstringFilter

public class SubstringFilter
extends Filter

A Object that stores the substring filter. A substring filter follow this grammar : substring = attr "=" ( ([initial] any [final] | (initial [any] [final) | ([initial] [any] final) ) initial = value any = "*" *(value "*") final = value

Author:

Apache Directory Project

Constructor Summary

Constructors

Constructor	Description
SubstringFilter()

Method Summary

Modifier and Type	Method	Description
void	addAnySubstrings(String any)	Add a internal substring
List<String>	getAnySubstrings()	Get the internal substrings
String	getFinalSubstrings()	Get the final substring
String	getInitialSubstrings()	Get the initial substring
String	getType()	Get the attribute
void	setFinalSubstrings(String finalSubstrings)	Set the final substring
void	setInitialSubstrings(String initialSubstrings)	Set the initial substring
void	setType(String type)	Set the attribute to match
String	toString()	Return a string compliant with RFC 2254 representing a Substring filter

Methods inherited from class org.apache.directory.api.dsmlv2.request.Filter

getParent, setParent

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

SubstringFilter

public SubstringFilter()

Method Detail

getAnySubstrings

public List<String> getAnySubstrings()

Get the internal substrings

Returns:

Returns the anySubstrings.

addAnySubstrings

public void addAnySubstrings(String any)

Add a internal substring

Parameters:

any - The anySubstrings to set.

getFinalSubstrings

public String getFinalSubstrings()

Get the final substring

Returns:

Returns the finalSubstrings.

setFinalSubstrings

public void setFinalSubstrings(String finalSubstrings)

Set the final substring

Parameters:

finalSubstrings - The finalSubstrings to set.

getInitialSubstrings

public String getInitialSubstrings()

Get the initial substring

Returns:

Returns the initialSubstrings.

setInitialSubstrings

public void setInitialSubstrings(String initialSubstrings)

Set the initial substring

Parameters:

initialSubstrings - The initialSubstrings to set.

getType

public String getType()

Get the attribute

Returns:

Returns the type.

setType

public void setType(String type)

Set the attribute to match

Parameters:

type - The type to set.

toString

public String toString()

Return a string compliant with RFC 2254 representing a Substring filter

Overrides:

toString in class Object

Returns:

The substring filter string