StringFieldMapping (Atlassian Confluence 8.8.0 API)

java.lang.Object
- com.atlassian.confluence.plugins.index.api.mapping.AbstractFieldMapping
- - com.atlassian.confluence.plugins.index.api.mapping.StringFieldMapping

All Implemented Interfaces:

FieldMapping
```
public class StringFieldMapping
extends AbstractFieldMapping
```
Field mapping for keywords or non analyzed text.

Since:

8.6

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static class StringFieldMapping.Builder

Constructor Summary

Constructors
Modifier Constructor Description

protected StringFieldMapping(StringFieldMapping.Builder builder)

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`<T> T`	`accept(FieldMappingVisitor<T> visitor)`	Applies the supplied visitor to this field mapping with its respective callback.
`static StringFieldMapping.Builder`	`builder(String name)`
`FieldDescriptor`	`createField(String value)`	Create a field for the current mapping with the given value
`boolean`	`isAsLowercase()`	Indicate whether this field is a lowercase
`boolean`	`isWithLowercase()`	Indicate whether this field is a lowercase

Methods inherited from class com.atlassian.confluence.plugins.index.api.mapping.AbstractFieldMapping
equals, getName, hashCode, isIndexed, isStored, toString

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

- Constructor Detail
  - StringFieldMapping
```
protected StringFieldMapping(StringFieldMapping.Builder builder)
```
- Method Detail
  - createField
```
public FieldDescriptor createField(String value)
```
    Create a field for the current mapping with the given value
    
    Parameters:
    
    value -
    
    Returns:
    
    the newly created field
  - accept
```
public <T> T accept(FieldMappingVisitor<T> visitor)
```
    Description copied from interface: FieldMapping
    
    Applies the supplied visitor to this field mapping with its respective callback.
    
    Parameters:
    
    visitor - The visitor to dispatch
    
    Returns:
    
    The value that is returned by the supplied visitor
  - builder
```
public static StringFieldMapping.Builder builder(String name)
```
  - isAsLowercase
```
public boolean isAsLowercase()
```
    Indicate whether this field is a lowercase
    Only used by OpenSearch when handle LowercaseFieldSort
    
    Returns:
    
    whether this field is a lowercase
    
    Since:
    
    8.8
  - isWithLowercase
```
public boolean isWithLowercase()
```
    Indicate whether this field is a lowercase
    Only used by OpenSearch when handle LowercaseFieldSort
    
    Returns:
    
    whether this field is a lowercase
    
    Since:
    
    8.8