# A2uiCheckRuleSchema

Artifact: [androidx.a2ui:a2ui-model](https://developer.android.com/jetpack/androidx/releases/a2ui) [View Source](https://cs.android.com/search?q=file:androidx/a2ui/model/schema/commontypes/A2uiCheckRuleSchema.kt+class:androidx.a2ui.model.schema.commontypes.A2uiCheckRuleSchema) Added in [1.0.0-alpha02](https://developer.android.com/jetpack/androidx/releases/a2ui#1.0.0-alpha02)

*** ** * ** ***


```
public final class A2uiCheckRuleSchema extends A2uiCompositeSchema
```

<br />

|---|---|---|---|
| [java.lang.Object](https://developer.android.com/reference/java/lang/Object.html) ||||
| ↳ | [androidx.a2ui.model.schema.A2uiSchema](https://developer.android.com/reference/androidx/a2ui/model/schema/A2uiSchema) |||
|   | ↳ | [androidx.a2ui.model.schema.A2uiCompositeSchema](https://developer.android.com/reference/androidx/a2ui/model/schema/A2uiCompositeSchema) ||
|   |   | ↳ | [androidx.a2ui.model.schema.commontypes.A2uiCheckRuleSchema](https://developer.android.com/reference/androidx/a2ui/model/schema/commontypes/A2uiCheckRuleSchema) |

*** ** * ** ***

Validates input components.

## Summary

| ### Public fields |
|---|---|
| `static final @https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/androidx/a2ui/model/schema/commontypes/A2uiCheckRuleSchema` | `https://developer.android.com/reference/androidx/a2ui/model/schema/commontypes/A2uiCheckRuleSchema#DEFAULT_INSTANCE()` |

| ### Public constructors |
|---|
| `https://developer.android.com/reference/androidx/a2ui/model/schema/commontypes/A2uiCheckRuleSchema#A2uiCheckRuleSchema(kotlin.String)(https://developer.android.com/reference/java/lang/String.html description)` |

| ### Public methods |
|---|---|
| `boolean` | `https://developer.android.com/reference/androidx/a2ui/model/schema/commontypes/A2uiCheckRuleSchema#equals(kotlin.Any)(https://developer.android.com/reference/java/lang/Object.html other)` |
| `@https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/androidx/a2ui/model/schema/A2uiSchema` | `https://developer.android.com/reference/androidx/a2ui/model/schema/commontypes/A2uiCheckRuleSchema#getDefinition()()` Returns the underlying schema definition. |
| `@https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/java/lang/String.html` | `https://developer.android.com/reference/androidx/a2ui/model/schema/commontypes/A2uiCheckRuleSchema#getDefinitionName()()` Name of this schema within the `$defs` section of the generated JSON Schema. |
| `https://developer.android.com/reference/java/lang/String.html` | `https://developer.android.com/reference/androidx/a2ui/model/schema/commontypes/A2uiCheckRuleSchema#getDescription()()` semantic description of the schema |
| `@https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/java/lang/String.html` | `https://developer.android.com/reference/androidx/a2ui/model/schema/commontypes/A2uiCheckRuleSchema#getSchemaId()()` Root schema ID used to reference this sub-schema. |
| `int` | `https://developer.android.com/reference/androidx/a2ui/model/schema/commontypes/A2uiCheckRuleSchema#hashCode()()` |
| `@https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/java/lang/String.html` | `https://developer.android.com/reference/androidx/a2ui/model/schema/commontypes/A2uiCheckRuleSchema#toString()()` |

### Inherited methods

From [androidx.a2ui.model.schema.A2uiCompositeSchema](https://developer.android.com/reference/androidx/a2ui/model/schema/A2uiCompositeSchema) `@https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/java/util/List.html<@https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/androidx/a2ui/model/schema/A2uiSchemaKeyword<@https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/java/lang/Object.html>>` `https://developer.android.com/reference/androidx/a2ui/model/schema/A2uiCompositeSchema#getKeywords()()`

List of JSON Schema keywords applied to this schema node.
`@https://developer.android.com/reference/androidx/annotation/NonNull https://kotlinlang.org/api/kotlinx.serialization/kotlinx-serialization-json/kotlinx.serialization.json/-json-element/index.html` `https://developer.android.com/reference/androidx/a2ui/model/schema/A2uiCompositeSchema#toJsonElement()()`

Serializes this schema to a JSON Schema string representation.
From [androidx.a2ui.model.schema.A2uiSchema](https://developer.android.com/reference/androidx/a2ui/model/schema/A2uiSchema) `final @https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/java/lang/String.html` `https://developer.android.com/reference/androidx/a2ui/model/schema/A2uiSchema#toJsonSchema()()`

Serializes this schema to a JSON Schema string representation.

## Public fields

### DEFAULT_INSTANCE

```
public static final @NonNull A2uiCheckRuleSchema DEFAULT_INSTANCE
```

## Public constructors

### A2uiCheckRuleSchema

Added in [1.0.0-alpha02](https://developer.android.com/jetpack/androidx/releases/a2ui#1.0.0-alpha02)

```
public A2uiCheckRuleSchema(String description)
```

## Public methods

### equals

```
public boolean equals(Object other)
```

### getDefinition

```
public @NonNull A2uiSchema getDefinition()
```

Returns the underlying schema definition.

Concrete subclasses must implement this to return the actual schema details that this schema wraps.

| Returns |
|---|---|
| `@https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/androidx/a2ui/model/schema/A2uiSchema` | the underlying schema definition |

### getDefinitionName

```
public @NonNull String getDefinitionName()
```

Name of this schema within the `$defs` section of the generated JSON Schema.

If non-null, nested references to this schema will generate a `$ref` pointing to this definition name instead of inlining the full schema. Use this to avoid duplicating complex schemas in components.

### getDescription

```
public String getDescription()
```

semantic description of the schema

### getSchemaId

```
public @NonNull String getSchemaId()
```

Root schema ID used to reference this sub-schema.

Non-null values prepend this ID to the `$ref` path when serializing this schema.

- Format when non-null: `"$schemaId#/$defs/$definitionName"`

- Format when null: `"#/$defs/$definitionName"`

Note: This has no effect if `https://developer.android.com/reference/androidx/a2ui/model/schema/A2uiCompositeSchema#definitionName()` is null.

### hashCode

```
public int hashCode()
```

### toString

```
public @NonNull String toString()
```