# TextProofreader


```
public class TextProofreader implements Closeable
```

<br />

*** ** * ** ***

Performs proofreading on text.

## Summary

| ### Nested types |
|---|
| `public interface https://developers.google.com/edge/api/mediapipe/java/com/google/mediapipe/tasks/text/textproofreader/TextProofreader.ProofreaderResultCallback` Interface for receiving proofreading results. |
| `public abstract class https://developers.google.com/edge/api/mediapipe/java/com/google/mediapipe/tasks/text/textproofreader/TextProofreader.TextProofreaderOptions` Holds the configuration for creating a `https://developers.google.com/edge/api/mediapipe/java/com/google/mediapipe/tasks/text/textproofreader/TextProofreader` instance. |
| `public abstract class https://developers.google.com/edge/api/mediapipe/java/com/google/mediapipe/tasks/text/textproofreader/TextProofreader.TextProofreaderOptions.Builder` Builder for `https://developers.google.com/edge/api/mediapipe/java/com/google/mediapipe/tasks/text/textproofreader/TextProofreader.TextProofreaderOptions`. |

| ### Public methods |
|---|---|
| `void` | `https://developers.google.com/edge/api/mediapipe/java/com/google/mediapipe/tasks/text/textproofreader/TextProofreader#close()()` |
| `static https://developers.google.com/edge/api/mediapipe/java/com/google/mediapipe/tasks/text/textproofreader/TextProofreader` | `https://developers.google.com/edge/api/mediapipe/java/com/google/mediapipe/tasks/text/textproofreader/TextProofreader#createFromOptions(android.content.Context,com.google.mediapipe.tasks.text.textproofreader.TextProofreader.TextProofreaderOptions)( https://developer.android.com/reference/android/content/Context.html context, https://developers.google.com/edge/api/mediapipe/java/com/google/mediapipe/tasks/text/textproofreader/TextProofreader.TextProofreaderOptions options )` Creates a `https://developers.google.com/edge/api/mediapipe/java/com/google/mediapipe/tasks/text/textproofreader/TextProofreader` instance from `https://developers.google.com/edge/api/mediapipe/java/com/google/mediapipe/tasks/text/textproofreader/TextProofreader.TextProofreaderOptions`. |
| `https://developers.google.com/edge/api/mediapipe/java/com/google/mediapipe/tasks/text/textproofreader/TextProofreaderResult` | `https://developers.google.com/edge/api/mediapipe/java/com/google/mediapipe/tasks/text/textproofreader/TextProofreader#proofread(java.lang.String)(https://developer.android.com/reference/java/lang/String.html text)` Performs proofreading on the input text. |
| `void` | `https://developers.google.com/edge/api/mediapipe/java/com/google/mediapipe/tasks/text/textproofreader/TextProofreader#proofreadStreaming(java.lang.String,com.google.mediapipe.tasks.text.textproofreader.TextProofreader.ProofreaderResultCallback)( https://developer.android.com/reference/java/lang/String.html text, https://developers.google.com/edge/api/mediapipe/java/com/google/mediapipe/tasks/text/textproofreader/TextProofreader.ProofreaderResultCallback callback )` Performs asynchronous proofreading on the input text. |

## Public methods

### close

```
public void close()
```

### createFromOptions

```
public static TextProofreader createFromOptions(
    Context context,
    TextProofreader.TextProofreaderOptions options
)
```

Creates a `https://developers.google.com/edge/api/mediapipe/java/com/google/mediapipe/tasks/text/textproofreader/TextProofreader` instance from `https://developers.google.com/edge/api/mediapipe/java/com/google/mediapipe/tasks/text/textproofreader/TextProofreader.TextProofreaderOptions`.

| Parameters |
|---|---|
| `https://developer.android.com/reference/android/content/Context.html context` | The Android context. |
| `https://developers.google.com/edge/api/mediapipe/java/com/google/mediapipe/tasks/text/textproofreader/TextProofreader.TextProofreaderOptions options` | The configuration options. |

| Returns |
|---|---|
| `https://developers.google.com/edge/api/mediapipe/java/com/google/mediapipe/tasks/text/textproofreader/TextProofreader` | A `https://developers.google.com/edge/api/mediapipe/java/com/google/mediapipe/tasks/text/textproofreader/TextProofreader` instance. |

### proofread

```
public TextProofreaderResult proofread(String text)
```

Performs proofreading on the input text.

| Parameters |
|---|---|
| `https://developer.android.com/reference/java/lang/String.html text` | The input text to be proofread. |

| Returns |
|---|---|
| `https://developers.google.com/edge/api/mediapipe/java/com/google/mediapipe/tasks/text/textproofreader/TextProofreaderResult` | The proofreading result. |

### proofreadStreaming

```
public void proofreadStreaming(
    String text,
    TextProofreader.ProofreaderResultCallback callback
)
```

Performs asynchronous proofreading on the input text.

| Parameters |
|---|---|
| `https://developer.android.com/reference/java/lang/String.html text` | The input text to be proofread. |
| `https://developers.google.com/edge/api/mediapipe/java/com/google/mediapipe/tasks/text/textproofreader/TextProofreader.ProofreaderResultCallback callback` | The callback to receive the results. |