Class NullOrderingSupport

java.lang.Object

org.hibernate.dialect.sql.ast.spi.NullOrderingSupport

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

Immutable description of a Dialect's default null ordering and native explicit null-precedence syntax.

Providers supply a stable profile through Dialect.getNullOrderingSupport(). The default ordering describes where the database places null values when an order by item does not specify nulls first or nulls last. It is independent of NullOrderingSupport.Capability.NULLS_FIRST_LAST, which reports whether that explicit syntax may be rendered natively.

Consumers should use both parts of this profile when deciding whether an explicit precedence may be elided, rendered natively, or emulated. Providers refining a Dialect family profile should copy the profile returned by the superclass and change only the values which differ.

Since:

8.0

See Also:

• Dialect.getNullOrderingSupport()

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	NullOrderingSupport.Builder	Build an immutable null-ordering-support profile.
static enum	NullOrderingSupport.Capability	An independently configurable null-ordering syntax capability.

Field Summary

Fields

Modifier and Type	Field	Description
static final NullOrderingSupport	STANDARD	The base-Dialect profile: null values sort as the greatest values and explicit nulls first and nulls last syntax is supported.

Method Summary

Modifier and Type	Method	Description
static NullOrderingSupport.Builder	builder()	Create a builder initialized from STANDARD.
static NullOrderingSupport.Builder	builder(NullOrderingSupport base)	Create a builder initialized with the complete state of the given profile.
Set<NullOrderingSupport.Capability>	getCapabilities()	The immutable set of supported null-ordering syntax capabilities.
NullOrdering	getDefaultOrdering()	The database's default ordering of null values.
boolean	supports(NullOrderingSupport.Capability capability)	Whether the given null-ordering syntax capability is supported natively.

Methods inherited from class Object

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

Field Details

STANDARD

public static final NullOrderingSupport STANDARD

The base-Dialect profile: null values sort as the greatest values and explicit nulls first and nulls last syntax is supported.

Method Details

builder

public static NullOrderingSupport.Builder builder()

Create a builder initialized from STANDARD.

builder

public static NullOrderingSupport.Builder builder(NullOrderingSupport base)

Create a builder initialized with the complete state of the given profile.

Parameters:

base - the non-null profile to copy

getDefaultOrdering

public NullOrdering getDefaultOrdering()

The database's default ordering of null values.

getCapabilities

public Set<NullOrderingSupport.Capability> getCapabilities()

The immutable set of supported null-ordering syntax capabilities.

supports

public boolean supports(NullOrderingSupport.Capability capability)

Whether the given null-ordering syntax capability is supported natively.