com.mongodb.jdbc

Enum BsonTypeInfo

java.lang.Object

java.lang.Enum<BsonTypeInfo>

com.mongodb.jdbc.BsonTypeInfo

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<BsonTypeInfo>

public enum BsonTypeInfo
extends java.lang.Enum<BsonTypeInfo>

Enum Constant Summary

Enum Constants

Enum Constant and Description
BSON_ARRAY
BSON_BINDATA
BSON_BOOL
BSON_BSON
BSON_DATE
BSON_DBPOINTER
BSON_DECIMAL
BSON_DOUBLE
BSON_INT
BSON_JAVASCRIPT
BSON_JAVASCRIPTWITHSCOPE
BSON_LONG
BSON_MAXKEY
BSON_MINKEY
BSON_NULL
BSON_OBJECT
BSON_OBJECTID
BSON_REGEX
BSON_STRING
BSON_SYMBOL
BSON_TIMESTAMP
BSON_UNDEFINED

Method Summary

Modifier and Type	Method and Description
java.lang.String	getBsonName()
org.bson.BsonType	getBsonType()
static BsonTypeInfo	getBsonTypeInfoByName(java.lang.String typeName) Converts a bson type name to a BsonTypeInfo
static BsonTypeInfo	getBsonTypeInfoFromBsonValue(org.bson.BsonValue obj) Converts a bson value to a BsonTypeInfo
boolean	getCaseSensitivity()
java.lang.Integer	getCharOctetLength() CHAR_OCTET_LENGTH is the maximum length of binary and character based data in bytes.
java.lang.Integer	getDecimalDigits()
java.lang.Integer	getFixedBytesLength()
int	getJdbcType()
int	getMaxScale()
int	getMinScale()
int	getNumPrecRadix()
java.lang.Integer	getPrecision()
static BsonTypeInfo	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static BsonTypeInfo[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

BSON_DOUBLE

public static final BsonTypeInfo BSON_DOUBLE

BSON_STRING

public static final BsonTypeInfo BSON_STRING

BSON_OBJECT

public static final BsonTypeInfo BSON_OBJECT

BSON_ARRAY

public static final BsonTypeInfo BSON_ARRAY

BSON_BINDATA

public static final BsonTypeInfo BSON_BINDATA

BSON_UNDEFINED

public static final BsonTypeInfo BSON_UNDEFINED

BSON_OBJECTID

public static final BsonTypeInfo BSON_OBJECTID

BSON_BOOL

public static final BsonTypeInfo BSON_BOOL

BSON_DATE

public static final BsonTypeInfo BSON_DATE

BSON_NULL

public static final BsonTypeInfo BSON_NULL

BSON_REGEX

public static final BsonTypeInfo BSON_REGEX

BSON_DBPOINTER

public static final BsonTypeInfo BSON_DBPOINTER

BSON_JAVASCRIPT

public static final BsonTypeInfo BSON_JAVASCRIPT

BSON_SYMBOL

public static final BsonTypeInfo BSON_SYMBOL

BSON_JAVASCRIPTWITHSCOPE

public static final BsonTypeInfo BSON_JAVASCRIPTWITHSCOPE

BSON_INT

public static final BsonTypeInfo BSON_INT

BSON_TIMESTAMP

public static final BsonTypeInfo BSON_TIMESTAMP

BSON_LONG

public static final BsonTypeInfo BSON_LONG

BSON_DECIMAL

public static final BsonTypeInfo BSON_DECIMAL

BSON_MINKEY

public static final BsonTypeInfo BSON_MINKEY

BSON_MAXKEY

public static final BsonTypeInfo BSON_MAXKEY

BSON_BSON

public static final BsonTypeInfo BSON_BSON

Method Detail

values

public static BsonTypeInfo[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (BsonTypeInfo c : BsonTypeInfo.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static BsonTypeInfo valueOf(java.lang.String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

java.lang.IllegalArgumentException - if this enum type has no constant with the specified name

java.lang.NullPointerException - if the argument is null

getBsonName

public java.lang.String getBsonName()

getBsonType

public org.bson.BsonType getBsonType()

getJdbcType

public int getJdbcType()

getCaseSensitivity

public boolean getCaseSensitivity()

getMinScale

public int getMinScale()

getMaxScale

public int getMaxScale()

getNumPrecRadix

public int getNumPrecRadix()

getPrecision

public java.lang.Integer getPrecision()

getFixedBytesLength

public java.lang.Integer getFixedBytesLength()

getDecimalDigits

public java.lang.Integer getDecimalDigits()

getCharOctetLength

public java.lang.Integer getCharOctetLength()

CHAR_OCTET_LENGTH is the maximum length of binary and character based data in bytes. For any other datatype the value is null. We can use 'precision' combined with the data type for reporting the correct info.

getBsonTypeInfoFromBsonValue

public static BsonTypeInfo getBsonTypeInfoFromBsonValue(org.bson.BsonValue obj)
                                                 throws java.sql.SQLException

Converts a bson value to a BsonTypeInfo

Parameters:

obj - is the Bson value to convert.

Returns:

BsonTypeInfo object corresponding to the Bson type.

Throws:

java.sql.SQLException

getBsonTypeInfoByName

public static BsonTypeInfo getBsonTypeInfoByName(java.lang.String typeName)
                                          throws java.sql.SQLException

Converts a bson type name to a BsonTypeInfo

Parameters:

typeName - is the bson type string as returned from the mongodb aggregation $type function, this list of viable inputs is in the BSON_TYPE_NAMES static Set above.

Returns:

BsonTypeInfo object corresponding to bson type name.

Throws:

java.sql.SQLException