Class ArraySupport

java.lang.Object

org.hibernate.dialect.array.spi.ArraySupport

@SPI({USE,SUPPLY})
public final class ArraySupport
extends Object

Immutable description of a Dialect's array syntax and multi-valued parameter-binding behavior.

Providers supply a stable profile through Dialect#getArraySupport(). Standard element-type array syntax, SQL array-constructor syntax, and the multi-valued parameter-binding strategy are independent dimensions. Do not infer support for one dimension from another: a database might bind a named or nonstandard array type without either standard syntax capability, or it might deliberately expand parameters despite supporting both capabilities.

Since:

8.0

See Also:

• Dialect.getArraySupport()

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	ArraySupport.Builder	Build an immutable array-support profile.
static enum	ArraySupport.Capability	An independently configurable array-syntax capability.
static enum	ArraySupport.MultiValuedParameterStrategy	How multi-valued parameters are passed to the database.

Field Summary

Fields

Modifier and Type	Field	Description
static final ArraySupport	NONE	No standard array syntax, no array-constructor syntax, and expanded multi-valued parameters.
static final ArraySupport	STANDARD	Both standard array syntax capabilities and array-bound multi-valued parameters.

Method Summary

Modifier and Type	Method	Description
static ArraySupport.Builder	builder()	Create a builder initialized from NONE.
static ArraySupport.Builder	builder(ArraySupport base)	Create a builder initialized with every value from the given profile.
Set<ArraySupport.Capability>	getCapabilities()	The immutable set of supported array-syntax capabilities.
ArraySupport.MultiValuedParameterStrategy	getMultiValuedParameterStrategy()	The strategy for passing a multi-valued parameter to the database.
boolean	supports(ArraySupport.Capability capability)	Whether the given array-syntax capability is supported.

Methods inherited from class Object

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

Field Details

NONE

public static final ArraySupport NONE

No standard array syntax, no array-constructor syntax, and expanded multi-valued parameters.

STANDARD

public static final ArraySupport STANDARD

Both standard array syntax capabilities and array-bound multi-valued parameters.

Method Details

builder

public static ArraySupport.Builder builder()

Create a builder initialized from NONE.

builder

public static ArraySupport.Builder builder(ArraySupport base)

Create a builder initialized with every value from the given profile.

Parameters:

base - the non-null profile to copy

getCapabilities

public Set<ArraySupport.Capability> getCapabilities()

The immutable set of supported array-syntax capabilities.

supports

public boolean supports(ArraySupport.Capability capability)

Whether the given array-syntax capability is supported.

getMultiValuedParameterStrategy

public ArraySupport.MultiValuedParameterStrategy getMultiValuedParameterStrategy()

The strategy for passing a multi-valued parameter to the database.