AppFunctionStringTypeMetadata
public final class AppFunctionStringTypeMetadata extends AppFunctionDataTypeMetadata
| java.lang.Object | ||
| ↳ | androidx.appfunctions.metadata.AppFunctionDataTypeMetadata | |
| ↳ | androidx.appfunctions.metadata.AppFunctionStringTypeMetadata | |
Defines the schema of a string data type.
Corresponds to kotlin.String.
Summary
Public constructors |
|---|
Public methods |
|
|---|---|
boolean |
|
final Set<@NonNull String> |
Defines the complete set of allowed string values accepted by this data type. |
final String |
The semantic format description for string values (e.g., |
final String |
The regex pattern that string values must match. |
int |
hashCode() |
@NonNull String |
toString() |
Inherited methods |
|---|
Constants
FORMAT_URI
public static final @NonNull String FORMAT_URI
The format string representing a URI value.
Public constructors
AppFunctionStringTypeMetadata
public AppFunctionStringTypeMetadata(
boolean isNullable,
@NonNull String description,
Set<@NonNull String> enumValues,
String pattern,
String format
)
Public methods
getEnumValues
public final Set<@NonNull String> getEnumValues()
Defines the complete set of allowed string values accepted by this data type.
If null, all values are allowed, otherwise it must be non-empty.
If any of the values carry special meaning (e.g., "AUTO" means automatic mode), such meanings should be documented clearly in the corresponding property, parameter, or function return KDoc.
getFormat
public final String getFormat()
The semantic format description for string values (e.g., "uri").
Provides a hint describing the expected format or semantic representation of the string values. A null value indicates that no format description is set.
getPattern
public final String getPattern()
The regex pattern that string values must match.
If specified, string values accepted by this data type must match this regular expression. A null value indicates that no pattern constraint is applied, whereas an empty string represents a pattern matching empty string values.