org.bson

Class BsonRegularExpression

java.lang.Object

org.bson.BsonValue

org.bson.BsonRegularExpression

All Implemented Interfaces:

Serializable

public final class BsonRegularExpression
extends BsonValue
implements Serializable

A holder class for a BSON regular expression, so that we can delay compiling into a Pattern until necessary.

Since:

3.0

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
BsonRegularExpression(String pattern) Creates a new instance with no options set.
BsonRegularExpression(String pattern, String options) Creates a new instance

Method Summary

Methods

Modifier and Type	Method and Description
boolean	equals(Object o)
BsonType	getBsonType() Gets the BSON type of this value.
String	getOptions() Gets the options for the regular expression
String	getPattern() Gets the regex pattern.
int	hashCode()
String	toString()

Methods inherited from class org.bson.BsonValue

asArray, asBinary, asBoolean, asDateTime, asDBPointer, asDocument, asDouble, asInt32, asInt64, asJavaScript, asJavaScriptWithScope, asNumber, asObjectId, asRegularExpression, asString, asSymbol, asTimestamp, isArray, isBinary, isBoolean, isDateTime, isDBPointer, isDocument, isDouble, isInt32, isInt64, isJavaScript, isJavaScriptWithScope, isNull, isNumber, isObjectId, isRegularExpression, isString, isSymbol, isTimestamp

Methods inherited from class java.lang.Object

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

Constructor Detail

BsonRegularExpression

public BsonRegularExpression(String pattern,
                     String options)

Creates a new instance

Parameters:

pattern - the regular expression Pattern

options - the options for the regular expression

BsonRegularExpression

public BsonRegularExpression(String pattern)

Creates a new instance with no options set.

Parameters:

pattern - the regular expression Pattern

Method Detail

getBsonType

public BsonType getBsonType()

Description copied from class: BsonValue

Gets the BSON type of this value.

Specified by:

getBsonType in class BsonValue

Returns:

the BSON type, which may not be null (but may be BSONType.NULL)

getPattern

public String getPattern()

Gets the regex pattern.

Returns:

the regular expression pattern

getOptions

public String getOptions()

Gets the options for the regular expression

Returns:

the options.

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object