Module org.tentackle.sql

Package org.tentackle.sql.datatypes

Class LocalTimeType

java.lang.Object

org.tentackle.sql.datatypes.AbstractDataType<T>

org.tentackle.sql.datatypes.AbstractDateTimeType<LocalTime>

org.tentackle.sql.datatypes.LocalTimeType

All Implemented Interfaces:

DataType<LocalTime>

@Service(DataType.class)
public final class LocalTimeType
extends AbstractDateTimeType<LocalTime>

Datatype for LocalTime.

Mapped to Time-related JDBC methods.

Field Summary

Fields inherited from class org.tentackle.sql.datatypes.AbstractDataType

maxLinesInLiteral

Constructor Summary

Constructors

Constructor	Description
LocalTimeType()	Creates the datatype for LocalTime.

Method Summary

Modifier and Type	Method	Description
String	format(LocalTime time)	Converts a time object to a string.
LocalTime	get(Backend backend, ResultSet resultSet, int[] pos, boolean mapNull, Integer size)	Gets the object from a result set. Must be implemented if DataType.isPredefined() returns false.
String	getJavaType()	Gets the name of the Java type.
SqlType	getSqlType(Backend backend, int index)	Gets the SQL type. For predefined types, the type must be the same for all backends and the backend argument may be null. Application specific types, however, can use different sql types for different backends and for those types the backend argument is always valid.
LocalTime	parse(String str)	Converts a string to a local time.
Object[]	set(Backend backend, PreparedStatement statement, int pos, LocalTime object, boolean mapNull, Integer size)	Sets the object into a prepared statement. Must be implemented if DataType.isPredefined() returns false.
String	toString(LocalTime object)	Takes an object and converts it to a string that can in turn be parsed with DataType.valueOf(String). The method is used to print a literal (for example the default value of a dumped attribute).
LocalTime	valueOf(String str)	Parses a string and converts to the value of this type. The method is used to parse a literal (for example the default value defined in the model).

Methods inherited from class org.tentackle.sql.datatypes.AbstractDateTimeType

isDateOrTime, valueOfLiteralToCode

Methods inherited from class org.tentackle.sql.datatypes.AbstractDataType

assertColumnCountNotBackendSpecific, createColumnNames, createColumnNamesAsString, equals, getColumnAlias, getColumnCount, getColumnGetter, getColumnSuffix, getColumnValue, getCommentSuffix, getDataTypeConstant, getMappedNullValue, getScale, getSize, getSortableColumns, getVariant, hashCode, isBool, isColumnCountBackendSpecific, isDowncastNecessary, isJavaTypeGenerified, isLiteralSupported, isMapNullSupported, isModelProvidingInnerType, isMutable, isNumeric, isPredefined, isPrimitive, isTimezoneApplicable, isUTCSupported, set, toLiteral, toNonPrimitive, toPrimitive, toString, valueStringToCode

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Details

LocalTimeType

public LocalTimeType()

Creates the datatype for LocalTime.

Method Details

getJavaType

public String getJavaType()

Description copied from interface: DataType

Gets the name of the Java type.

Returns:

the type

getSqlType

public SqlType getSqlType(Backend backend,
 int index)

Description copied from interface: DataType

Gets the SQL type.
For predefined types, the type must be the same for all backends and the backend argument may be null.
Application specific types, however, can use different sql types for different backends and for those types the backend argument is always valid.

Parameters:

backend - the backend, not used by predefined types

index - the column index

Returns:

the SQL type

valueOf

public LocalTime valueOf(String str)

Description copied from interface: DataType

Parses a string and converts to the value of this type.
The method is used to parse a literal (for example the default value defined in the model).

Notice: the method doesn't use any locale, so the results are always the same regardless of the JVM's locale.

Parameters:

str - the source string

Returns:

the value

toString

public String toString(LocalTime object)

Description copied from interface: DataType

Takes an object and converts it to a string that can in turn be parsed with DataType.valueOf(String).
The method is used to print a literal (for example the default value of a dumped attribute).

Notice: the method doesn't use any locale, so the results are always the same regardless of the JVM's locale.

Specified by:

toString in interface DataType<LocalTime>

Overrides:

toString in class AbstractDataType<LocalTime>

Parameters:

object - the object of this DataType

Returns:

the printable string

set

public Object[] set(Backend backend,
 PreparedStatement statement,
 int pos,
 LocalTime object,
 boolean mapNull,
 Integer size)
             throws SQLException

Description copied from interface: DataType

Sets the object into a prepared statement.
Must be implemented if DataType.isPredefined() returns false. Not invoked by framework otherwise.

Parameters:

backend - the database backend

statement - the prepared statement

pos - the position of the first SQL value

object - the object, may be null

mapNull - true if map null-values to non-null values

size - the optional size specified in the model

Returns:

the values stored in the prepared statement

Throws:

SQLException - if failed

get

public LocalTime get(Backend backend,
 ResultSet resultSet,
 int[] pos,
 boolean mapNull,
 Integer size)
              throws SQLException

Description copied from interface: DataType

Gets the object from a result set.
Must be implemented if DataType.isPredefined() returns false. Not invoked by framework otherwise.

Parameters:

backend - the database backend

resultSet - the result set

pos - the column positions in the result set

mapNull - true if unmap null-values from non-null values

size - the optional size specified in the model

Returns:

the object or null if column(s) IS NULL

Throws:

SQLException - if failed

parse

public LocalTime parse(String str)
                throws BackendException

Converts a string to a local time.

Parameters:

str - the string

Returns:

the time

Throws:

BackendException - if parsing failed

format

public String format(LocalTime time)

Converts a time object to a string.

Parameters:

time - the time

Returns:

the formatted string