Top Description Fields Constructors Methods
org.h2.value

public final Class ValueNull

extends Value
Class Inheritance
Imports
java.io.InputStream, .Reader, java.math.BigDecimal, org.h2.engine.CastDataProvider, org.h2.message.DbException
Implementation of NULL. NULL is not a regular data type.

Field Summary

Modifier and TypeField and Description
pack-priv static final int
DISPLAY_SIZE

The display size of the textual representation of NULL.

public static final ValueNull
INSTANCE

The main NULL instance.

pack-priv static final int
PRECISION

The precision of NULL.

Inherited from org.h2.value.Value:
ARRAYASSIGN_TOBIGINTBINARYBLOBBOOLEANCAST_TOCHARCLOBCONVERT_TODATEDECFLOATDOUBLEEMPTY_VALUESENUMGEOMETRYGROUP_BINARY_STRINGGROUP_BOOLEANGROUP_CHARACTER_STRINGGROUP_COLLECTIONGROUP_DATETIMEGROUP_INTERVAL_DTGROUP_INTERVAL_YMGROUP_NULLGROUP_NUMERICGROUP_OTHERGROUPSINTEGERINTERVAL_DAYINTERVAL_DAY_TO_HOURINTERVAL_DAY_TO_MINUTEINTERVAL_DAY_TO_SECONDINTERVAL_HOURINTERVAL_HOUR_TO_MINUTEINTERVAL_HOUR_TO_SECONDINTERVAL_MINUTEINTERVAL_MINUTE_TO_SECONDINTERVAL_MONTHINTERVAL_SECONDINTERVAL_YEARINTERVAL_YEAR_TO_MONTHJAVA_OBJECTJSONMAX_LONG_DECIMALMIN_LONG_DECIMALNULLNUMERICREALROWSMALLINTTIMETIME_TZTIMESTAMPTIMESTAMP_TZTINYINTTYPE_COUNTUNKNOWNUUIDVARBINARYVARCHARVARCHAR_IGNORECASE

Constructor Summary

AccessConstructor and Description
private
ValueNull()

Method Summary

Modifier and TypeMethod and Description
public int
compareTypeSafe(Value
the other value
v, CompareMode
the compare mode
mode, CastDataProvider
the cast information provider
provider)

Implements abstract org.h2.value.Value.compareTypeSafe.

Compare this value against another value given that the values are of the same data type.

public boolean
containsNull()

Overrides org.h2.value.Value.containsNull.

Returns true if this value is NULL or contains NULL value.

public boolean
equals(Object
the other value
other)

Implements abstract org.h2.value.Value.equals.

Check if the two values have the same hash code.

public BigDecimal
getBigDecimal()

Overrides org.h2.value.Value.getBigDecimal.

public boolean
getBoolean()

Overrides org.h2.value.Value.getBoolean.

Returns this value as a Java boolean value.

public byte
getByte()

Overrides org.h2.value.Value.getByte.

Returns this value as a Java byte value.

public byte[]
getBytes()

Overrides org.h2.value.Value.getBytes.

public double
getDouble()

Overrides org.h2.value.Value.getDouble.

Returns this value as a Java double value.

public float
getFloat()

Overrides org.h2.value.Value.getFloat.

Returns this value as a Java float value.

public InputStream
getInputStream()

Overrides org.h2.value.Value.getInputStream.

public InputStream
getInputStream(long
the offset (1 means no offset)
oneBasedOffset, long
the requested length
length)

Overrides org.h2.value.Value.getInputStream.

Get the input stream

public int
getInt()

Overrides org.h2.value.Value.getInt.

Returns this value as a Java int value.

public long
getLong()

Overrides org.h2.value.Value.getLong.

Returns this value as a Java long value.

public int
getMemory()

Overrides org.h2.value.Value.getMemory.

Get the memory used by this object.

public Reader
getReader()

Overrides org.h2.value.Value.getReader.

public Reader
getReader(long
the offset (1 means no offset)
oneBasedOffset, long
the requested length
length)

Overrides org.h2.value.Value.getReader.

Get the reader

public short
getShort()

Overrides org.h2.value.Value.getShort.

