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

Class PresentFilter

java.lang.Object

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

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

public class PresentFilter
extends Filter

Object to store the filter. A filter is seen as a tree with a root.

Author:

Apache Directory Project

Field Summary

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

parent, parentTlvId, tlvId

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
int	computeLength()	Compute the PresentFilter length PresentFilter :
ByteBuffer	encode(ByteBuffer buffer)	Encode the PresentFilter message to a PDU.
String	getAttributeDescription()	Get the attribute
void	setAttributeDescription(String attributeDescription)	Set the attributeDescription
String	toString()	Return a string compliant with RFC 2254 representing a Present filter

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

PresentFilter

public PresentFilter(int tlvId)

The constructor.

Parameters:

tlvId - The TLV identifier

PresentFilter

public PresentFilter()

The constructor.

Method Detail

getAttributeDescription

public String getAttributeDescription()

Get the attribute

Returns:

Returns the attributeDescription.

setAttributeDescription

public void setAttributeDescription(String attributeDescription)

Set the attributeDescription

Parameters:

attributeDescription - The attributeDescription to set.

computeLength

public int computeLength()

Compute the PresentFilter length
PresentFilter :

 
 0x87 L1 present
 
 Length(PresentFilter) = Length(0x87) + Length(super.computeLength()) +
      super.computeLength()
 

Specified by:

computeLength in class Filter

Returns:

The encoded length

encode

public ByteBuffer encode(ByteBuffer buffer)
                  throws EncoderException

Encode the PresentFilter message to a PDU. PresentFilter : 0x87 LL attributeDescription

Specified by:

encode in class Filter

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 Present filter

Overrides:

toString in class Object

Returns:

The Present filter string