water.api
Class RequestArguments.GeneralFile

java.lang.Object
  water.Iced
      water.api.RequestArguments.Argument<T>
          water.api.RequestArguments.InputText<T>
              water.api.RequestArguments.TypeaheadInputText<java.lang.String>
                  water.api.RequestArguments.GeneralFile

All Implemented Interfaces:

java.lang.Cloneable, Request.Filter, Freezable

Enclosing class:

RequestArguments

public class RequestArguments.GeneralFile
extends RequestArguments.TypeaheadInputText<java.lang.String>

Field Summary

Fields inherited from class water.api.RequestArguments.TypeaheadInputText

_typeaheadHref, _typeaheadLimit

Fields inherited from class water.api.RequestArguments.Argument

_displayName, _field, _hideInQuery, _name, _prerequisites, _readOnly, _requestHelp, _required

Constructor Summary

RequestArguments.GeneralFile()

RequestArguments.GeneralFile(java.lang.String name)

Method Summary

protected java.lang.String	defaultValue() Returns the default value of the argument.
protected java.lang.String[]	errors() Returns a list of possible error strings, that could be thrown in an IllegalArgumentException.
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.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, 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

Constructor Detail

RequestArguments.GeneralFile

public RequestArguments.GeneralFile()

RequestArguments.GeneralFile

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

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

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>

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>

errors

protected java.lang.String[] errors()

Description copied from class: RequestArguments.Argument

Returns a list of possible error strings, that could be thrown in an IllegalArgumentException.

Overrides:

errors in class RequestArguments.Argument<java.lang.String>