Module ai.docling.serve.client

Package ai.docling.serve.client

Class DoclingServeClientBuilderFactory

java.lang.Object

ai.docling.serve.client.DoclingServeClientBuilderFactory

All Implemented Interfaces:

ai.docling.serve.api.spi.DoclingServeApiBuilderFactory

public final class DoclingServeClientBuilderFactory
extends Object
implements ai.docling.serve.api.spi.DoclingServeApiBuilderFactory

A factory class for creating instances of DoclingServeClient.DoclingServeClientBuilder.

This factory determines which version of Jackson (2 or 3) is available on the application's classpath and provides a corresponding builder for creating DoclingServeClient implementations.

If neither Jackson 2 nor Jackson 3 is present on the classpath, an IllegalStateException is thrown.

The factory uses a type-safe generic method to support custom subclasses of DoclingServeClient and DoclingServeClient.DoclingServeClientBuilder.

Constructor Summary

Constructors

Constructor	Description
DoclingServeClientBuilderFactory()

Method Summary

Modifier and Type	Method	Description
<T extends ai.docling.serve.api.DoclingServeApi, B extends ai.docling.serve.api.DoclingServeApi.DoclingApiBuilder<T, B>> B	getBuilder()
static <C extends DoclingServeClient, B extends DoclingServeClient.DoclingServeClientBuilder<C, B>> B	newBuilder()	Creates and returns a new instance of a DoclingServeClient.DoclingServeClientBuilder that is compatible with the version of Jackson available on the application's classpath.
static <C extends DoclingServeClient, B extends DoclingServeClient.DoclingServeClientBuilder<C, B>> B	newBuilder(ClassLoader classLoader)	Creates and returns a new instance of a DoclingServeClient.DoclingServeClientBuilder compatible with the Jackson version present on the provided classloader's classpath.

Methods inherited from class java.lang.Object

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

Constructor Details

DoclingServeClientBuilderFactory

public DoclingServeClientBuilderFactory()

Method Details

newBuilder

public static <C extends DoclingServeClient,
B extends DoclingServeClient.DoclingServeClientBuilder<C,
B>>
B newBuilder(ClassLoader classLoader)

Creates and returns a new instance of a DoclingServeClient.DoclingServeClientBuilder compatible with the Jackson version present on the provided classloader's classpath.

If Jackson 3 is detected, returns a builder for DoclingServeJackson3Client. If Jackson 2 is detected, returns a builder for DoclingServeJackson2Client. If neither version of Jackson is found on the classpath, an IllegalStateException is thrown.

The method uses generics to support custom implementations of DoclingServeClient and DoclingServeClient.DoclingServeClientBuilder.

Type Parameters:

C - the type of DoclingServeClient to be created by the builder

B - the type of DoclingServeClient.DoclingServeClientBuilder to be returned

Parameters:

classLoader - the ClassLoader used to check for Jackson's presence

Returns:

a compatible DoclingServeClient.DoclingServeClientBuilder instance

Throws:

IllegalStateException - if neither Jackson 2 nor Jackson 3 is available on the classpath

newBuilder

public static <C extends DoclingServeClient,
B extends DoclingServeClient.DoclingServeClientBuilder<C,
B>>
B newBuilder()

Creates and returns a new instance of a DoclingServeClient.DoclingServeClientBuilder that is compatible with the version of Jackson available on the application's classpath.

If Jackson 3 is found on the classpath, it returns a builder for DoclingServeJackson3Client. If Jackson 2 is found, it returns a builder for DoclingServeJackson2Client. If neither are found, an IllegalStateException is thrown.

This method utilizes generics to support custom implementations of DoclingServeClient and DoclingServeClient.DoclingServeClientBuilder.

Type Parameters:

C - the type of DoclingServeClient to be created by the builder

B - the type of DoclingServeClient.DoclingServeClientBuilder to be returned

Returns:

a compatible DoclingServeClient.DoclingServeClientBuilder instance

Throws:

IllegalStateException - if neither Jackson 2 nor Jackson 3 is available on the classpath

getBuilder

public <T extends ai.docling.serve.api.DoclingServeApi,
B extends ai.docling.serve.api.DoclingServeApi.DoclingApiBuilder<T,
B>>
B getBuilder()

Specified by:

getBuilder in interface ai.docling.serve.api.spi.DoclingServeApiBuilderFactory