DsmlDecorator (org.apache.directory.api_api-all_sources-and-javadoc 2.1.1 API)

Type Parameters:

M - The message to decorate

All Known Implementing Classes:

AbandonRequestDsml, AbstractDsmlMessageDecorator, AbstractRequestDsml, AbstractResponseDsml, AbstractResultResponseDsml, AbstractResultResponseRequestDsml, AddRequestDsml, AddResponseDsml, BindRequestDsml, BindResponseDsml, CompareRequestDsml, CompareResponseDsml, DelRequestDsml, DelResponseDsml, DsmlControl, ErrorResponse, ExtendedRequestDsml, ExtendedResponseDsml, LdapResultDsml, ModDNResponseDsml, ModifyDNRequestDsml, ModifyRequestDsml, ModifyResponseDsml, SearchRequestDsml, SearchResponseDsml, SearchResultDoneDsml, SearchResultEntryDsml, SearchResultReferenceDsml
```
public interface DsmlDecorator<M>
```
This interface defines the methods that must be implemented to define a DSML Decorator

Author:

Apache Directory Project

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method	Description
`M`	`getDecorated()`	Gets the Message this DsmlDecorator decorates.
`Element`	`toDsml(Element root)`	Converts the request/reponse to its XML representation in the DSMLv2 format

- Method Detail
  - toDsml
```
Element toDsml(Element root)
```
    Converts the request/reponse to its XML representation in the DSMLv2 format
    
    Parameters:
    
    root - the root dom4j Element
    
    Returns:
    
    the dom4j Element corresponding to the entry.
  - getDecorated
```
M getDecorated()
```
    Gets the Message this DsmlDecorator decorates.
    
    Returns:
    
    The decorated Message instance