Package com.hazelcast.sql

Class SqlRowMetadata

java.lang.Object

com.hazelcast.sql.SqlRowMetadata

public final class SqlRowMetadata
extends java.lang.Object

SQL row metadata.

Field Summary

Fields

Modifier and Type	Field	Description
static int	COLUMN_NOT_FOUND	Constant indicating that the column is not found.

Constructor Summary

Constructors

Constructor	Description
SqlRowMetadata(java.util.List<SqlColumnMetadata> columns)

Method Summary

Modifier and Type	Method	Description
boolean	equals(java.lang.Object o)
int	findColumn(java.lang.String columnName)	Find index of the column with the given name.
SqlColumnMetadata	getColumn(int index)	Gets column metadata.
int	getColumnCount()	Gets the number of columns in the row.
java.util.List<SqlColumnMetadata>	getColumns()	Gets columns metadata.
int	hashCode()
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

COLUMN_NOT_FOUND

public static final int COLUMN_NOT_FOUND

Constant indicating that the column is not found.

See Also:

Constant Field Values

Constructor Detail

SqlRowMetadata

@PrivateApi
public SqlRowMetadata(@Nonnull
                      java.util.List<SqlColumnMetadata> columns)

Method Detail

getColumnCount

public int getColumnCount()

Gets the number of columns in the row.

Returns:

the number of columns in the row

getColumn

@Nonnull
public SqlColumnMetadata getColumn(int index)

Gets column metadata.

Parameters:

index - column index, zero-based

Returns:

column metadata

Throws:

java.lang.IndexOutOfBoundsException - If the column index is out of bounds

getColumns

@Nonnull
public java.util.List<SqlColumnMetadata> getColumns()

Gets columns metadata.

Returns:

columns metadata

findColumn

public int findColumn(@Nonnull
                      java.lang.String columnName)

Find index of the column with the given name. Returned index can be used to get column value from SqlRow.

Parameters:

columnName - column name (case sensitive)

Returns:

column index or COLUMN_NOT_FOUND if a column with the given name is not found

Throws:

java.lang.NullPointerException - if column name is null

See Also:

SqlRow

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

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object