Package org.hibernate.search.mapper.pojo.bridge.builtin.impl

Class DefaultEnumBridge<T extends Enum<T>>

java.lang.Object

org.hibernate.search.mapper.pojo.bridge.builtin.impl.DefaultEnumBridge<T>

All Implemented Interfaces:

AutoCloseable, IdentifierBridge<T>, ValueBridge<T,String>

public final class DefaultEnumBridge<T extends Enum<T>>
extends Object

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	DefaultEnumBridge.Binder

Constructor Summary

Constructors

Constructor	Description
DefaultEnumBridge(Class<T> enumType)

Method Summary

Modifier and Type	Method	Description
void	close()	Close any resource before the bridge is discarded.
V	fromDocumentIdentifier(String documentIdentifier, IdentifierBridgeFromDocumentIdentifierContext context)	Transform the given document identifier value back to the value of the POJO property.
V	fromIndexedValue(String value, ValueBridgeFromIndexedValueContext context)	Transform the given indexed field value to the corresponding POJO-extracted value.
protected T	fromString(String value)
boolean	isCompatibleWith(IdentifierBridge<?> other)
boolean	isCompatibleWith(ValueBridge<?,?> other)
String	parse(String value)	Parse an input String to the raw index field value.
String	toDocumentIdentifier(V propertyValue, IdentifierBridgeToDocumentIdentifierContext context)	Transform the given POJO property value to the value of the document identifier.
String	toIndexedValue(V value, ValueBridgeToIndexedValueContext context)	Transform the given POJO-extracted value into the value of the indexed field.
String	toString()
protected String	toString(T value)

Methods inherited from class java.lang.Object

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

Constructor Detail

DefaultEnumBridge

public DefaultEnumBridge(Class<T> enumType)

Method Detail

toString

public String toString()

isCompatibleWith

public boolean isCompatibleWith(IdentifierBridge<?> other)

Specified by:

isCompatibleWith in interface IdentifierBridge<T extends Enum<T>>

isCompatibleWith

public boolean isCompatibleWith(ValueBridge<?,?> other)

Specified by:

isCompatibleWith in interface ValueBridge<T extends Enum<T>,String>

Parameters:

other - Another ValueBridge, never null.

Returns:

true if the given object is also a ValueBridge that behaves exactly the same as this object, i.e. its ValueBridge.toIndexedValue(Object, ValueBridgeToIndexedValueContext) method is guaranteed to accept the same values as this object's and to always return the same value as this object's when given the same input. false otherwise, or when in doubt.

toString

protected String toString(T value)

fromString

protected T fromString(String value)

toIndexedValue

public final String toIndexedValue(V value,
                                   ValueBridgeToIndexedValueContext context)

Description copied from interface: ValueBridge

Transform the given POJO-extracted value into the value of the indexed field.

Parameters:

value - The POJO-extracted value to be transformed.

context - A context that can be extended to a more useful type, giving access to such things as a Hibernate ORM SessionFactory (if using the Hibernate ORM mapper).

Returns:

The value of the indexed field.

fromIndexedValue

public final V fromIndexedValue(String value,
                                ValueBridgeFromIndexedValueContext context)

Description copied from interface: ValueBridge

Transform the given indexed field value to the corresponding POJO-extracted value.

Parameters:

value - The value of the indexed field to be transformed.

context - A context that can be extended to a more useful type, giving access to such things as a Hibernate ORM SessionFactory (if using the Hibernate ORM mapper).

Returns:

The POJO-extracted value.

parse

public final String parse(String value)

Description copied from interface: ValueBridge

Parse an input String to the raw index field value.

Parameters:

value - The value to parse.

Returns:

The raw index field value.

close

public final void close()

Description copied from interface: ValueBridge

Close any resource before the bridge is discarded.

Specified by:

close in interface AutoCloseable

Specified by:

close in interface IdentifierBridge<V>

Specified by:

close in interface ValueBridge<V,F>

toDocumentIdentifier

public final String toDocumentIdentifier(V propertyValue,
                                         IdentifierBridgeToDocumentIdentifierContext context)

Description copied from interface: IdentifierBridge

Transform the given POJO property value to the value of the document identifier.

Must return a unique value for each value of propertyValue

Specified by:

toDocumentIdentifier in interface IdentifierBridge<V>

Parameters:

propertyValue - The POJO property value to be transformed.

context - A context that can be extended to a more useful type, giving access to such things as a Hibernate ORM SessionFactory (if using the Hibernate ORM mapper).

Returns:

The value of the document identifier.

fromDocumentIdentifier

public final V fromDocumentIdentifier(String documentIdentifier,
                                      IdentifierBridgeFromDocumentIdentifierContext context)

Description copied from interface: IdentifierBridge

Transform the given document identifier value back to the value of the POJO property.

Must be the exact inverse function of IdentifierBridge.toDocumentIdentifier(Object, IdentifierBridgeToDocumentIdentifierContext), i.e. object.equals(fromDocumentIdentifier(toDocumentIdentifier(object, sessionContext))) must always be true.

Specified by:

fromDocumentIdentifier in interface IdentifierBridge<V>

Parameters:

documentIdentifier - The document identifier value to be transformed.

context - A sessionContext that can be extended to a more useful type, giving access to such things as a Hibernate ORM Session (if using the Hibernate ORM mapper).

Returns:

The value of the document identifier.