io.lettuce.core

Class DriverInfo.Builder

java.lang.Object

io.lettuce.core.DriverInfo.Builder

Enclosing class:

DriverInfo

public static class DriverInfo.Builder
extends Object

Builder for creating DriverInfo instances.

Method Summary

Modifier and Type	Method and Description
DriverInfo.Builder	addUpstreamDriver(String driverName, String driverVersion) Adds an upstream driver to the driver information.
DriverInfo	build() Builds and returns a new immutable DriverInfo instance.
DriverInfo.Builder	name(String name) Sets the base library name.

Methods inherited from class java.lang.Object

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

Method Detail

name

public DriverInfo.Builder name(String name)

Sets the base library name.

This overrides the default name ("Lettuce"). Use this when you want to completely customise the library identification.

Parameters:

name - the library name, must not be null

Returns:

this builder

Throws:

IllegalArgumentException - if name is null

addUpstreamDriver

public DriverInfo.Builder addUpstreamDriver(String driverName,
                                            String driverVersion)

Adds an upstream driver to the driver information.

Upstream drivers are prepended to the list, so the most recently added driver appears first in the formatted output.

The driver name must follow Maven artifactId naming conventions: lowercase letters, digits, hyphens, and underscores only, starting with a lowercase letter.

Both values must not contain spaces, newlines, non-printable characters, or brace characters as these would violate the format of the Redis CLIENT LIST reply.

Parameters:

driverName - the name of the upstream driver (e.g., "spring-data-redis"), must not be null

driverVersion - the version of the upstream driver (e.g., "3.2.0"), must not be null

Returns:

this builder

Throws:

IllegalArgumentException - if the driver name or version is null or has invalid format

See Also:

Maven Naming Conventions, CLIENT SETINFO

build

public DriverInfo build()

Builds and returns a new immutable DriverInfo instance.

Returns:

a new DriverInfo instance