com.scalar.db.io

Class BooleanColumn

java.lang.Object

com.scalar.db.io.BooleanColumn

All Implemented Interfaces:

Column<java.lang.Boolean>, java.lang.Comparable<Column<java.lang.Boolean>>

@Immutable
public class BooleanColumn
extends java.lang.Object
implements Column<java.lang.Boolean>

A Column for a BOOLEAN type.

Method Summary

Modifier and Type	Method and Description
void	accept(ColumnVisitor visitor) Accepts a ColumnVisitor to be able to be traversed.
int	compareTo(Column<java.lang.Boolean> o)
BooleanColumn	copyWith(java.lang.String name) Creates a copy of this Column with the specified name.
boolean	equals(java.lang.Object o)
boolean	getBooleanValue() Returns the BOOLEAN value of this Column as a Java boolean type.
DataType	getDataType() Returns the data type of this Column.
java.lang.String	getName() Returns the name of this Column.
java.util.Optional<java.lang.Boolean>	getValue() Returns the value of this Column.
java.lang.Object	getValueAsObject() Returns the value of this Column as a Java object type.
int	hashCode()
boolean	hasNullValue() Indicates whether the value of this Column is NULL.
static BooleanColumn	of(java.lang.String columnName, boolean value) Returns a Boolean column instance with the specified column name and value.
static BooleanColumn	ofNull(java.lang.String columnName) Returns a Boolean column instance with the specified column name and a null value.
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.scalar.db.io.Column

getBigIntValue, getBlobValue, getBlobValueAsByteBuffer, getBlobValueAsBytes, getDateValue, getDoubleValue, getFloatValue, getIntValue, getTextValue, getTimestampTZValue, getTimestampValue, getTimeValue

Method Detail

getName

public java.lang.String getName()

Description copied from interface: Column

Returns the name of this Column.

Specified by:

getName in interface Column<java.lang.Boolean>

Returns:

the name of this Column

getValue

public java.util.Optional<java.lang.Boolean> getValue()

Description copied from interface: Column

Returns the value of this Column.

Specified by:

getValue in interface Column<java.lang.Boolean>

Returns:

the value of this Column

getBooleanValue

public boolean getBooleanValue()

Description copied from interface: Column

Returns the BOOLEAN value of this Column as a Java boolean type.

Note that, due to its signature, this method cannot return null. If the value is NULL, it will return false. If this doesn't work for you, either call Column.hasNullValue() before calling this method, or use Column.getValueAsObject() instead.

Specified by:

getBooleanValue in interface Column<java.lang.Boolean>

Returns:

the value of this Column

copyWith

public BooleanColumn copyWith(java.lang.String name)

Description copied from interface: Column

Creates a copy of this Column with the specified name.

Specified by:

copyWith in interface Column<java.lang.Boolean>

Parameters:

name - name of a Column

Returns:

a Column which has the same value

getDataType

public DataType getDataType()

Description copied from interface: Column

Returns the data type of this Column.

Specified by:

getDataType in interface Column<java.lang.Boolean>

Returns:

the data type of this Column

hasNullValue

public boolean hasNullValue()

Description copied from interface: Column

Indicates whether the value of this Column is NULL.

Specified by:

hasNullValue in interface Column<java.lang.Boolean>

Returns:

whether the value of this Column is NULL

getValueAsObject

@Nullable
public java.lang.Object getValueAsObject()

Description copied from interface: Column

Returns the value of this Column as a Java object type.

If the columns is a BOOLEAN type, it returns a Boolean object. If the columns is an INT type, it returns an Integer object. If the columns is a BIGINT type, it returns a LONG object. If the columns is a FLOAT type, it returns a FLOAT object. If the columns is a DOUBLE type, it returns a DOUBLE object. If the columns is a TEXT type, it returns a String object. If the columns is a BLOB type, it returns a ByteBuffer object. If the columns is a DATE type, it returns a LocalDate object. If the columns is a TIME type, it returns a LocalTime object. If the columns is a TIMESTAMP type, it returns a LocalDateTime object. If the columns is a TIMESTAMPTZ type, it returns a Instant object.

Specified by:

getValueAsObject in interface Column<java.lang.Boolean>

Returns:

the value of this Column. if the value is NULL, null

compareTo

public int compareTo(Column<java.lang.Boolean> o)

Specified by:

compareTo in interface java.lang.Comparable<Column<java.lang.Boolean>>

equals

public boolean equals(java.lang.Object o)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

accept

public void accept(ColumnVisitor visitor)

Description copied from interface: Column

Accepts a ColumnVisitor to be able to be traversed.

Specified by:

accept in interface Column<java.lang.Boolean>

Parameters:

visitor - a visitor class used for traversing Columns

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

of

public static BooleanColumn of(java.lang.String columnName,
                               boolean value)

Returns a Boolean column instance with the specified column name and value.

Parameters:

columnName - a column name

value - a column value

Returns:

a Boolean column instance with the specified column name and value

ofNull

public static BooleanColumn ofNull(java.lang.String columnName)

Returns a Boolean column instance with the specified column name and a null value.

Parameters:

columnName - a column name

Returns:

a Boolean column instance with the specified column name and a null value