A2uiCheckRuleSchema

public final class A2uiCheckRuleSchema extends A2uiCompositeSchema

java.lang.Object
   ↳ androidx.a2ui.model.schema.A2uiSchema
     ↳ androidx.a2ui.model.schema.A2uiCompositeSchema
       ↳ androidx.a2ui.model.schema.commontypes.A2uiCheckRuleSchema

Validates input components.

Summary

Public fields
static final @NonNull A2uiCheckRuleSchema

Public constructors

Public methods
boolean
equals(Object other)
@NonNull A2uiSchema

Returns the underlying schema definition.
@NonNull String

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

semantic description of the schema
@NonNull String

Root schema ID used to reference this sub-schema.
int
@NonNull String

Inherited methods
From androidx.a2ui.model.schema.A2uiCompositeSchema
@NonNull List<@NonNull A2uiSchemaKeyword<@NonNull Object>>

List of JSON Schema keywords applied to this schema node.
@NonNull JsonElement

Serializes this schema to a JSON Schema string representation.
From androidx.a2ui.model.schema.A2uiSchema
final @NonNull String

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-alpha01
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
@NonNull 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 definitionName is null.

hashCode

public int hashCode()

toString

public @NonNull String toString()