org.springframework.ldap.filter
Class NotPresentFilter

java.lang.Object
  org.springframework.ldap.filter.AbstractFilter
      org.springframework.ldap.filter.NotPresentFilter

All Implemented Interfaces:

Filter

public class NotPresentFilter
extends AbstractFilter

A convenience class that combines NOT behavior with present behavior to allow the user to check for the non-existence of a attribute. For an attribute to be NOT present it must not have any values set. To filter on attributes at are present use the PresentFilter.

 NotPresentFilter filter = new NotPresentFilter("foo*");
 System.out.println(filter.encode());
 

would result in:

  (!(foo=*))
 

Author:

Jordan Hein

Constructor Summary

NotPresentFilter(String attribute)
Creates a new instance of a not present filter for a particular attribute.

Method Summary

StringBuffer

encode(StringBuffer buff) Encodes the filter to a StringBuffer.

Methods inherited from class org.springframework.ldap.filter.AbstractFilter

encode, toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.springframework.ldap.filter.Filter

equals, hashCode

Constructor Detail

NotPresentFilter

public NotPresentFilter(String attribute)

Creates a new instance of a not present filter for a particular attribute.

Parameters:

attribute - the attribute expected to be not-present (ie, unset, or null).

Method Detail

encode

public StringBuffer encode(StringBuffer buff)

Description copied from interface: Filter

Encodes the filter to a StringBuffer.

Specified by:

encode in interface Filter

Specified by:

encode in class AbstractFilter

Parameters:

buff - The StringBuffer to encode the filter to

Returns:

The same StringBuffer as was given