Package io.deephaven.web.client.api

Class StringListColumnRestriction

java.lang.Object

io.deephaven.web.client.api.ColumnRestriction

io.deephaven.web.client.api.StringListColumnRestriction

@TestUseOnly
@TsName(namespace="dh")
public class StringListColumnRestriction
extends ColumnRestriction

A ColumnRestriction that constrains a string column to one of a fixed set of allowed values.

This class is intended for testing and demonstrating validation functionality, it is not production ready and may be changed or removed at any time.

Constructor Summary

Constructors

Constructor	Description
StringListColumnRestriction(StringListRestriction restriction)

Method Summary

Modifier and Type	Method	Description
elemental2.core.JsArray<String>	getAllowedValues()	The list of allowed string values for this column.
String	toString()
@JsNullable String	validate(@JsNullable jsinterop.base.Any value)	Validates a proposed value against this restriction.

Methods inherited from class io.deephaven.web.client.api.ColumnRestriction

getType

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Details

StringListColumnRestriction

public StringListColumnRestriction(StringListRestriction restriction)

Method Details

getAllowedValues

@JsProperty
public elemental2.core.JsArray<String> getAllowedValues()

The list of allowed string values for this column.

Returns:

The allowed values

validate

@JsMethod
public @JsNullable String validate(@JsNullable jsinterop.base.Any value)

Description copied from class: ColumnRestriction

Validates a proposed value against this restriction.

Specified by:

validate in class ColumnRestriction

Parameters:

value - The proposed column value to validate

Returns:

An error message if the value violates the restriction, or null if the value is valid

toString

public String toString()

Overrides:

toString in class ColumnRestriction