org.forgerock.opendj.ldap.messages

Class AbstractRequestVisitor<R,P,E extends Exception>

java.lang.Object

org.forgerock.opendj.ldap.messages.AbstractRequestVisitor<R,P,E>

Type Parameters:

R - The return type of this visitor's methods. Use Void for visitors that do not need to return results.

P - The type of the additional parameter to this visitor's methods. Use Void for visitors that do not need an additional parameter.

E - The type of the exception thrown by the visitor method if it fails, or NeverThrowsException if the visitor cannot fail.

All Implemented Interfaces:

RequestVisitor<R,P,E>

Direct Known Subclasses:

ChangeRecordVisitor

public class AbstractRequestVisitor<R,P,E extends Exception>
extends Object
implements RequestVisitor<R,P,E>

Abstract class that implements the RequestVisitor interface.

All the implemented methods forward calls to the overridable method visitAnyRequest(Object, Request) which only returns null.

Constructor Summary

Constructors

Constructor and Description
AbstractRequestVisitor()

Method Summary

Modifier and Type	Method and Description
protected R	visitAnyRequest(P p, Request request) Catch-all method visiting any request for which the visit method has not been overridden.
R	visitRequest(P p, AbandonRequest request) Visits an Abandon request.
R	visitRequest(P p, AddRequest request) Visits an Add request.
R	visitRequest(P p, BindRequest request) Visits an Bind request.
R	visitRequest(P p, CompareRequest request) Visits an Compare request.
R	visitRequest(P p, DeleteRequest request) Visits an Delete request.
R	visitRequest(P p, ExtendedRequest<?> request) Visits an Extended request.
R	visitRequest(P p, InvalidRequest request) Visits an Invalid request.
R	visitRequest(P p, ModifyDnRequest request) Visits an ModifyDN request.
R	visitRequest(P p, ModifyRequest request) Visits an Modify request.
R	visitRequest(P p, SearchRequest request) Visits an Search request.
R	visitRequest(P p, UnbindRequest request) Visits an Unbind request.
R	visitRequest(P p, UnknownRequest request) Visits an Unknown request.

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractRequestVisitor

public AbstractRequestVisitor()

Method Detail

visitRequest

public R visitRequest(P p,
                      AbandonRequest request)
               throws E extends Exception

Description copied from interface: RequestVisitor

Visits an Abandon request.

Specified by:

visitRequest in interface RequestVisitor<R,P,E extends Exception>

Parameters:

p - A visitor specified parameter.

request - The Abandon request.

Returns:

Returns a visitor specified result.

Throws:

E - If the visitor failed.

E extends Exception

visitRequest

public R visitRequest(P p,
                      AddRequest request)
               throws E extends Exception

Description copied from interface: RequestVisitor

Visits an Add request.

Specified by:

visitRequest in interface RequestVisitor<R,P,E extends Exception>

Parameters:

p - A visitor specified parameter.

request - The Add request.

Returns:

Returns a visitor specified result.

Throws:

E - If the visitor failed.

E extends Exception

visitRequest

public R visitRequest(P p,
                      BindRequest request)
               throws E extends Exception

Description copied from interface: RequestVisitor

Visits an Bind request.

Specified by:

visitRequest in interface RequestVisitor<R,P,E extends Exception>

Parameters:

p - A visitor specified parameter.

request - The Bind request.

Returns:

Returns a visitor specified result.

Throws:

E - If the visitor failed.

E extends Exception

visitRequest

public R visitRequest(P p,
                      CompareRequest request)
               throws E extends Exception

Description copied from interface: RequestVisitor

Visits an Compare request.

Specified by:

visitRequest in interface RequestVisitor<R,P,E extends Exception>

Parameters:

p - A visitor specified parameter.

request - The Compare request.

Returns:

Returns a visitor specified result.

Throws:

E - If the visitor failed.

E extends Exception

visitRequest

public R visitRequest(P p,
                      DeleteRequest request)
               throws E extends Exception

Description copied from interface: RequestVisitor

Visits an Delete request.

Specified by:

visitRequest in interface RequestVisitor<R,P,E extends Exception>

Parameters:

p - A visitor specified parameter.

request - The Delete request.

Returns:

Returns a visitor specified result.

Throws:

E - If the visitor failed.

E extends Exception

visitRequest

public R visitRequest(P p,
                      ExtendedRequest<?> request)
               throws E extends Exception

Description copied from interface: RequestVisitor

Visits an Extended request.

Specified by:

visitRequest in interface RequestVisitor<R,P,E extends Exception>

Parameters:

p - A visitor specified parameter.

request - The Extended request.

Returns:

Returns a visitor specified result.

Throws:

E - If the visitor failed.

E extends Exception

visitRequest

public R visitRequest(P p,
                      InvalidRequest request)
               throws E extends Exception

Description copied from interface: RequestVisitor

Visits an Invalid request.

Specified by:

visitRequest in interface RequestVisitor<R,P,E extends Exception>

Parameters:

p - A visitor specified parameter.

request - The Invalid request.

Returns:

Returns a visitor specified result.

Throws:

E - If the visitor failed.

E extends Exception

visitRequest

public R visitRequest(P p,
                      ModifyDnRequest request)
               throws E extends Exception

Description copied from interface: RequestVisitor

Visits an ModifyDN request.

Specified by:

visitRequest in interface RequestVisitor<R,P,E extends Exception>

Parameters:

p - A visitor specified parameter.

request - The ModifyDN request.

Returns:

Returns a visitor specified result.

Throws:

E - If the visitor failed.

E extends Exception

visitRequest

public R visitRequest(P p,
                      ModifyRequest request)
               throws E extends Exception

Description copied from interface: RequestVisitor

Visits an Modify request.

Specified by:

visitRequest in interface RequestVisitor<R,P,E extends Exception>

Parameters:

p - A visitor specified parameter.

request - The Modify request.

Returns:

Returns a visitor specified result.

Throws:

E - If the visitor failed.

E extends Exception

visitRequest

public R visitRequest(P p,
                      SearchRequest request)
               throws E extends Exception

Description copied from interface: RequestVisitor

Visits an Search request.

Specified by:

visitRequest in interface RequestVisitor<R,P,E extends Exception>

Parameters:

p - A visitor specified parameter.

request - The Search request.

Returns:

Returns a visitor specified result.

Throws:

E - If the visitor failed.

E extends Exception

visitRequest

public R visitRequest(P p,
                      UnbindRequest request)
               throws E extends Exception

Description copied from interface: RequestVisitor

Visits an Unbind request.

Specified by:

visitRequest in interface RequestVisitor<R,P,E extends Exception>

Parameters:

p - A visitor specified parameter.

request - The Unbind request.

Returns:

Returns a visitor specified result.

Throws:

E - If the visitor failed.

E extends Exception

visitRequest

public R visitRequest(P p,
                      UnknownRequest request)
               throws E extends Exception

Description copied from interface: RequestVisitor

Visits an Unknown request.

Specified by:

visitRequest in interface RequestVisitor<R,P,E extends Exception>

Parameters:

p - A visitor specified parameter.

request - The Unknown request.

Returns:

Returns a visitor specified result.

Throws:

E - If the visitor failed.

E extends Exception

visitAnyRequest

protected R visitAnyRequest(P p,
                            Request request)
                     throws E extends Exception

Catch-all method visiting any request for which the visit method has not been overridden.

Default behavior is to return null.

Parameters:

p - A visitor specified parameter.

request - A request.

Returns:

Returns a visitor specified result.

Throws:

E - If the visitor failed.

E extends Exception