com.atlassian.confluence.api.model.search.autocomplete

Class AutocompleteResultItem

java.lang.Object

com.atlassian.confluence.api.model.search.autocomplete.AutocompleteResultItem

@ExperimentalApi
public class AutocompleteResultItem
extends Object

Represents the internal and displayed state of a single autocomplete result in an AutocompleteResult.

Since:

5.9

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	AutocompleteResultItem.Builder

Method Summary

Modifier and Type	Method and Description
static AutocompleteResultItem.Builder	builder()
String	getId() Returns the item "id" or "key" that will be passed around programmatically if this item is selected by a user in the UI.
String	getText() Returns the string representation of this item that the user will see in the UI.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

builder

public static AutocompleteResultItem.Builder builder()

getId

public String getId()

Returns the item "id" or "key" that will be passed around programmatically if this item is selected by a user in the UI. It is expected to be unique in the enclosing AutocompleteResult.

Returns:

the internal value of the item

getText

public String getText()

Returns the string representation of this item that the user will see in the UI.

Returns:

the displayable value of the item