org.apache.directory.shared.ldap.codec.search.controls
Class SubEntryControl

java.lang.Object
  org.apache.directory.shared.asn1.Asn1Object
      org.apache.directory.shared.ldap.codec.search.controls.SubEntryControl

public class SubEntryControl
extends org.apache.directory.shared.asn1.Asn1Object

A searchRequest control : SubEntry

Version:

$Rev: 503333 $

Author:

Apache Directory Project

Field Summary

Fields inherited from class org.apache.directory.shared.asn1.Asn1Object

parent

Constructor Summary

SubEntryControl()
Default constructor

Method Summary

int	computeLength() Compute the SubEntryControl length 0x01 0x01 [0x00|0xFF]
java.nio.ByteBuffer	encode(java.nio.ByteBuffer buffer) Encodes the subEntry control.
boolean	isVisible() Check if the subEntry is visible
void	setVisibility(boolean visibility) Set the visibility flag
java.lang.String	toString() Return a String representing this EntryChangeControl.

Methods inherited from class org.apache.directory.shared.asn1.Asn1Object

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

SubEntryControl

public SubEntryControl()

Default constructor

Method Detail

isVisible

public boolean isVisible()

Check if the subEntry is visible

Returns:

true or false.

setVisibility

public void setVisibility(boolean visibility)

Set the visibility flag

Parameters:

visibility - The visibility flag : true or false

computeLength

public int computeLength()

Compute the SubEntryControl length 0x01 0x01 [0x00|0xFF]

Specified by:

computeLength in class org.apache.directory.shared.asn1.Asn1Object

encode

public java.nio.ByteBuffer encode(java.nio.ByteBuffer buffer)
                           throws org.apache.directory.shared.asn1.codec.EncoderException

Encodes the subEntry control.

Overrides:

encode in class org.apache.directory.shared.asn1.Asn1Object

Parameters:

buffer - The encoded sink

Returns:

A ByteBuffer that contains the encoded PDU

Throws:

org.apache.directory.shared.asn1.codec.EncoderException - If anything goes wrong.

toString

public java.lang.String toString()

Return a String representing this EntryChangeControl.

Overrides:

toString in class java.lang.Object