Returns this value as a Java short value.

public StringBuilder
getSQL(StringBuilder
string builder
builder, int
formatting flags
sqlFlags)

Implements org.h2.util.HasSQL.getSQL.

Appends the SQL statement of this object to the specified builder.

public String
getString()

Implements abstract org.h2.value.Value.getString.

Get the value as a string.

public TypeInfo
getType()

Implements abstract org.h2.value.Value.getType.

Implements org.h2.value.Typed.getType.

Returns the data type.

public int
getValueType()

Implements abstract org.h2.value.Value.getValueType.

Get the value type.

public int
hashCode()

Implements abstract org.h2.value.Value.hashCode.

Returns a hash code value for this object.

Inherited from org.h2.value.Value:
addcachecastTocharLengthclearCachecompareTocompareWithNullconvertForAssignToconvertToconvertToconvertToconvertToconvertToconvertToAnyArrayconvertToAnyJsonconvertToAnyRowconvertToBigintconvertToBooleanconvertToCharconvertToDateconvertToDoubleconvertToEnumconvertToGeometryconvertToIntconvertToIntconvertToJavaObjectconvertToJsonconvertToLongconvertToRealconvertToSmallintconvertToTinyintconvertToUuiddividegetBytesNoCopygetDataConversionErrorgetDataConversionErrorgetHigherOrdergetHigherOrderKnowngetSignumgetTypeNamegetUnsupportedExceptionForOperationgetValueTooLongExceptiongetValueWithFirstNullgetValueWithFirstNullImplisFalseisTruemodulusmultiplynegateoctetLengthrangeChecksubtracttoString

Field Detail

DISPLAY_SIZEback to summary
pack-priv static final int DISPLAY_SIZE

The display size of the textual representation of NULL.

INSTANCEback to summary
public static final ValueNull INSTANCE

The main NULL instance.

PRECISIONback to summary
pack-priv static final int PRECISION

The precision of NULL.

Constructor Detail

ValueNullback to summary
private ValueNull()

Method Detail

compareTypeSafeback to summary
public int compareTypeSafe(Value v, CompareMode mode, CastDataProvider provider)

Implements abstract org.h2.value.Value.compareTypeSafe.

Doc from org.h2.value.Value.compareTypeSafe.

Compare this value against another value given that the values are of the same data type.

Parameters
v:Value

the other value

mode:CompareMode

the compare mode

provider:CastDataProvider

the cast information provider

Returns:int

0 if both values are equal, -1 if the other value is smaller, and 1 otherwise

Annotations
@Override
containsNullback to summary
public boolean containsNull()

Overrides org.h2.value.Value.containsNull.

Doc from org.h2.value.Value.containsNull.

Returns true if this value is NULL or contains NULL value.

Returns:boolean

true if this value is NULL or contains NULL value

Annotations
@Override
equalsback to summary
public boolean equals(Object other)

Implements abstract org.h2.value.Value.equals.

Doc from org.h2.value.Value.equals.

Check if the two values have the same hash code. No data conversion is made; this method returns false if the other object is not of the same class. For some values, compareTo may return 0 even if equals return false. Example: ValueDecimal 0.0 and 0.00.

Parameters
other:Object

the other value

Returns:boolean

true if they are equal

Annotations
@Override
getBigDecimalback to summary
public BigDecimal getBigDecimal()

Overrides org.h2.value.Value.getBigDecimal.

Annotations
@Override
getBooleanback to summary
public boolean getBoolean()

Overrides org.h2.value.Value.getBoolean.

Doc from org.h2.value.Value.getBoolean.

Returns this value as a Java boolean value.

Returns:boolean

value

Annotations
@Override
getByteback to summary
public byte getByte()

Overrides org.h2.value.Value.getByte.

Doc from org.h2.value.Value.getByte.

Returns this value as a Java byte value.

Returns:byte

value

Annotations
@Override
getBytesback to summary
public byte[] getBytes()

Overrides org.h2.value.Value.getBytes.

Annotations
@Override
getDoubleback to summary
public double getDouble()

Overrides org.h2.value.Value.getDouble.

Doc from org.h2.value.Value.getDouble.

