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.
|
Field.Builder |
setTokenizedPrefix(java.lang.String tokenizedPrefix)
Sets a tokenized prefix value for the field.
|
Field.Builder |
setUntokenizedPrefix(java.lang.String untokenizedPrefix)
Sets an untokenized prefix value for the field.
|
Field.Builder |
setVector(java.util.List<java.lang.Double> vector)
Sets a vector value for the field.
|
public Field.Builder setName(java.lang.String name)
SearchApiLimits.FIELD_NAME_PATTERN
.name
- the name of the fieldjava.lang.IllegalArgumentException
- if the name or value is invalidpublic Field.Builder setText(java.lang.String text)
text
- the text value of the fieldjava.lang.IllegalArgumentException
- if the text is invalidpublic Field.Builder setHTML(java.lang.String html)
html
- the HTML value of the fieldjava.lang.IllegalArgumentException
- if the HTML is invalidpublic Field.Builder setAtom(java.lang.String atom)
atom
- the indivisible text of the fieldjava.lang.IllegalArgumentException
- if the atom is invalidpublic Field.Builder setDate(java.util.Date date)
date
- the date of the fieldjava.lang.IllegalArgumentException
- if the date is out of rangepublic Field.Builder setNumber(double number)
number
must be between
SearchApiLimits.MINIMUM_NUMBER_VALUE
and
SearchApiLimits.MAXIMUM_NUMBER_VALUE
.number
- the numeric value of the fieldjava.lang.IllegalArgumentException
- if the number is outside the valid rangepublic Field.Builder setGeoPoint(GeoPoint geoPoint)
GeoPoint
value for the field.geoPoint
- the GeoPoint
value of the fieldpublic Field.Builder setUntokenizedPrefix(java.lang.String untokenizedPrefix)
untokenizedPrefix
- the string value of the fieldjava.lang.IllegalArgumentException
- if the untokenized prefix field is invalidpublic Field.Builder setTokenizedPrefix(java.lang.String tokenizedPrefix)
tokenizedPrefix
- the string value of the fieldjava.lang.IllegalArgumentException
- if the tokenized prefix field is invalidpublic Field.Builder setVector(java.util.List<java.lang.Double> vector)
vector
- a list of Double values forming a vector field valuejava.lang.IllegalArgumentException
- if the vector field is invalidpublic Field.Builder setLocale(java.util.Locale locale)
locale
- the locale the field value is written in