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

Class MatchingRuleAssertionFilter

java.lang.Object

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

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

All Implemented Interfaces:

Filter

class MatchingRuleAssertionFilter
extends AbstractFilter

A class to represent the extensible matching filter.

Author:

Apache Directory Project

Constructor Summary

Constructors

Constructor	Description
MatchingRuleAssertionFilter(String attribute, String value, FilterOperator operator)	Creates a new instance of MatchingRuleAssertionFilter.

Method Summary

Modifier and Type	Method	Description
StringBuilder	build(StringBuilder builder)	Constructs a String representation of a Filter
static MatchingRuleAssertionFilter	extensible(String value)	Creates a new instance of MatchingRuleAssertionFilter without an attribute.
static MatchingRuleAssertionFilter	extensible(String attribute, String value)	Creates an extensible filter
MatchingRuleAssertionFilter	setMatchingRule(String matchingRule)	Sets the matching rule to use.
MatchingRuleAssertionFilter	useDnAttributes()	If set, the dn attributes will be included in the matching.

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

Constructor Detail

MatchingRuleAssertionFilter

MatchingRuleAssertionFilter(String attribute,
                            String value,
                            FilterOperator operator)

Creates a new instance of MatchingRuleAssertionFilter.

Parameters:

attribute - The attribute to test

value - The value to test for

operator - The FilterOperator

Method Detail

extensible

public static MatchingRuleAssertionFilter extensible(String value)

Creates a new instance of MatchingRuleAssertionFilter without an attribute.

Parameters:

value - The value to test for

Returns:

A new MatchingRuleAssertionFilter

extensible

public static MatchingRuleAssertionFilter extensible(String attribute,
                                                     String value)

Creates an extensible filter

Parameters:

attribute - The attribute to test

value - The value to test for

Returns:

A new MatchingRuleAssertionFilter

setMatchingRule

public MatchingRuleAssertionFilter setMatchingRule(String matchingRule)

Sets the matching rule to use. Can be either a name or an OID string.

Parameters:

matchingRule - The matching rule to use

Returns:

This filter

useDnAttributes

public MatchingRuleAssertionFilter useDnAttributes()

If set, the dn attributes will be included in the matching.

Returns:

This filter

build

public StringBuilder build(StringBuilder builder)

Constructs a String representation of a Filter

Parameters:

builder - The current buffer containing the on going representation of the filter

Returns:

The constructed String