siren

Class Field<T>

java.lang.Object

siren.Field<T>

public class Field<T>
extends java.lang.Object

Represents a control inside of an action.

Since:

8/13/17

Author:

jonfreer

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Field.Builder<T> Constructs an instance of Field.Builder.

Method Summary

Modifier and Type	Method and Description
boolean	equals(java.lang.Object obj) Determines if the instance of Object provided is equal to the calling Field instance.
java.lang.String	getName() Retrieves the name describing the control.
java.lang.String	getTitle() Retrieves the textual annotation of a field.
FieldType	getType() Retrieves the input type of the field.
T	getValue() Retrieves the value assigned to the field.
int	hashCode() Generates hashcode represented as an integer for the calling Field instance.

Methods inherited from class java.lang.Object

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

Method Detail

equals

public boolean equals(java.lang.Object obj)

Determines if the instance of Object provided is equal to the calling Field instance.

Overrides:

equals in class java.lang.Object

Parameters:

obj - The instance of Field being examined.

Returns:

true if the instances are equal; false otherwise.

hashCode

public int hashCode()

Generates hashcode represented as an integer for the calling Field instance.

Overrides:

hashCode in class java.lang.Object

Returns:

The hashcode for the calling Field instance.

getName

public java.lang.String getName()

Retrieves the name describing the control. Field names MUST be unique within the set of fields for an action.

Returns:

The name describing the control. Field names MUST be unique within the set of fields for an action.

getType

public FieldType getType()

Retrieves the input type of the field.

Returns:

The input type of the field. This is a subset of the input types specified by HTML5.

getValue

public T getValue()

Retrieves the value assigned to the field.

Returns:

The value assigned to the field.

getTitle

public java.lang.String getTitle()

Retrieves the textual annotation of a field. Clients may use this as a label.

Returns:

Textual annotation of a field. Clients may use this as a label.