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

Class NotFilter

java.lang.Object

org.apache.directory.api.ldap.codec.search.Filter

org.apache.directory.api.ldap.codec.search.ConnectorFilter

org.apache.directory.api.ldap.codec.search.NotFilter

public class NotFilter
extends ConnectorFilter

Not Filter Object to store the Not filter.

Author:

Apache Directory Project

Field Summary

Fields inherited from class org.apache.directory.api.ldap.codec.search.ConnectorFilter

filterSet, filtersLength

Fields inherited from class org.apache.directory.api.ldap.codec.search.Filter

parent, parentTlvId, tlvId

Constructor Summary

Constructors

Constructor	Description
NotFilter()	The constructor.
NotFilter(int tlvId)	The constructor.

Method Summary

Modifier and Type	Method	Description
void	addFilter(Filter filter)	Subclass the addFilterMethod, as this is specific for a NotFilter (we cannot have more than one elements).
int	computeLength()	Compute the NotFilter length NotFilter :
ByteBuffer	encode(ByteBuffer buffer)	Encode the NotFilter message to a PDU.
Filter	getNotFilter()	Get the NotFilter
void	setNotFilter(Filter notFilter)	Set the NotFilter
String	toString()	Return a string compliant with RFC 2254 representing a NOT filter

Methods inherited from class org.apache.directory.api.ldap.codec.search.ConnectorFilter

getFilterSet

Methods inherited from class org.apache.directory.api.ldap.codec.search.Filter

getParent, getParentTlvId, getTlvId, setParent

Methods inherited from class java.lang.Object

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

Constructor Detail

NotFilter

public NotFilter(int tlvId)

The constructor.

Parameters:

tlvId - The TLV identifier

NotFilter

public NotFilter()

The constructor.

Method Detail

addFilter

public void addFilter(Filter filter)
               throws DecoderException

Subclass the addFilterMethod, as this is specific for a NotFilter (we cannot have more than one elements).

Overrides:

addFilter in class ConnectorFilter

Parameters:

filter - The Filter to add

Throws:

DecoderException - If the decoding failed

getNotFilter

public Filter getNotFilter()

Get the NotFilter

Returns:

Returns the notFilter.

setNotFilter

public void setNotFilter(Filter notFilter)
                  throws DecoderException

Set the NotFilter

Parameters:

notFilter - The notFilter to set.

Throws:

DecoderException - If the NotFilter is already containing a filter

computeLength

public int computeLength()

Compute the NotFilter length
NotFilter :

 
 0xA2 L1 super.computeLength()
 
 Length(NotFilter) = Length(0xA2) + Length(super.computeLength()) +
      super.computeLength()
 

Overrides:

computeLength in class ConnectorFilter

Returns:

The encoded length

encode

public ByteBuffer encode(ByteBuffer buffer)
                  throws EncoderException

Encode the NotFilter message to a PDU.
NotFilter :

 
 0xA2 LL filter.encode()
 

Overrides:

encode in class ConnectorFilter

Parameters:

buffer - The buffer where to put the PDU

Returns:

The PDU.

Throws:

EncoderException - If the encoding failed

toString

public String toString()

Return a string compliant with RFC 2254 representing a NOT filter

Overrides:

toString in class ConnectorFilter

Returns:

The NOT filter string