org.apache.directory.shared.ldap.codec.controls.search.subentries
Class SubentriesContainer

java.lang.Object
  org.apache.directory.shared.asn1.ber.AbstractContainer
      org.apache.directory.shared.ldap.codec.controls.search.subentries.SubentriesContainer

All Implemented Interfaces:

Asn1Container

public class SubentriesContainer
extends AbstractContainer

Author:

Apache Directory Project

Field Summary

Fields inherited from class org.apache.directory.shared.asn1.ber.AbstractContainer

decodeBytes, grammar, stateStack

Constructor Summary

SubentriesContainer()
Creates a new SubEntryControlContainer object.

SubentriesContainer(SubentriesDecorator control)
Creates a new SubEntryControlContainer object, pre-populating it with the supplied Subentries control, and optionally wrapping it with a decorator if it is not a decorator instance.

Method Summary

void	clean() Clean the current container
SubentriesDecorator	getSubentriesControl()
void	setSubentriesDecorator(SubentriesDecorator decorator) Set a SubEntryControl Object into the container.

Methods inherited from class org.apache.directory.shared.asn1.ber.AbstractContainer

getCurrentTLV, getDecodeBytes, getGrammar, getMaxPDUSize, getNewTlvId, getParentTLV, getState, getStream, getTlvId, getTransition, incrementDecodeBytes, isGathering, isGrammarEndAllowed, rewind, setCurrentTLV, setGathering, setGrammarEndAllowed, setMaxPDUSize, setParentTLV, setState, setStream, setTransition, updateParent

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

SubentriesContainer

public SubentriesContainer()

Creates a new SubEntryControlContainer object.

SubentriesContainer

public SubentriesContainer(SubentriesDecorator control)

Creates a new SubEntryControlContainer object, pre-populating it with the supplied Subentries control, and optionally wrapping it with a decorator if it is not a decorator instance.

Parameters:

control - The Subentries Control to decorate and add to this container, or if the Control already is a ControlDecorator it is directly added.

Method Detail

getSubentriesControl

public SubentriesDecorator getSubentriesControl()

Returns:

Returns the persistent search control.

setSubentriesDecorator

public void setSubentriesDecorator(SubentriesDecorator decorator)

Set a SubEntryControl Object into the container. It will be completed by the ldapDecoder.

Parameters:

decorator - the SubEntryControl to set.

clean

public void clean()

Clean the current container

Overrides:

clean in class AbstractContainer