SpaceDescriptionUsernameExtractor (Atlassian Confluence 8.8.0 API)

java.lang.Object
- com.atlassian.confluence.impl.search.v2.extractor.SpaceDescriptionUsernameExtractor

All Implemented Interfaces:

Extractor2
```
public class SpaceDescriptionUsernameExtractor
extends Object
implements Extractor2
```
Adding the "username" field to SpaceDescription index documents will allow them to be sorted together with PersonalInformation documents in People Directory search. See com.atlassian.confluence.user.actions.PeopleDirectoryAction.search()

Since:

7.17

Constructor Summary

Constructors
Constructor Description

SpaceDescriptionUsernameExtractor()

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`Collection<FieldDescriptor>`	`extractFields(Object searchable)`	Extract fields from the searchable object.
`StringBuilder`	`extractText(Object searchable)`	Returns a buffer of text that will be appended onto the end of a larger buffer of text that will eventually become the searchable body text.

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

- Constructor Detail
  - SpaceDescriptionUsernameExtractor
```
public SpaceDescriptionUsernameExtractor()
```
- Method Detail
  - extractText
```
public StringBuilder extractText(Object searchable)
```
    Description copied from interface: Extractor2
    
    Returns a buffer of text that will be appended onto the end of a larger buffer of text that will eventually become the searchable body text.
    
    Specified by:
    
    extractText in interface Extractor2
    
    Parameters:
    
    searchable - a searchable object
    
    Returns:
    
    Returns a buffer of text that will be appended onto the end of a larger buffer of text that will eventually become the searchable body text.
  - extractFields
```
public Collection<FieldDescriptor> extractFields(Object searchable)
```
    Description copied from interface: Extractor2
    
    Extract fields from the searchable object.
    
    Specified by:
    
    extractFields in interface Extractor2
    
    Parameters:
    
    searchable - a searchable object
    
    Returns:
    
    list of fields extracted from the searchable object