BsonRegularExpression (mongo-java-driver 3.12.10 API)

- org.bson.BsonValue
- - org.bson.BsonRegularExpression

```
public final class BsonRegularExpression
extends BsonValue
```
A holder class for a BSON regular expression, so that we can delay compiling into a Pattern until necessary.

Since:

3.0

Constructor Summary

Constructors
Constructor Description

pattern)
Creates a new instance with no options set.

pattern, options)
Creates a new instance

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`boolean`	`o)`
`BsonType`	`getBsonType()`	Gets the BSON type of this value.
	`getOptions()`	Gets the options for the regular expression
	`getPattern()`	Gets the regex pattern.
`int`	`hashCode()`
	`toString()`

Methods inherited from class org.bson.BsonValue
asArray, asBinary, asBoolean, asDateTime, asDBPointer, asDecimal128, asDocument, asDouble, asInt32, asInt64, asJavaScript, asJavaScriptWithScope, asNumber, asObjectId, asRegularExpression, asString, asSymbol, asTimestamp, isArray, isBinary, isBoolean, isDateTime, isDBPointer, isDecimal128, isDocument, isDouble, isInt32, isInt64, isJavaScript, isJavaScriptWithScope, isNull, isNumber, isObjectId, isRegularExpression, isString, isSymbol, isTimestamp

Methods inherited from class java.lang.
, , , , , , ,

- Constructor Detail
  - BsonRegularExpression
```
public BsonRegularExpression( pattern,
                              options)
```
    Creates a new instance
    
    Parameters:
    
    pattern - the regular expression
    
    options - the options for the regular expression
  - BsonRegularExpression
```
public BsonRegularExpression( pattern)
```
    Creates a new instance with no options set.
    
    Parameters:
    
    pattern - the regular expression
- 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  getPattern()
```
    Gets the regex pattern.
    
    Returns:
    
    the regular expression pattern
  - getOptions
```
public  getOptions()
```
    Gets the options for the regular expression
    
    Returns:
    
    the options.
  - equals
```
public boolean equals( o)
```
    Overrides:
    
    in class
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    in class
  - toString
```
public  toString()
```
    Overrides:
    
    in class