Package org.hibernate.search.mapper.pojo.route

Class DocumentRoutesDescriptor

java.lang.Object

org.hibernate.search.mapper.pojo.route.DocumentRoutesDescriptor

All Implemented Interfaces:

Serializable

public final class DocumentRoutesDescriptor
extends Object
implements Serializable

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor	Description
DocumentRoutesDescriptor(DocumentRouteDescriptor currentRoute, Collection<DocumentRouteDescriptor> previousRoutes)

Method Summary

Modifier and Type	Method	Description
DocumentRouteDescriptor	currentRoute()
static DocumentRoutesDescriptor	fromLegacyRoutingKey(String providedRoutingKey)	A util to convert the legacy representation of a route (a single string) to a DocumentRoutesDescriptor.
static DocumentRoutesDescriptor	of(DocumentRouteDescriptor currentRoute)
static DocumentRoutesDescriptor	of(DocumentRouteDescriptor currentRoute, Collection<DocumentRouteDescriptor> previousRoutes)
Collection<DocumentRouteDescriptor>	previousRoutes()
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

DocumentRoutesDescriptor

public DocumentRoutesDescriptor(DocumentRouteDescriptor currentRoute,
                                Collection<DocumentRouteDescriptor> previousRoutes)

Method Detail

of

public static DocumentRoutesDescriptor of(DocumentRouteDescriptor currentRoute)

of

public static DocumentRoutesDescriptor of(DocumentRouteDescriptor currentRoute,
                                          Collection<DocumentRouteDescriptor> previousRoutes)

fromLegacyRoutingKey

public static DocumentRoutesDescriptor fromLegacyRoutingKey(String providedRoutingKey)

A util to convert the legacy representation of a route (a single string) to a DocumentRoutesDescriptor.

It will assume no routes are given if providedRoutingKey is null, so it's not possible to represent the default route using this util.

Parameters:

providedRoutingKey - The provided routing key, or null.

Returns:

The corresponding routes, or null.

toString

public String toString()

Overrides:

toString in class Object

currentRoute

public DocumentRouteDescriptor currentRoute()

previousRoutes

public Collection<DocumentRouteDescriptor> previousRoutes()