org.apache.directory.api.ldap.codec.controls.search.subentries

Class SubentriesFactory

java.lang.Object

org.apache.directory.api.ldap.codec.controls.search.subentries.SubentriesFactory

All Implemented Interfaces:

ControlFactory<Subentries>

public class SubentriesFactory
extends Object
implements ControlFactory<Subentries>

A factory for creating Subentries Controls and their SubentriesDecorator objects.

Version:

$Rev$, $Date$

Author:

Apache Directory Project

Constructor Summary

Constructors

Constructor and Description
SubentriesFactory(LdapApiService codec) Creates a new instance of SubentriesFactory.

Method Summary

Modifier and Type	Method and Description
String	getOid()
CodecControl<Subentries>	newCodecControl() Creates and returns a decorated version of the Control.
CodecControl<Subentries>	newCodecControl(Subentries control) Decorates an existing control.

Methods inherited from class java.lang.Object

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

Constructor Detail

SubentriesFactory

public SubentriesFactory(LdapApiService codec)

Creates a new instance of SubentriesFactory.

Parameters:

codec -

Method Detail

getOid

public String getOid()

Specified by:

getOid in interface ControlFactory<Subentries>

Returns:

The OID of the Control this factory creates.

newCodecControl

public CodecControl<Subentries> newCodecControl()

Creates and returns a decorated version of the Control.

Specified by:

newCodecControl in interface ControlFactory<Subentries>

Returns:

The CodecControl decorated version of the Control.

newCodecControl

public CodecControl<Subentries> newCodecControl(Subentries control)

Decorates an existing control. Implementors should check to make sure the supplied Control has not already been decorated to prevent needless decorator nesting.

Specified by:

newCodecControl in interface ControlFactory<Subentries>

Parameters:

control - The Control to be decorated.

Returns:

The decorator wrapping the Control.