water.api

Class RequestArguments.H2OExistingKey

java.lang.Object

water.Iced

water.api.RequestArguments.Argument<T>

water.api.RequestArguments.InputText<T>

water.api.RequestArguments.TypeaheadInputText<Value>

water.api.RequestArguments.H2OExistingKey

All Implemented Interfaces:

java.lang.Cloneable, Request.Filter, Freezable

Direct Known Subclasses:

Parse.HeaderKey

Enclosing class:

RequestArguments

public class RequestArguments.H2OExistingKey
extends RequestArguments.TypeaheadInputText<Value>

Field Summary

Fields

Modifier and Type	Field and Description
Key	_defaultValue

Fields inherited from class water.api.RequestArguments.TypeaheadInputText

_typeaheadHref, _typeaheadLimit

Fields inherited from class water.api.RequestArguments.Argument

_displayName, _field, _gridable, _hideInQuery, _mustExist, _name, _prerequisites, _readOnly, _requestHelp, _required, _validator

Constructor Summary

Constructors

Constructor and Description
RequestArguments.H2OExistingKey(java.lang.String name)
RequestArguments.H2OExistingKey(java.lang.String name, boolean required)
RequestArguments.H2OExistingKey(java.lang.String name, Key key)
RequestArguments.H2OExistingKey(java.lang.String name, java.lang.String keyName)

Method Summary

Methods

Modifier and Type	Method and Description
protected Value	defaultValue() Returns the default value of the argument.
protected Value	parse(java.lang.String input) Override this method to provide parsing of the input string to the Java expected value.
protected java.lang.String	queryDescription() Returns the query description.
void	setValue(Value v)

Methods inherited from class water.api.RequestArguments.TypeaheadInputText

jsAddons

Methods inherited from class water.api.RequestArguments.InputText

jsRefresh, jsValue, queryElement

Methods inherited from class water.api.RequestArguments.Argument

addPrerequisite, check, disable, disable, disabled, errors, getDisplayName, getName, originalValue, query, queryAddons, queryComment, record, refreshOnChange, requestHelp, reset, run, setRefreshOnChange, specified, valid, value

Methods inherited from class water.Iced

clone, frozenType, init, newInstance, read, toDocField, write, writeJSON, writeJSONFields

Methods inherited from class java.lang.Object

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

Field Detail

_defaultValue

public final Key _defaultValue

Constructor Detail

RequestArguments.H2OExistingKey

public RequestArguments.H2OExistingKey(java.lang.String name)

RequestArguments.H2OExistingKey

public RequestArguments.H2OExistingKey(java.lang.String name,
                               boolean required)

RequestArguments.H2OExistingKey

public RequestArguments.H2OExistingKey(java.lang.String name,
                               java.lang.String keyName)

RequestArguments.H2OExistingKey

public RequestArguments.H2OExistingKey(java.lang.String name,
                               Key key)

Method Detail

setValue

public void setValue(Value v)

parse

protected Value parse(java.lang.String input)
               throws java.lang.IllegalArgumentException

Description copied from class: RequestArguments.Argument

Override this method to provide parsing of the input string to the Java expected value. The input is guaranteed to be non-empty when this method is called and all prerequisities are guaranteed to be valid before this method is called.

Specified by:

parse in class RequestArguments.Argument<Value>

Throws:

java.lang.IllegalArgumentException

defaultValue

protected Value defaultValue()

Description copied from class: RequestArguments.Argument

Returns the default value of the argument. Note that the method will be called also on required arguments, in which case it is ok return null. It is kept abstract because defining a proper default value might be tricky and in many case you do not want it to be null. Overriding it always makes you think:)

Specified by:

defaultValue in class RequestArguments.Argument<Value>

queryDescription

protected java.lang.String queryDescription()

Description copied from class: RequestArguments.Argument

Returns the query description. This is a concise description of a correct value for the argument. generally used as a placeholder in the html query elements.

Specified by:

queryDescription in class RequestArguments.Argument<Value>