CustomFieldsVisitor (elasticsearch-extend 3.2 API)

java.lang.Object
- org.apache.lucene.index.StoredFieldVisitor
- - org.elasticsearch.index.fieldvisitor.FieldsVisitor
  - - org.elasticsearch.index.fieldvisitor.CustomFieldsVisitor

```
public class CustomFieldsVisitor
extends FieldsVisitor
```
A field visitor that allows to load a selection of the stored fields by exact name or by pattern. Supported pattern styles: "xxx*", "*xxx", "*xxx*" and "xxx*yyy". The Uid field is always loaded. The class is optimized for source loading as it is a common use case.

- Nested Class Summary
  - Nested classes/interfaces inherited from class org.apache.lucene.index.StoredFieldVisitor
    StoredFieldVisitor.Status
- Field Summary
  - Fields inherited from class org.elasticsearch.index.fieldvisitor.FieldsVisitor
    fieldsValues, id, source, type
- Constructor Summary
  
  Constructors
  Constructor Description
  
  CustomFieldsVisitor(Set<String> fields, boolean loadSource)
- Method Summary
  
  All Methods Instance Methods Concrete Methods
  Modifier and Type Method Description
  
  StoredFieldVisitor.Status needsField(FieldInfo fieldInfo)
  Hook before processing a field.
  - Methods inherited from class org.elasticsearch.index.fieldvisitor.FieldsVisitor
    binaryField, doubleField, fields, floatField, intField, longField, postProcess, reset, routing, source, stringField, uid
  - Methods inherited from class java.lang.Object
    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - CustomFieldsVisitor
```
public CustomFieldsVisitor(Set<String> fields,
                           boolean loadSource)
```
- Method Detail
  - needsField
```
public StoredFieldVisitor.Status needsField(FieldInfo fieldInfo)
                                     throws IOException
```
    Description copied from class: StoredFieldVisitor
    
    Hook before processing a field. Before a field is processed, this method is invoked so that subclasses can return a StoredFieldVisitor.Status representing whether they need that particular field or not, or to stop processing entirely.
    
    Overrides:
    
    needsField in class FieldsVisitor
    
    Throws:
    
    IOException