Package com.atlassian.confluence.plugins.index.api

Class FieldDescriptor

java.lang.Object

com.atlassian.confluence.plugins.index.api.FieldDescriptor

Direct Known Subclasses:

DocValuesFieldDescriptor, DoubleFieldDescriptor, FloatFieldDescriptor, IntFieldDescriptor, LongFieldDescriptor, NumericDocValuesFieldDescriptor, SortedDocValuesFieldDescriptor, StoredFieldDescriptor, StringFieldDescriptor, TextFieldDescriptor

@Internal
public class FieldDescriptor
extends Object

Represents an index field.

Since:

7.17

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	FieldDescriptor.Index	Deprecated.
static class	FieldDescriptor.Store

Field Summary

Fields

Modifier and Type	Field	Description
protected FieldMapping	mapping
protected String	value

Constructor Summary

Constructors

Constructor	Description
FieldDescriptor(FieldMapping mapping, String value)	Construct a field with the given mapping and value
FieldDescriptor(String name, String value, FieldDescriptor.Store store, FieldDescriptor.Index index)	Deprecated. since 8.6.

Method Summary

Modifier and Type	Method	Description
<T> T	accept(FieldVisitor<T> fieldVisitor)
boolean	equals(Object o)
FieldDescriptor.Index	getIndex()
FieldMapping	getMapping()
String	getName()
Object	getRawValue()
FieldDescriptor.Store	getStore()
String	getValue()
int	hashCode()

Methods inherited from class java.lang.Object

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

Field Detail

mapping

protected final FieldMapping mapping

value

protected final String value

Constructor Detail

FieldDescriptor

public FieldDescriptor(FieldMapping mapping,
                       String value)

Construct a field with the given mapping and value

Parameters:

mapping -

value -

FieldDescriptor

@Deprecated
public FieldDescriptor(String name,
                       String value,
                       FieldDescriptor.Store store,
                       FieldDescriptor.Index index)

Deprecated.

since 8.6. Use FieldDescriptor(FieldMapping, String) instead.

Construct a field with the given value and mapping properties

Parameters:

name -

value -

store -

index -

Method Detail

accept

public <T> T accept(FieldVisitor<T> fieldVisitor)

getRawValue

public Object getRawValue()

Returns:

the raw Java value of this field before formatted into a string

Since:

8.6

getMapping

public FieldMapping getMapping()

getName

public String getName()

getValue

public String getValue()

getIndex

public FieldDescriptor.Index getIndex()

getStore

public FieldDescriptor.Store getStore()

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object