com.screenscraper.util.form

Class Input

java.lang.Object

com.screenscraper.util.form.Input

All Implemented Interfaces:

java.io.Serializable

Direct Known Subclasses:

Button, CheckBox, ColorInput, CustomInput, DateInput, DateTimeInput, DateTimeLocalInput, EmailInput, File, MonthInput, NumberInput, RadioButton, Select, TelephoneInput, Text, TextArea, TimeInput, URLInput, WeekInput

public abstract class Input
extends java.lang.Object
implements java.io.Serializable

Represents an input for a form.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected java.lang.String	name
protected java.lang.String	value

Constructor Summary

Constructors

Constructor and Description
Input()

Method Summary

Modifier and Type	Method and Description
HTTPParameter	convertToHTTPParameter(int index) Converts this input to the HTTP Parameter that can be added to a Scrapeable File.
java.lang.String	getName() Gets the name of the input
java.lang.String	getValue() Gets the value of the input
void	setName(java.lang.String name) Sets the name value of the input
void	setValue(java.lang.String value) Sets the value for the input
abstract void	setValueChecked(java.lang.Object value) Sets the value for the input.

Methods inherited from class java.lang.Object

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

Field Detail

name

@Nullable
protected java.lang.String name

value

@Nullable
protected java.lang.String value

Constructor Detail

Input

public Input()

Method Detail

convertToHTTPParameter

@Nullable
public HTTPParameter convertToHTTPParameter(int index)

Converts this input to the HTTP Parameter that can be added to a Scrapeable File. If it returns null, this element should not be included as a parameter. This could be useful for something like a checkbox, that shouldn't be included

Parameters:

index - The index to use for this parameter

Returns:

The parameter to attach to a scrapeable file, or null if this parameter should be ignored (such as unchecked checkbox)

setName

public void setName(java.lang.String name)

Sets the name value of the input

Parameters:

name - The new name value for the input

getName

@Nullable
public java.lang.String getName()

Gets the name of the input

Returns:

The name of the input

setValue

public void setValue(java.lang.String value)

Sets the value for the input

Parameters:

value - The new value for the input

setValueChecked

public abstract void setValueChecked(java.lang.Object value)

Sets the value for the input. This is a checked set, meaning that an Exception is thrown if this is an invalid value for this input. This only accounts for valid input by the input type, not any javascript that might have been called to verify input by the site, or any server-side checks on the data

Parameters:

value - The new value for the input

Throws:

java.lang.IllegalArgumentException - If the value is invalid for the given input type

getValue

@Nullable
public java.lang.String getValue()

Gets the value of the input

Returns:

The value of the input