Returns this value as a Java double value.

Returns:double

value

Annotations
@Override
getFloatback to summary
public float getFloat()

Overrides org.h2.value.Value.getFloat.

Doc from org.h2.value.Value.getFloat.

Returns this value as a Java float value.

Returns:float

value

Annotations
@Override
getInputStreamback to summary
public InputStream getInputStream()

Overrides org.h2.value.Value.getInputStream.

Annotations
@Override
getInputStreamback to summary
public InputStream getInputStream(long oneBasedOffset, long length)

Overrides org.h2.value.Value.getInputStream.

Doc from org.h2.value.Value.getInputStream.

Get the input stream

Parameters
oneBasedOffset:long

the offset (1 means no offset)

length:long

the requested length

Returns:InputStream

the new input stream

Annotations
@Override
getIntback to summary
public int getInt()

Overrides org.h2.value.Value.getInt.

Doc from org.h2.value.Value.getInt.

Returns this value as a Java int value.

Returns:int

value

Annotations
@Override
getLongback to summary
public long getLong()

Overrides org.h2.value.Value.getLong.

Doc from org.h2.value.Value.getLong.

Returns this value as a Java long value.

Returns:long

value

Annotations
@Override
getMemoryback to summary
public int getMemory()

Overrides org.h2.value.Value.getMemory.

Doc from org.h2.value.Value.getMemory.

Get the memory used by this object.

Returns:int

the memory used in bytes

Annotations
@Override
getReaderback to summary
public Reader getReader()

Overrides org.h2.value.Value.getReader.

Annotations
@Override
getReaderback to summary
public Reader getReader(long oneBasedOffset, long length)

Overrides org.h2.value.Value.getReader.

Doc from org.h2.value.Value.getReader.

Get the reader

Parameters
oneBasedOffset:long

the offset (1 means no offset)

length:long

the requested length

Returns:Reader

the new reader

Annotations
@Override
getShortback to summary
public short getShort()

Overrides org.h2.value.Value.getShort.

Doc from org.h2.value.Value.getShort.

Returns this value as a Java short value.

Returns:short

value

Annotations
@Override
getSQLback to summary
public StringBuilder getSQL(StringBuilder builder, int sqlFlags)

Implements org.h2.util.HasSQL.getSQL.

Doc from org.h2.util.HasSQL.getSQL.

Appends the SQL statement of this object to the specified builder.

Parameters
builder:StringBuilder

string builder

sqlFlags:int

formatting flags

Returns:StringBuilder

the specified string builder

Annotations
@Override
getStringback to summary
public String getString()

Implements abstract org.h2.value.Value.getString.

Doc from org.h2.value.Value.getString.

Get the value as a string.

Returns:String

the string

Annotations
@Override
getTypeback to summary
public TypeInfo getType()

Implements abstract org.h2.value.Value.getType.

Implements org.h2.value.Typed.getType.

Doc from org.h2.value.Typed.getType.

Returns the data type.

Returns:TypeInfo

the data type

Annotations
@Override
getValueTypeback to summary
public int getValueType()

Implements abstract org.h2.value.Value.getValueType.

Doc from org.h2.value.Value.getValueType.

Get the value type.

Returns:int

the value type

Annotations
@Override
hashCodeback to summary
public int hashCode()

Implements abstract org.h2.value.Value.hashCode.

Doc from java.lang.Object.hashCode.

Returns a hash code value for this object. This method is supported for the benefit of hash tables such as those provided by java.util.HashMap.

The general contract of hashCode is:

  • Whenever it is invoked on the same object more than once during an execution of a Java application, the hashCode method must consistently return the same integer, provided no information used in equals comparisons on the object is modified. This integer need not remain consistent from one execution of an application to another execution of the same application.
  • If two objects are equal according to the equals method, then calling the hashCode method on each of the two objects must produce the same integer result.
  • It is not required that if two objects are unequal according to the equals method, then calling the hashCode method on each of the two objects must produce distinct integer results. However, the programmer should be aware that producing distinct integer results for unequal objects may improve the performance of hash tables.
Returns:int

a hash code value for this object

Annotations
@Override