Package com.microsoft.azure.toolkit.lib.common.form

Interface AzureFormInput<T>

All Superinterfaces:

DataStore

All Known Subinterfaces:

AzureForm<T>

public interface AzureFormInput<T>
extends DataStore

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static interface	AzureFormInput.AzureValueChangeBiListener<T>
static interface	AzureFormInput.AzureValueChangeListener<T>
static interface	AzureFormInput.Validator

Nested classes/interfaces inherited from interface com.microsoft.azure.toolkit.lib.common.DataStore

DataStore.Field<T>, DataStore.Impl

Field Summary

Fields

Modifier and Type	Field	Description
static String	FIELD_DEFAULT_VALUE
static String	FIELD_LABEL
static String	FIELD_REQUIRED
static String	FIELD_TRACKING
static String	FIELD_VALIDATING
static String	FIELD_VALIDATION_INFO
static String	FIELD_VALIDATORS
static String	FIELD_VALUE
static String	FIELD_VALUE_LISTENERS
static String	MSG_REQUIRED

Method Summary

Modifier and Type	Method	Description
default void	addValidator(AzureFormInput.Validator validator)
default void	addValueChangedListener(AzureFormInput.AzureValueChangeListener<T> listener)
default AzureValidationInfo	doValidate(T value)	Deprecated. use addValidator(Validator) instead.
default boolean	fireValueChangedEvent()
default boolean	fireValueChangedEvent(T val)
default T	getDefaultValue()
default String	getLabel()
default AzureValidationInfo	getValidationInfo()
default AzureValidationInfo	getValidationInfo(boolean revalidateIfNone)
default Collection<AzureFormInput.Validator>	getValidators()
default T	getValue()
default List<AzureFormInput.AzureValueChangeListener<T>>	getValueChangedListeners()
default boolean	isRequired()
default boolean	needValidation()
default void	removeValueChangedListener(AzureFormInput.AzureValueChangeListener<T> listener)
default void	setDefaultValue(T val)
default void	setLabel(String label)
default void	setRequired(boolean required)
default void	setValidationInfo(AzureValidationInfo info)
default void	setValidator(AzureFormInput.Validator validator)	Deprecated.
default void	setValue(T val)
default void	trackValidation()
default AzureValidationInfo	validateInternal(T v)
default reactor.core.publisher.Mono<AzureValidationInfo>	validateInternalAsync(T value)
default AzureValidationInfo	validateValue()	validate and set validation info
default reactor.core.publisher.Mono<AzureValidationInfo>	validateValueAsync()	validate and set validation info

Methods inherited from interface com.microsoft.azure.toolkit.lib.common.DataStore

clearAll, get, get, get, get, get, get, set, set, set

Field Detail

MSG_REQUIRED

static final String MSG_REQUIRED

See Also:

Constant Field Values

FIELD_VALUE

static final String FIELD_VALUE

See Also:

Constant Field Values

FIELD_LABEL

static final String FIELD_LABEL

See Also:

Constant Field Values

FIELD_DEFAULT_VALUE

static final String FIELD_DEFAULT_VALUE

See Also:

Constant Field Values

FIELD_VALIDATORS

static final String FIELD_VALIDATORS

See Also:

Constant Field Values

FIELD_REQUIRED

static final String FIELD_REQUIRED

See Also:

Constant Field Values

FIELD_VALIDATION_INFO

static final String FIELD_VALIDATION_INFO

See Also:

Constant Field Values

FIELD_VALUE_LISTENERS

static final String FIELD_VALUE_LISTENERS

See Also:

Constant Field Values

FIELD_TRACKING

static final String FIELD_TRACKING

See Also:

Constant Field Values

FIELD_VALIDATING

static final String FIELD_VALIDATING

See Also:

Constant Field Values

Method Detail

getValue

default T getValue()

Throws:

RuntimeException - if you can not get a valid value.

setValue

default void setValue(T val)

getDefaultValue

default T getDefaultValue()

setDefaultValue

default void setDefaultValue(T val)

addValueChangedListener

default void addValueChangedListener(AzureFormInput.AzureValueChangeListener<T> listener)

removeValueChangedListener

default void removeValueChangedListener(AzureFormInput.AzureValueChangeListener<T> listener)

getValueChangedListeners

default List<AzureFormInput.AzureValueChangeListener<T>> getValueChangedListeners()

fireValueChangedEvent

default boolean fireValueChangedEvent(T val)

Returns:

true if event is really fired(when value is really changed from last time), false otherwise

fireValueChangedEvent

default boolean fireValueChangedEvent()

Returns:

true if event is really fired(when value is really changed from last time), false otherwise

getLabel

default String getLabel()

setLabel

default void setLabel(String label)

doValidate

@Nonnull
@Deprecated
default AzureValidationInfo doValidate(T value)

Deprecated.

use addValidator(Validator) instead.

override this method to implement validation

validateInternal

@Internal
default AzureValidationInfo validateInternal(T v)

validateValue

@Nonnull
default AzureValidationInfo validateValue()

validate and set validation info

Returns:

the validation result

validateValueAsync

default reactor.core.publisher.Mono<AzureValidationInfo> validateValueAsync()

validate and set validation info

Returns:

the validation result

validateInternalAsync

@Nonnull
@Internal
default reactor.core.publisher.Mono<AzureValidationInfo> validateInternalAsync(T value)

trackValidation

default void trackValidation()

setValidationInfo

default void setValidationInfo(@Nullable
                               AzureValidationInfo info)

getValidationInfo

default AzureValidationInfo getValidationInfo()

Returns:

last saved validation info

getValidationInfo

default AzureValidationInfo getValidationInfo(boolean revalidateIfNone)

Returns:

last saved validation info or validate asynchronously (PENDING before validation completes)

getValidators

@Nonnull
default Collection<AzureFormInput.Validator> getValidators()

setValidator

@Deprecated
default void setValidator(@Nonnull
                          AzureFormInput.Validator validator)

Deprecated.

addValidator

default void addValidator(@Nonnull
                          AzureFormInput.Validator validator)

isRequired

default boolean isRequired()

setRequired

default void setRequired(boolean required)

needValidation

default boolean needValidation()