com.marklogic.client

Interface DatabaseClientFactory.HandleFactoryRegistry

Enclosing class:

DatabaseClientFactory

public static interface DatabaseClientFactory.HandleFactoryRegistry

A HandleFactoryRegistry associates IO representation classes with handle factories. The API uses the registry to create a content handle to act as an adapter for a supported IO representation class. The IO class and its instances can then be passed directly to convenience methods. The default registry associates the content handles provided by the API and the supported IO representation classes. Create instances of this interface only if you need to modify the default registry.

See Also:

DatabaseClientFactory.getHandleRegistry(), DatabaseClientFactory.Bean.getHandleRegistry()

Method Summary

Modifier and Type	Method and Description
DatabaseClientFactory.HandleFactoryRegistry	copy() Create a copy of the current registry
boolean	isRegistered(Class<?> ioClass) Returns whether the registry associates the class with a factory.
Set<Class<?>>	listRegistered() Returns the classes for the IO representations for which a factory has been registered.
<C> ContentHandle<C>	makeHandle(Class<C> type) Creates a ContentHandle if the registry has a factory for the class of the IO representation.
void	register(ContentHandleFactory factory) Associates a factory for content handles with the classes for IO representations known to the factory.
void	register(ContentHandleFactory factory, Class<?>... ioClasses) Associates a factory for content handles with the specified classes for IO representations.
void	unregister(Class<?>... ioClasses) Removes the classes from the registry

Method Detail

register

void register(ContentHandleFactory factory)

Associates a factory for content handles with the classes for IO representations known to the factory.

Parameters:

factory - a factory for creating content handle instances

register

void register(ContentHandleFactory factory,
              Class<?>... ioClasses)

Associates a factory for content handles with the specified classes for IO representations.

Parameters:

factory - a factory for creating content handle instances

ioClasses - the IO classes for which the factory should create handles

isRegistered

boolean isRegistered(Class<?> ioClass)

Returns whether the registry associates the class with a factory.

Parameters:

ioClass - the class for an IO representation

Returns:

true if a factory has been registered

listRegistered

Set<Class<?>> listRegistered()

Returns the classes for the IO representations for which a factory has been registered.

Returns:

the IO classes

makeHandle

<C> ContentHandle<C> makeHandle(Class<C> type)

Creates a ContentHandle if the registry has a factory for the class of the IO representation.

Type Parameters:

C - the registered type for the returned handle

Parameters:

type - the class for an IO representation

Returns:

a content handle or null if no factory supports the class

unregister

void unregister(Class<?>... ioClasses)

Removes the classes from the registry

Parameters:

ioClasses - one or more registered classes for an IO representation

copy

DatabaseClientFactory.HandleFactoryRegistry copy()

Create a copy of the current registry

Returns:

a copy of the current registry