Class BooleanJavaType

java.lang.Object

org.hibernate.type.descriptor.java.AbstractClassJavaType<Boolean>

org.hibernate.type.descriptor.java.BooleanJavaType

All Implemented Interfaces:

Serializable, BasicJavaType<Boolean>, JavaType<Boolean>, PrimitiveJavaType<Boolean>

public class BooleanJavaType
extends AbstractClassJavaType<Boolean>
implements PrimitiveJavaType<Boolean>

Descriptor for Boolean handling.

See Also:

• MappingSettings.PREFERRED_BOOLEAN_JDBC_TYPE
• Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from interface JavaType

JavaType.CoercionContext

Field Summary

Fields

Modifier and Type	Field	Description
static final BooleanJavaType	INSTANCE

Constructor Summary

Constructors

Constructor	Description
BooleanJavaType()
BooleanJavaType(char characterValueTrue, char characterValueFalse)

Method Summary

Modifier and Type	Method	Description
Boolean	cast(Object value)	Apply a simple type cast to the given value, without attempting any sort of coercion or wrapping.
Boolean	fromEncodedString(CharSequence charSequence, int start, int end)	Reads the encoded value from the char sequence start index until the end index and returns the decoded value.
Boolean	fromString(CharSequence string)
Class<Boolean[]>	getArrayClass()	Get the Java type that describes an array of this type.
String	getCheckCondition(String columnName, JdbcType jdbcType, BasicValueConverter<Boolean,?> converter, Dialect dialect)	The check constraint that should be added to the column definition in generated DDL.
long	getDefaultSqlLength(Dialect dialect, JdbcType jdbcType)	The default column length when this Java type is mapped to a SQL data type which is parametrized by length, for example Types.VARCHAR.
int	getDefaultSqlPrecision(Dialect dialect, JdbcType jdbcType)	The default column precision when this Java type is mapped to a SQL data type which is parametrized by precision, for example Types.DECIMAL.
int	getDefaultSqlScale(Dialect dialect, JdbcType jdbcType)	The default column scale when this Java type is mapped to a SQL data type which is parametrized by scale, for example Types.DECIMAL.
Boolean	getDefaultValue()	Get this Java type's default value.
Class<?>	getPrimitiveArrayClass()	Get the Java type that describes an array of this type's primitive variant.
Class<?>	getPrimitiveClass()	Retrieve the primitive counterpart to the wrapper type identified by this descriptor
boolean	isInstance(Object value)	Is the given value an instance of the described type?
Byte	toByte(Boolean value)
int	toInt(Boolean value)
Integer	toInteger(Boolean value)
Long	toLong(Boolean value)
Short	toShort(Boolean value)
String	toString(Boolean value)
<X> X	unwrap(Boolean value, Class<X> type, WrapperOptions options)	Unwrap an instance of our handled Java type into the requested type.
boolean	useObjectEqualsHashCode()	Whether to use Object.equals(Object) and Object.hashCode() or JavaType.areEqual(Object, Object) and JavaType.extractHashCode(Object) for objects of this java type.
<X> Boolean	wrap(X value, WrapperOptions options)	Wrap a value as our handled Java type.

Methods inherited from class AbstractClassJavaType

areEqual, extractHashCode, extractLoggableRepresentation, getComparator, getJavaType, getJavaTypeClass, getMutabilityPlan, unknownUnwrap, unknownWrap

Methods inherited from class Object

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

Methods inherited from interface BasicJavaType

getRecommendedJdbcType

Methods inherited from interface JavaType

appendEncodedString, areEqual, coerce, createJavaType, extractHashCode, extractLoggableRepresentation, fromEncodedString, getComparator, getJavaType, getJavaTypeClass, getLongSqlLength, getMutabilityPlan, getReplacement, getTypeName, isTemporalType, isWider

Field Details

INSTANCE

public static final BooleanJavaType INSTANCE

Constructor Details

BooleanJavaType

public BooleanJavaType()

BooleanJavaType

public BooleanJavaType(char characterValueTrue,
 char characterValueFalse)

Method Details

useObjectEqualsHashCode

public boolean useObjectEqualsHashCode()

Description copied from interface: JavaType

Whether to use Object.equals(Object) and Object.hashCode() or JavaType.areEqual(Object, Object) and JavaType.extractHashCode(Object) for objects of this java type. This is useful to avoid mega-morphic callsites.

Specified by:

useObjectEqualsHashCode in interface JavaType<Boolean>

toString

public String toString(Boolean value)

Specified by:

toString in interface JavaType<Boolean>

fromString

public Boolean fromString(CharSequence string)

Specified by:

fromString in interface BasicJavaType<Boolean>

Specified by:

fromString in interface JavaType<Boolean>

isInstance

public boolean isInstance(Object value)

Description copied from interface: JavaType

Is the given value an instance of the described type?

Usually just getJavaTypeClass().isInstance(value), but some descriptors need specialized semantics, for example, the descriptors for java.sql.Date, java.sql.Time, and java.sql.Timestamp.

