# RegexValue


```
public final class RegexValue
```

<br />

*** ** * ** ***

Represents a regular expression type in Firestore documents.

## Summary

| ### Public fields |
|---|---|
| `final https://developer.android.com/reference/kotlin/java/lang/String.html` | `https://firebase.google.com/docs/reference/android/com/google/firebase/firestore/RegexValue#options()` |
| `final https://developer.android.com/reference/kotlin/java/lang/String.html` | `https://firebase.google.com/docs/reference/android/com/google/firebase/firestore/RegexValue#pattern()` |

| ### Public constructors |
|---|
| `https://firebase.google.com/docs/reference/android/com/google/firebase/firestore/RegexValue#RegexValue(java.lang.String,java.lang.String)(@https://developer.android.com/reference/kotlin/androidx/annotation/NonNull.html https://developer.android.com/reference/kotlin/java/lang/String.html pattern, @https://developer.android.com/reference/kotlin/androidx/annotation/NonNull.html https://developer.android.com/reference/kotlin/java/lang/String.html options)` |

| ### Public methods |
|---|---|
| `boolean` | `https://firebase.google.com/docs/reference/android/com/google/firebase/firestore/RegexValue#equals(java.lang.Object)(https://developer.android.com/reference/kotlin/java/lang/Object.html obj)` Returns true if this RegexValue is equal to the provided object. |
| `int` | `https://firebase.google.com/docs/reference/android/com/google/firebase/firestore/RegexValue#hashCode()()` |
| `https://developer.android.com/reference/kotlin/java/lang/String.html` | `https://firebase.google.com/docs/reference/android/com/google/firebase/firestore/RegexValue#toString()()` |

## Public fields

### options

```
public final String options
```

### pattern

```
public final String pattern
```

## Public constructors

### RegexValue

```
public RegexValue(@NonNull String pattern, @NonNull String options)
```

## Public methods

### equals

```
public boolean equals(Object obj)
```

Returns true if this RegexValue is equal to the provided object.

| Parameters |
|---|---|
| `https://developer.android.com/reference/kotlin/java/lang/Object.html obj` | The object to compare against. |

| Returns |
|---|---|
| `boolean` | Whether this RegexValue is equal to the provided object. |

### hashCode

```
public int hashCode()
```

### toString

```
public String toString()
```