ConditionalExpression (ScalarDB)

java.lang.Object
- com.scalar.db.api.ConditionalExpression

Direct Known Subclasses:

LikeExpression
```
@Immutable
public class ConditionalExpression
extends java.lang.Object
```
A conditional expression used in MutationCondition.

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class ConditionalExpression.Operator

Nested Classes
Modifier and Type	Class and Description
`static class`	`ConditionalExpression.Operator`

Constructor Summary

Constructors
Constructor and Description
`ConditionalExpression(java.lang.String columnName, boolean booleanValue, ConditionalExpression.Operator operator)` Deprecated. As of release 3.6.0. Will be removed in release 5.0.0. Use `ConditionBuilder` to build a condition instead
`ConditionalExpression(java.lang.String columnName, byte[] blobValue, ConditionalExpression.Operator operator)` Deprecated. As of release 3.6.0. Will be removed in release 5.0.0. Use `ConditionBuilder` to build a condition instead
`ConditionalExpression(java.lang.String columnName, java.nio.ByteBuffer blobValue, ConditionalExpression.Operator operator)` Deprecated. As of release 3.6.0. Will be removed in release 5.0.0. Use `ConditionBuilder` to build a condition instead
`ConditionalExpression(java.lang.String columnName, double doubleValue, ConditionalExpression.Operator operator)` Deprecated. As of release 3.6.0. Will be removed in release 5.0.0. Use `ConditionBuilder` to build a condition instead
`ConditionalExpression(java.lang.String columnName, float floatValue, ConditionalExpression.Operator operator)` Deprecated. As of release 3.6.0. Will be removed in release 5.0.0. Use `ConditionBuilder` to build a condition instead
`ConditionalExpression(java.lang.String columnName, int intValue, ConditionalExpression.Operator operator)` Deprecated. As of release 3.6.0. Will be removed in release 5.0.0. Use `ConditionBuilder` to build a condition instead
`ConditionalExpression(java.lang.String columnName, long bigIntValue, ConditionalExpression.Operator operator)` Deprecated. As of release 3.6.0. Will be removed in release 5.0.0. Use `ConditionBuilder` to build a condition instead
`ConditionalExpression(java.lang.String columnName, java.lang.String textValue, ConditionalExpression.Operator operator)` Deprecated. As of release 3.6.0. Will be removed in release 5.0.0. Use `ConditionBuilder` to build a condition instead
`ConditionalExpression(java.lang.String columnName, Value<?> value, ConditionalExpression.Operator operator)` Deprecated. As of release 3.6.0. Will be removed in release 5.0.0

Method Summary

All Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`boolean`	`equals(java.lang.Object o)` Indicates whether some other object is "equal to" this object.
`long`	`getBigIntValue()` Returns the BIGINT value to compare with the target column.
`java.nio.ByteBuffer`	`getBlobValue()` Returns the BLOB value to compare with the target column as a ByteBuffer type.
`java.nio.ByteBuffer`	`getBlobValueAsByteBuffer()` Returns the BLOB value to compare with the target column as a ByteBuffer type.
`byte[]`	`getBlobValueAsBytes()` Returns the BLOB value to compare with the target column as a byte array type.
`boolean`	`getBooleanValue()` Returns the BOOLEAN value to compare with the target column.
`Column<?>`	`getColumn()` Returns the target column used to compare.
`java.time.LocalDate`	`getDateValue()` Returns the DATE value to compare with the target column.
`double`	`getDoubleValue()` Returns the DOUBLE value to compare with the target column.
`float`	`getFloatValue()` Returns the FLOAT value to compare with the target column.
`int`	`getIntValue()` Returns the INT value to compare with the target column.
`java.lang.String`	`getName()` Deprecated. As of release 3.6.0. Will be removed in release 5.0.0
`ConditionalExpression.Operator`	`getOperator()` Returns the operator used to compare the target column.
`java.lang.String`	`getTextValue()` Returns the TEXT value to compare with the target column.
`java.time.Instant`	`getTimestampTZValue()` Returns the TIMESTAMPTZ value to compare with the target column.
`java.time.LocalDateTime`	`getTimestampValue()` Returns the TIMESTAMP value to compare with the target column.
`java.time.LocalTime`	`getTimeValue()` Returns the TIME value to compare with the target column.
`Value<?>`	`getValue()` Deprecated. As of release 3.6.0. Will be removed in release 5.0.0
`java.lang.Object`	`getValueAsObject()` Returns the value to compare with the target column as an Object type.
`int`	`hashCode()`
`java.lang.String`	`toString()`

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - ConditionalExpression
```
@Deprecated
public ConditionalExpression(java.lang.String columnName,
                                         Value<?> value,
                                         ConditionalExpression.Operator operator)
```
    Deprecated. As of release 3.6.0. Will be removed in release 5.0.0
    
    Constructs a ConditionalExpression with the specified column name, value and operator. A conditional expression will be "<columnName> <operator> <value>".
    Value's name won't be used to create an expression, so giving anonymous Value makes more sense and is more readable.
    
    Parameters:
    
    columnName - a name of target column
    
    value - a value used to compare with the target column
    
    operator - an operator used to compare the target column
  - ConditionalExpression
