water.api

Class RequestArguments.Str

java.lang.Object

water.Iced

water.api.RequestArguments.Argument<T>

water.api.RequestArguments.InputText<java.lang.String>

water.api.RequestArguments.Str

All Implemented Interfaces:

java.lang.Cloneable, Request.Filter, Freezable

Direct Known Subclasses:

Parse.NewH2OHexKey

Enclosing class:

RequestArguments

public class RequestArguments.Str
extends RequestArguments.InputText<java.lang.String>

A string value. Any string can be a proper value. If required, empty string is not allowed.

Field Summary

Fields

Modifier and Type	Field and Description
java.lang.String	_defaultValue

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.Str(java.lang.String name)
RequestArguments.Str(java.lang.String name, java.lang.String defaultValue)

Method Summary

Methods

Modifier and Type	Method and Description
protected java.lang.String	defaultValue() Returns the default value of the argument.
protected java.lang.String	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.

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, jsAddons, 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 java.lang.String _defaultValue

Constructor Detail

RequestArguments.Str

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

RequestArguments.Str

public RequestArguments.Str(java.lang.String name,
                    java.lang.String defaultValue)

Method Detail

parse

protected java.lang.String 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<java.lang.String>

Throws:

java.lang.IllegalArgumentException

defaultValue

protected java.lang.String 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<java.lang.String>

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<java.lang.String>