com.basho.riak.client.core.query.timeseries

Class ColumnDescription

java.lang.Object

com.basho.riak.client.core.query.timeseries.ColumnDescription

Direct Known Subclasses:

FullColumnDescription

public class ColumnDescription
extends Object

A minimal metadata description of a column in Riak Time Series. Contains a column name and column type.

Since:

2.0.3

Author:

Alex Moore , Sergey Galkin

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ColumnDescription.ColumnType Values MUST BE IN THE SAME ORDER AS in the RiakTsPB.TsColumnType

Constructor Summary

Constructors

Constructor and Description
ColumnDescription(String name, ColumnDescription.ColumnType type) Create a new ColumnDescription.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	equals(Object o)
String	getName() Get the Column Name.
ColumnDescription.ColumnType	getType() Get the Column Type.
int	hashCode()

Methods inherited from class java.lang.Object

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

Constructor Detail

ColumnDescription

public ColumnDescription(String name,
                 ColumnDescription.ColumnType type)

Create a new ColumnDescription.

Parameters:

name - The name of the column. Required - must not be null or an empty string.

type - The type of the column. Required - must not be null.

Throws:

IllegalArgumentException - if Column Name or Column Type are null or empty.

Method Detail

getName

public String getName()

Get the Column Name.

Returns:

the column name String.

getType

public ColumnDescription.ColumnType getType()

Get the Column Type.

Returns:

the ColumnType value.

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object