org.apache.directory.shared.ldap.codec.search
Class PresentFilter

java.lang.Object
  extended by org.apache.directory.shared.asn1.AbstractAsn1Object
      extended by org.apache.directory.shared.ldap.codec.search.Filter
          extended by org.apache.directory.shared.ldap.codec.search.PresentFilter
All Implemented Interfaces:
Asn1Object

public class PresentFilter
extends Filter

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

Version:
$Rev: 664290 $, $Date: 2008-06-07 08:28:06 +0200 (Sa, 07 Jun 2008) $,
Author:
Apache Directory Project

Field Summary
 
Fields inherited from class org.apache.directory.shared.asn1.AbstractAsn1Object
parent
 
Constructor Summary
PresentFilter()
          The constructor.
PresentFilter(int tlvId)
          The constructor.
 
Method Summary
 int computeLength()
          Compute the PresentFilter length PresentFilter : 0x87 L1 present Length(PresentFilter) = Length(0x87) + Length(super.computeLength()) + super.computeLength()
 java.nio.ByteBuffer encode(java.nio.ByteBuffer buffer)
          Encode the PresentFilter message to a PDU.
 java.lang.String getAttributeDescription()
          Get the attribute
 void setAttributeDescription(java.lang.String attributeDescription)
          Set the attributeDescription
 java.lang.String toString()
          Return a string compliant with RFC 2254 representing a Present filter
 
Methods inherited from class org.apache.directory.shared.asn1.AbstractAsn1Object
addLength, getCurrentLength, getExpectedLength, getParent, getTlvId, setCurrentLength, setExpectedLength, 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.


PresentFilter

public PresentFilter()
The constructor.

Method Detail

getAttributeDescription

public java.lang.String getAttributeDescription()
Get the attribute

Returns:
Returns the attributeDescription.

setAttributeDescription

public void setAttributeDescription(java.lang.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 interface Asn1Object
Specified by:
computeLength in class AbstractAsn1Object
Returns:
The object's computed length

encode

public java.nio.ByteBuffer encode(java.nio.ByteBuffer buffer)
                           throws EncoderException
Encode the PresentFilter message to a PDU. PresentFilter : 0x87 LL attributeDescription

Specified by:
encode in interface Asn1Object
Overrides:
encode in class AbstractAsn1Object
Parameters:
buffer - The buffer where to put the PDU
Returns:
The PDU.
Throws:
EncoderException - if the buffer can't be encoded

toString

public java.lang.String toString()
Return a string compliant with RFC 2254 representing a Present filter

Overrides:
toString in class java.lang.Object
Returns:
The Present filter string


Copyright © 2003-2011 Apache Software Foundation. All Rights Reserved.