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
-
Constructor Summary
Constructors Constructor Description FieldDescriptor(FieldMapping mapping, String value)
Construct a field with the given mapping and valueFieldDescriptor(FieldMapping mapping, String value, Object rawValue)
Construct a field with the given mapping, value and raw valueFieldDescriptor(String name, String value, FieldDescriptor.Store store, FieldDescriptor.Index index)
Deprecated.since 8.6.
-
Method Summary
All Methods Instance Methods Concrete Methods 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()
-
-
-
Field Detail
-
rawValue
protected Object rawValue
-
mapping
protected final FieldMapping mapping
-
value
protected final String value
-
-
Constructor Detail
-
FieldDescriptor
public FieldDescriptor(FieldMapping mapping, String value, Object rawValue)
Construct a field with the given mapping, value and raw value- Parameters:
mapping
-value
-
-
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. UseFieldDescriptor(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()
-
-