```
@Deprecated
public ConditionalExpression(java.lang.String columnName,
                                         boolean booleanValue,
                                         ConditionalExpression.Operator operator)
```
    Deprecated. As of release 3.6.0. Will be removed in release 5.0.0. Use ConditionBuilder to build a condition instead
    
    Constructs a ConditionalExpression with the specified column name, value and operator.
    
    Parameters:
    
    columnName - a name of target column
    
    booleanValue - a BOOLEAN value used to compare with the target column
    
    operator - an operator used to compare the target column
  - ConditionalExpression
```
@Deprecated
public ConditionalExpression(java.lang.String columnName,
                                         int intValue,
                                         ConditionalExpression.Operator operator)
```
    Deprecated. As of release 3.6.0. Will be removed in release 5.0.0. Use ConditionBuilder to build a condition instead
    
    Constructs a ConditionalExpression with the specified column name, value and operator.
    
    Parameters:
    
    columnName - a name of target column
    
    intValue - an INT value used to compare with the target column
    
    operator - an operator used to compare the target column
  - ConditionalExpression
```
@Deprecated
public ConditionalExpression(java.lang.String columnName,
                                         long bigIntValue,
                                         ConditionalExpression.Operator operator)
```
    Deprecated. As of release 3.6.0. Will be removed in release 5.0.0. Use ConditionBuilder to build a condition instead
    
    Constructs a ConditionalExpression with the specified column name, value and operator.
    
    Parameters:
    
    columnName - a name of target column
    
    bigIntValue - a BIGINT value used to compare with the target column
    
    operator - an operator used to compare the target column
  - ConditionalExpression
```
@Deprecated
public ConditionalExpression(java.lang.String columnName,
                                         float floatValue,
                                         ConditionalExpression.Operator operator)
```
    Deprecated. As of release 3.6.0. Will be removed in release 5.0.0. Use ConditionBuilder to build a condition instead
    
    Constructs a ConditionalExpression with the specified column name, value and operator.
    
    Parameters:
    
    columnName - a name of target column
    
    floatValue - a FLOAT value used to compare with the target column
    
    operator - an operator used to compare the target column
  - ConditionalExpression
```
@Deprecated
public ConditionalExpression(java.lang.String columnName,
                                         double doubleValue,
                                         ConditionalExpression.Operator operator)
```
    Deprecated. As of release 3.6.0. Will be removed in release 5.0.0. Use ConditionBuilder to build a condition instead
    
    Constructs a ConditionalExpression with the specified column name, value and operator.
    
    Parameters:
    
    columnName - a name of target column
    
    doubleValue - a DOUBLE value used to compare with the target column
    
    operator - an operator used to compare the target column
  - ConditionalExpression
```
@Deprecated
public ConditionalExpression(java.lang.String columnName,
                                         java.lang.String textValue,
                                         ConditionalExpression.Operator operator)
```
    Deprecated. As of release 3.6.0. Will be removed in release 5.0.0. Use ConditionBuilder to build a condition instead
    
    Constructs a ConditionalExpression with the specified column name, value and operator.
    
    Parameters:
    
    columnName - a name of target column
    
    textValue - a TEXT value used to compare with the target column
    
    operator - an operator used to compare the target column
  - ConditionalExpression
```
@Deprecated
public ConditionalExpression(java.lang.String columnName,
                                         byte[] blobValue,
                                         ConditionalExpression.Operator operator)
```
    Deprecated. As of release 3.6.0. Will be removed in release 5.0.0. Use ConditionBuilder to build a condition instead
    
    Constructs a ConditionalExpression with the specified column name, value and operator.
    
    Parameters:
    
    columnName - a name of target column
    
    blobValue - a BLOB value used to compare with the target column
    
    operator - an operator used to compare the target column
  - ConditionalExpression
```
@Deprecated
public ConditionalExpression(java.lang.String columnName,
                                         java.nio.ByteBuffer blobValue,
                                         ConditionalExpression.Operator operator)
```
    Deprecated. As of release 3.6.0. Will be removed in release 5.0.0. Use ConditionBuilder to build a condition instead
    
    Constructs a ConditionalExpression with the specified column name, value and operator.
    
    Parameters:
    
    columnName - a name of target column
    
    blobValue - a BLOB value used to compare with the target column
    
    operator - an operator used to compare the target column
- Method Detail
  - getName
