siren

Class FieldValue<T>

java.lang.Object

siren.FieldValue<T>

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

Value objects represent multiple selectable field values. Use in conjunction with field `"type" = "radio"` and `"type" = "checkbox"` to express that zero, one or many out of several possible values may be sent back to the server.

Since:

8/13/17

Author:

jonfreer

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	FieldValue.Builder<T> Constructs an instance of FieldValue.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 FieldValue instance.
java.lang.Boolean	getSelected() Retrieves whether this value should be considered preselected.
java.lang.String	getTitle() Retrieves the textual description of a field value.
T	getValue() Retrieves the value for the field.
int	hashCode() Generates hashcode represented as an integer for the calling FieldValue 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 FieldValue instance.

Overrides:

equals in class java.lang.Object

Parameters:

obj - The instance of FieldValue being examined.

Returns:

true if the instances are equal; false otherwise.

hashCode

public int hashCode()

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

Overrides:

hashCode in class java.lang.Object

Returns:

The hashcode for the calling FieldValue instance.

getTitle

public java.lang.String getTitle()

Retrieves the textual description of a field value.

Returns:

The textual description of a field value.

getValue

public T getValue()

Retrieves the value for the field.

Returns:

The value for the field.

getSelected

public java.lang.Boolean getSelected()

Retrieves whether this value should be considered preselected.

Returns:

Indicates whether this value should be considered preselected.