Filter (Apache LDAP API 2.1.1 API Documentation)

java.lang.Object
- org.apache.directory.api.ldap.codec.search.Filter

Direct Known Subclasses:

AttributeValueAssertionFilter, ConnectorFilter, ExtensibleMatchFilter, PresentFilter, SubstringFilter
```
public abstract class Filter
extends Object
```
An abstract Asn1Object used to store the filter. A filter is seen as a tree with a root. This class does nothing, it's just the root of all the different filters.

Author:

Apache Directory Project

Constructor Summary

Constructors
Constructor Description

Filter()
The constructor.

Filter(int tlvId)
The constructor.

Method Summary

All Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method	Description
`abstract int`	`computeLength()`	Compute the Filter length
`abstract ByteBuffer`	`encode(ByteBuffer buffer)`	Encode the Filter message to a PDU.
`Filter`	`getParent()`	Get the parent
`int`	`getParentTlvId()`	Get the parent
`int`	`getTlvId()`
`void`	`setParent(Filter parent, int parentTlvId)`	Set the parent

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - Filter
```
public Filter(int tlvId)
```
    The constructor.
    
    Parameters:
    
    tlvId - The TLV identifier
  - Filter
```
public Filter()
```
    The constructor.
- Method Detail
  - getParent
```
public Filter getParent()
```
    Get the parent
    
    Returns:
    
    Returns the parent.
  - getParentTlvId
```
public int getParentTlvId()
```
    Get the parent
    
    Returns:
    
    Returns the parent.
  - setParent
```
public void setParent(Filter parent,
                      int parentTlvId)
```
    Set the parent
    
    Parameters:
    
    parent - The parent to set.
    
    parentTlvId - The Parent TLV identifier
  - getTlvId
```
public int getTlvId()
```
    Returns:
    
    The TLV identifier
  - computeLength
```
public abstract int computeLength()
```
    Compute the Filter length
    
    Returns:
    
    the encoded length
  - encode
```
public abstract ByteBuffer encode(ByteBuffer buffer)
                           throws EncoderException
```
    Encode the Filter message to a PDU.
    
    Parameters:
    
    buffer - The buffer where to put the PDU
    
    Returns:
    
    The PDU.
    
    Throws:
    
    EncoderException - If the encoding failed