LiteralValueSource (Lucene 8.5.1 API)

java.lang.Object
- org.apache.lucene.queries.function.ValueSource
- - org.apache.lucene.queries.function.valuesource.LiteralValueSource

```
public class LiteralValueSource
extends ValueSource
```
Pass a the field value through as a String, no matter the type // Q: doesn't this mean it's a "string"?

Field Summary

Fields
Modifier and Type Field Description

protected BytesRef bytesRef

static int hash

protected String string

Constructor Summary

Constructors
Constructor Description

LiteralValueSource(String string)

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`String`	`description()`	description of field, used in explain()
`boolean`	`equals(Object o)`
`String`	`getValue()`	returns the literal value
`FunctionValues`	`getValues(Map context, LeafReaderContext readerContext)`	Gets the values for this reader and the context that was previously passed to createWeight().
`int`	`hashCode()`

Methods inherited from class org.apache.lucene.queries.function.ValueSource
asDoubleValuesSource, asLongValuesSource, createWeight, fromDoubleValuesSource, getSortField, newContext, toString

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- Field Detail
  - string
```
protected final String string
```
  - bytesRef
```
protected final BytesRef bytesRef
```
  - hash
```
public static final int hash
```
- Constructor Detail
  - LiteralValueSource
```
public LiteralValueSource(String string)
```
- Method Detail
  - getValue
```
public String getValue()
```
    returns the literal value
  - getValues
```
public FunctionValues getValues(Map context,
                                LeafReaderContext readerContext)
                         throws IOException
```
    Description copied from class: ValueSource
    
    Gets the values for this reader and the context that was previously passed to createWeight(). The values must be consumed in a forward docID manner, and you must call this method again to iterate through the values again.
    
    Specified by:
    
    getValues in class ValueSource
    
    Throws:
    
    IOException
  - description
```
public String description()
```
    Description copied from class: ValueSource
    
    description of field, used in explain()
    
    Specified by:
    
    description in class ValueSource
  - equals
```
public boolean equals(Object o)
```
    Specified by:
    
    equals in class ValueSource
  - hashCode
```
public int hashCode()
```
    Specified by:
    
    hashCode in class ValueSource