Package org.forgerock.opendj.ldap.messages

Class AbstractExtendedResultDecoder<S extends ExtendedResult>

java.lang.Object

org.forgerock.opendj.ldap.messages.AbstractExtendedResultDecoder<S>

Type Parameters:

S - The type of result.

All Implemented Interfaces:

ExtendedResultDecoder<S>

public abstract class AbstractExtendedResultDecoder<S extends ExtendedResult>
extends Object
implements ExtendedResultDecoder<S>

This class provides a skeletal implementation of the ExtendedResultDecoder interface, to minimize the effort required to implement this interface.

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	AbstractExtendedResultDecoder()	Creates a new abstract extended result decoder.

Method Summary

Modifier and Type	Method	Description
abstract S	decodeExtendedResult(ExtendedResult result, DecodeOptions options)	Decodes the provided extended operation result as a Result of type S.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.forgerock.opendj.ldap.messages.ExtendedResultDecoder

getExtendedResultClass

Constructor Details

AbstractExtendedResultDecoder

protected AbstractExtendedResultDecoder()

Creates a new abstract extended result decoder.

Method Details

decodeExtendedResult

public abstract S decodeExtendedResult(ExtendedResult result,
 DecodeOptions options)
                                throws DecodeException

Description copied from interface: ExtendedResultDecoder

Decodes the provided extended operation result as a Result of type S. This method is called when an extended result is received from the server. The result may indicate success or failure of the extended request.

Specified by:

decodeExtendedResult in interface ExtendedResultDecoder<S extends ExtendedResult>

Parameters:

result - The extended operation result to be decoded.

options - The set of decode options which should be used when decoding the extended operation result.

Returns:

The decoded extended operation result.

Throws:

DecodeException - If the provided extended operation result could not be decoded. For example, if the request name was wrong, or if the request value was invalid.