public static final class Field.Builder
extends java.lang.Object
Modifier and Type | Method and Description |
---|---|
Field
|
build
()
Builds a field using this builder.
|
Field.Builder
|
setAtom
(java.lang.String atom)
Sets an atomic value, indivisible text, for the field.
|
Field.Builder
|
setDate
(java.util.Date date)
Sets a date associated with the field.
|
Field.Builder
|
setGeoPoint
(
GeoPoint
geoPoint)
Sets a
GeoPoint
value for the field.
|
Field.Builder
|
setHTML
(java.lang.String html)
Sets a HTML value for the field.
|
Field.Builder
|
setLocale
(java.util.Locale locale)
Sets the Locale of the field value.
|
Field.Builder
|
setName
(java.lang.String name)
Sets a name for the field.
|
Field.Builder
|
setNumber
(double number)
Sets a numeric value for the field.
|
Field.Builder
|
setText
(java.lang.String text)
Sets a text value for the field.
|
public Field.Builder setName(java.lang.String name)
SearchApiLimits.FIELD_NAME_PATTERN
.
name
- the name of the field
java.lang.IllegalArgumentException
- if the name or value is invalid
public Field.Builder setText(java.lang.String text)
text
- the text value of the field
java.lang.IllegalArgumentException
- if the text is invalid
public Field.Builder setHTML(java.lang.String html)
html
- the HTML value of the field
java.lang.IllegalArgumentException
- if the HTML is invalid
public Field.Builder setAtom(java.lang.String atom)
atom
- the indivisible text of the field
java.lang.IllegalArgumentException
- if the atom is invalid
public Field.Builder setDate(java.util.Date date)
date
- the date of the field
java.lang.IllegalArgumentException
- if the date is out of range
public Field.Builder setNumber(double number)
number
must be between
SearchApiLimits.MINIMUM_NUMBER_VALUE
and
SearchApiLimits.MAXIMUM_NUMBER_VALUE
.
number
- the numeric value of the field
java.lang.IllegalArgumentException
- if the number is outside the valid range
public Field.Builder setGeoPoint(GeoPoint geoPoint)
GeoPoint
value for the field.
geoPoint
- the
GeoPoint
value of the field
public Field.Builder setLocale(java.util.Locale locale)
locale
- the locale the field value is written in