```
@Deprecated
public java.lang.String getName()
```
    Deprecated. As of release 3.6.0. Will be removed in release 5.0.0
    
    Returns the column name of target column.
    
    Returns:
    
    the column name of target column
  - getValue
```
@Deprecated
public Value<?> getValue()
```
    Deprecated. As of release 3.6.0. Will be removed in release 5.0.0
    
    Returns the value used to compare with the target column.
    
    Returns:
    
    the value used to compare with the target column
  - getColumn
```
public Column<?> getColumn()
```
    Returns the target column used to compare.
    This method is primarily for internal use. Breaking changes can and will be introduced to this method. Users should not depend on it.
    
    Returns:
    
    the target column
  - getBooleanValue
```
public boolean getBooleanValue()
```
    Returns the BOOLEAN value to compare with the target column.
    
    Returns:
    
    the BOOLEAN value to compare with the target column
  - getIntValue
```
public int getIntValue()
```
    Returns the INT value to compare with the target column.
    
    Returns:
    
    the INT value to compare with the target column
  - getBigIntValue
```
public long getBigIntValue()
```
    Returns the BIGINT value to compare with the target column.
    
    Returns:
    
    the BIGINT value to compare with the target column
  - getFloatValue
```
public float getFloatValue()
```
    Returns the FLOAT value to compare with the target column.
    
    Returns:
    
    the FLOAT value to compare with the target column
  - getDoubleValue
```
public double getDoubleValue()
```
    Returns the DOUBLE value to compare with the target column.
    
    Returns:
    
    the DOUBLE value to compare with the target column
  - getTextValue
```
public java.lang.String getTextValue()
```
    Returns the TEXT value to compare with the target column.
    
    Returns:
    
    the TEXT value to compare with the target column
  - getBlobValue
```
public java.nio.ByteBuffer getBlobValue()
```
    Returns the BLOB value to compare with the target column as a ByteBuffer type.
    
    Returns:
    
    the BLOB value to compare with the target column as a ByteBuffer type
  - getBlobValueAsByteBuffer
```
public java.nio.ByteBuffer getBlobValueAsByteBuffer()
```
    Returns the BLOB value to compare with the target column as a ByteBuffer type.
    
    Returns:
    
    the BLOB value to compare with the target column as a ByteBuffer type
  - getBlobValueAsBytes
```
public byte[] getBlobValueAsBytes()
```
    Returns the BLOB value to compare with the target column as a byte array type.
    
    Returns:
    
    the BLOB value to compare with the target column as a byte array type
  - getDateValue
```
public java.time.LocalDate getDateValue()
```
    Returns the DATE value to compare with the target column.
    
    Returns:
    
    the DATE value to compare with the target column
  - getTimeValue
```
public java.time.LocalTime getTimeValue()
```
    Returns the TIME value to compare with the target column.
    
    Returns:
    
    the TIME value to compare with the target column
  - getTimestampValue
```
public java.time.LocalDateTime getTimestampValue()
```
    Returns the TIMESTAMP value to compare with the target column.
    
    Returns:
    
    the TIMESTAMP value to compare with the target column
  - getTimestampTZValue
```
public java.time.Instant getTimestampTZValue()
```
    Returns the TIMESTAMPTZ value to compare with the target column.
    
    Returns:
    
    the TIMESTAMPTZ value to compare with the target column
  - getValueAsObject
```
public java.lang.Object getValueAsObject()
```
    Returns the value to compare with the target column as an 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.
    
    Returns:
    
    the value to compare with the target column as an Object type
  - getOperator
```
public ConditionalExpression.Operator getOperator()
```
    Returns the operator used to compare the target column.
    
    Returns:
    
    the operator used to compare the target column
  - equals
```
public boolean equals(java.lang.Object o)
```
    Indicates whether some other object is "equal to" this object. The other object is considered equal if:
    - it is also an ConditionalExpression and
    - both instances have the same column name, value and operator.
    Overrides:
    
    equals in class java.lang.Object
    
    Parameters:
    
    o - an object to be tested for equality
    
    Returns:
    
    true if the other object is "equal to" this object otherwise false
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class java.lang.Object
  - toString
```
public java.lang.String toString()
```
    Overrides:
    
    toString in class java.lang.Object

Class ConditionalExpression

Nested Class Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

ConditionalExpression

ConditionalExpression

ConditionalExpression

ConditionalExpression

ConditionalExpression

ConditionalExpression

ConditionalExpression

ConditionalExpression

ConditionalExpression

Method Detail

getName

getValue

getColumn

getBooleanValue

getIntValue

getBigIntValue

getFloatValue

getDoubleValue

getTextValue

getBlobValue

getBlobValueAsByteBuffer

getBlobValueAsBytes

getDateValue

getTimeValue

getTimestampValue

getTimestampTZValue

getValueAsObject

getOperator

equals

hashCode

toString