java.lang.Object
- java.lang.Enum<HitField>
- - com.logicaldoc.core.searchengine.HitField

All Implemented Interfaces:

Serializable, Comparable<HitField>
```
public enum HitField
extends Enum<HitField>
```
Models the field names that can be stored in the index

Since:

6.5

Author:

Marco Meschieri - LogicalDOC

Enum Constant Summary

Enum Constants
Enum Constant	Description
`COMMENT`
`CONTENT`
`CREATION`
`CUSTOM_ID`
`DATE`
`DOC_REF`
`FILENAME`
`FOLDER_ID`
`FOLDER_NAME`
`ID`
`LANGUAGE`
`NOTES`
`SIZE`
`TAGS`
`TEMPLATE_ID`
`TENANT_ID`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`static Set<HitField>`	`all()`
`String`	`getName()`
`static String`	`searchList()`	HitField list suitable for searches
`String`	`toString()`
`static HitField`	`valueOf(String name)`	Returns the enum constant of this type with the specified name.
`static HitField[]`	`values()`	Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum
compareTo, equals, getDeclaringClass, hashCode, name, ordinal, valueOf

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

- Enum Constant Detail
  - ID
```
public static final HitField ID
```
  - FILENAME
```
public static final HitField FILENAME
```
  - FOLDER_ID
```
public static final HitField FOLDER_ID
```
  - CONTENT
```
public static final HitField CONTENT
```
  - TAGS
```
public static final HitField TAGS
```
  - TEMPLATE_ID
```
public static final HitField TEMPLATE_ID
```
  - FOLDER_NAME
```
public static final HitField FOLDER_NAME
```
  - CREATION
```
public static final HitField CREATION
```
  - DATE
```
public static final HitField DATE
```
  - SIZE
```
public static final HitField SIZE
```
  - CUSTOM_ID
```
public static final HitField CUSTOM_ID
```
  - DOC_REF
```
public static final HitField DOC_REF
```
  - COMMENT
```
public static final HitField COMMENT
```
  - LANGUAGE
```
public static final HitField LANGUAGE
```
  - TENANT_ID
```
public static final HitField TENANT_ID
```
  - NOTES
```
public static final HitField NOTES
```
- Method Detail
  - values
```
public static HitField[] values()
```
    Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:
    for (HitField c : HitField.values()) System.out.println(c);
    Returns:
    
    an array containing the constants of this enum type, in the order they are declared
  - valueOf
```
public static HitField valueOf(String name)
```
    Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)
    
    Parameters:
    
    name - the name of the enum constant to be returned.
    
    Returns:
    
    the enum constant with the specified name
    
    Throws:
    
    IllegalArgumentException - if this enum type has no constant with the specified name
    
    NullPointerException - if the argument is null
  - getName
```
public String getName()
```
  - all
```
public static Set<HitField> all()
```
  - searchList
```
public static String searchList()
```
    HitField list suitable for searches
    
    Returns:
    
    list of fields in a single string representation
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Enum<HitField>

Enum HitField

Enum Constant Summary

Method Summary

Methods inherited from class java.lang.Enum

Methods inherited from class java.lang.Object

Enum Constant Detail

ID

FILENAME

FOLDER_ID

CONTENT

TAGS

TEMPLATE_ID

FOLDER_NAME

CREATION

DATE

SIZE

CUSTOM_ID

DOC_REF

COMMENT

LANGUAGE

TENANT_ID

NOTES

Method Detail

values

valueOf

getName

all

searchList

toString