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

Class OrFilter

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.OrFilter

public class OrFilter
extends ConnectorFilter

Or Filter Object to store the Or 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
OrFilter()	The constructor.
OrFilter(int tlvId)	The constructor.

Method Summary

Modifier and Type	Method	Description
int	computeLength()	Compute the OrFilter length OrFilter :
ByteBuffer	encode(ByteBuffer buffer)	Encode the OrFilter message to a PDU.
List<Filter>	getOrFilter()	Get the OrFilter
String	toString()	Return a string compliant with RFC 2254 representing an OR filter

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

addFilter, 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

OrFilter

public OrFilter(int tlvId)

The constructor. We wont initialize the ArrayList as they may not be used.

Parameters:

tlvId - The TLV identifier

OrFilter

public OrFilter()

The constructor. We wont initialize the ArrayList as they may not be used.

Method Detail

getOrFilter

public List<Filter> getOrFilter()

Get the OrFilter

Returns:

Returns the orFilter.

computeLength

public int computeLength()

Compute the OrFilter length
OrFilter :

 
 0xA1 L1 super.computeLength()
 
 Length(OrFilter) = Length(0xA1) + Length(super.computeLength()) +
      super.computeLength()
 

Overrides:

computeLength in class ConnectorFilter

Returns:

The encoded length

encode

public ByteBuffer encode(ByteBuffer buffer)
                  throws EncoderException

Encode the OrFilter message to a PDU.
OrFilter :

 
   0xA1 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 an OR filter

Overrides:

toString in class ConnectorFilter

Returns:

The OR filter string