For EntityJavaType, this method handles proxies in a semantically correct way, by checking the entity instance underlying the proxy object.

Specified by:

isInstance in interface JavaType<Boolean>

cast

public Boolean cast(Object value)

Description copied from interface: JavaType

Apply a simple type cast to the given value, without attempting any sort of coercion or wrapping. This method is provided as a convenient way to avoid an unchecked cast to a type variable. Use javaType.cast(value) instead of (T) value wherever possible.

Usually just getJavaTypeClass().cast(value), but overridden in some cases as an "optimization". This optimization is almost certainly unnecessary, and might even indeed be harmful, since Class.cast() is an intrinsic.

Specified by:

cast in interface JavaType<Boolean>

fromEncodedString

public Boolean fromEncodedString(CharSequence charSequence,
 int start,
 int end)

Description copied from interface: JavaType

Reads the encoded value from the char sequence start index until the end index and returns the decoded value. Implementers do not need to care about escaping. This is similar to JavaType.fromString(CharSequence), with the difference that the aim of this method is decoding from a range within an existing char sequence.

Specified by:

fromEncodedString in interface JavaType<Boolean>

unwrap

public <X> X unwrap(Boolean value,
 Class<X> type,
 WrapperOptions options)

Description copied from interface: JavaType

Unwrap an instance of our handled Java type into the requested type.

As an example, if this is a JavaType<Integer> and we are asked to unwrap the Integer value as a Long, we would return something like Long.valueOf( value.longValue() ).

Intended use is during PreparedStatement binding.

Specified by:

unwrap in interface JavaType<Boolean>

Type Parameters:

X - The conversion type.

Parameters:

value - The value to unwrap

type - The type as which to unwrap

options - The options

Returns:

The unwrapped value.

wrap

public <X> Boolean wrap(X value,
 WrapperOptions options)

Description copied from interface: JavaType

Wrap a value as our handled Java type.

Intended use is during ResultSet extraction.

Specified by:

wrap in interface JavaType<Boolean>

Type Parameters:

X - The conversion type.

Parameters:

value - The value to wrap.

options - The options

Returns:

The wrapped value.

toInt

public int toInt(Boolean value)

toByte

public Byte toByte(Boolean value)

toShort

public Short toShort(Boolean value)

toInteger

public Integer toInteger(Boolean value)

toLong

public Long toLong(Boolean value)

getPrimitiveClass

public Class<?> getPrimitiveClass()

Description copied from interface: PrimitiveJavaType

Retrieve the primitive counterpart to the wrapper type identified by this descriptor

Specified by:

getPrimitiveClass in interface PrimitiveJavaType<Boolean>

Returns:

The primitive Java type.

getArrayClass

public Class<Boolean[]> getArrayClass()

Description copied from interface: PrimitiveJavaType

Get the Java type that describes an array of this type.

Specified by:

getArrayClass in interface PrimitiveJavaType<Boolean>

getPrimitiveArrayClass

public Class<?> getPrimitiveArrayClass()

Description copied from interface: PrimitiveJavaType

Get the Java type that describes an array of this type's primitive variant.

Specified by:

getPrimitiveArrayClass in interface PrimitiveJavaType<Boolean>

getDefaultValue

public Boolean getDefaultValue()

Description copied from interface: JavaType

Get this Java type's default value.

Specified by:

getDefaultValue in interface JavaType<Boolean>

Returns:

The default value.

getDefaultSqlLength

public long getDefaultSqlLength(Dialect dialect,
 JdbcType jdbcType)

Description copied from interface: JavaType

The default column length when this Java type is mapped to a SQL data type which is parametrized by length, for example Types.VARCHAR.

Specified by:

getDefaultSqlLength in interface JavaType<Boolean>

Returns:

Size.DEFAULT_LENGTH unless overridden

getDefaultSqlPrecision

public int getDefaultSqlPrecision(Dialect dialect,
 JdbcType jdbcType)

Description copied from interface: JavaType

The default column precision when this Java type is mapped to a SQL data type which is parametrized by precision, for example Types.DECIMAL.

Specified by:

getDefaultSqlPrecision in interface JavaType<Boolean>

Returns:

Size.DEFAULT_PRECISION unless overridden

getDefaultSqlScale

public int getDefaultSqlScale(Dialect dialect,
 JdbcType jdbcType)

Description copied from interface: JavaType

The default column scale when this Java type is mapped to a SQL data type which is parametrized by scale, for example Types.DECIMAL.

Specified by:

getDefaultSqlScale in interface JavaType<Boolean>

Returns:

Size.DEFAULT_SCALE unless overridden

getCheckCondition

public String getCheckCondition(String columnName,
 JdbcType jdbcType,
 BasicValueConverter<Boolean,?> converter,
 Dialect dialect)

Description copied from interface: JavaType

The check constraint that should be added to the column definition in generated DDL.

Specified by:

getCheckCondition in interface JavaType<Boolean>

Parameters:

columnName - the name of the column

jdbcType - the JdbcType of the mapped column

converter - the converter, if any, or null

dialect - the SQL Dialect

Returns:

a check constraint condition or null