SubentriesContainer (Apache LDAP API 2.1.1 API Documentation)

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

All Implemented Interfaces:: Asn1Container, ControlContainer

public class SubentriesContainer
extends AbstractContainer
implements ControlContainer

Author:: Apache Directory Project

Constructor Summary

Constructors
Constructor Description

SubentriesContainer(Control control)
Creates a new SubEntryControlContainer object, pre-populating it with the supplied Subentries control.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`void`	`clean()`	Clean the current container
`Subentries`	`getSubentriesControl()`
`void`	`setControl(Control control)`	Set a SubEntryControl Object into the container.

Methods inherited from class org.apache.directory.api.asn1.ber.AbstractContainer
getCurrentTLV, getDecodedBytes, getGrammar, getMaxPDUSize, getNewTlvId, getParentTLV, getState, getStream, getTlvId, getTransition, incrementDecodedBytes, isGathering, isGrammarEndAllowed, rewind, setCurrentTLV, setDecodedBytes, setGathering, setGrammar, setGrammarEndAllowed, setMaxPDUSize, setParentTLV, setState, setStream, setTransition, updateParent

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

Methods inherited from interface org.apache.directory.api.asn1.ber.Asn1Container
getCurrentTLV, getDecodedBytes, getGrammar, getMaxPDUSize, getNewTlvId, getParentTLV, getState, getStream, getTlvId, getTransition, incrementDecodedBytes, isGathering, isGrammarEndAllowed, rewind, setCurrentTLV, setDecodedBytes, setGathering, setGrammar, setGrammarEndAllowed, setMaxPDUSize, setParentTLV, setState, setStream, setTransition, updateParent

- Constructor Detail
  - SubentriesContainer
```
public SubentriesContainer(Control control)
```
    Creates a new SubEntryControlContainer object, pre-populating it with the supplied Subentries control.
    
    Parameters:
    
    control - The Subentries Control to add to this container
- Method Detail
  - getSubentriesControl
```
public Subentries getSubentriesControl()
```
    Returns:
    
    Returns the persistent search control.
  - setControl
```
public void setControl(Control control)
```
    Set a SubEntryControl Object into the container. It will be completed by the ldapDecoder.
    
    Specified by:
    
    setControl in interface ControlContainer
    
    Parameters:
    
    control - the SubEntryControl to set.
  - clean
```
public void clean()
```
    Clean the current container
    
    Overrides:
    
    clean in class AbstractContainer