SubtreeDeleteControl (OpenDJ Directory Services Project 5.2.0-SNAPSHOT API)

java.lang.Object
- org.opends.server.types.Control
- - org.opends.server.controls.SubtreeDeleteControl

```
public class SubtreeDeleteControl
extends Control
```
This class implements the subtree delete control defined in draft-armijo-ldap-treedelete. It makes it possible for clients to delete subtrees of entries.

Field Summary

Fields
Modifier and Type Field Description

static ControlDecoder<SubtreeDeleteControl> DECODER
The Control Decoder that can be used to decode this control.

Constructor Summary

Constructors
Constructor Description

SubtreeDeleteControl(boolean isCritical)
Creates a new subtree delete control.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`void`	`toString(StringBuilder buffer)`	Appends a string representation of this control to the provided buffer.
`protected void`	`writeValue(ASN1Writer writer)`	Writes this control's value to an ASN.1 writer.

Methods inherited from class org.opends.server.types.Control
getOID, isCritical, toString, write

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

- Field Detail
  - DECODER
```
public static final ControlDecoder<SubtreeDeleteControl> DECODER
```
    The Control Decoder that can be used to decode this control.
- Constructor Detail
  - SubtreeDeleteControl
```
public SubtreeDeleteControl(boolean isCritical)
```
    Creates a new subtree delete control.
    
    Parameters:
    
    isCritical - Indicates whether the control should be considered critical for the operation processing.
- Method Detail
  - writeValue
```
protected void writeValue(ASN1Writer writer)
                   throws IOException
```
    Description copied from class: Control
    
    Writes this control's value to an ASN.1 writer. The value (if any) must be written as an ASN1OctetString.
    
    Specified by:
    
    writeValue in class Control
    
    Parameters:
    
    writer - The ASN.1 writer to use.
    
    Throws:
    
    IOException - If a problem occurs while writing to the stream.
  - toString
```
public void toString(StringBuilder buffer)
```
    Description copied from class: Control
    
    Appends a string representation of this control to the provided buffer.
    
    Overrides:
    
    toString in class Control
    
    Parameters:
    
    buffer - The buffer to which the information should be appended.