TreeFilterDefinition (Red Hat JBoss Enterprise Application Platform 8.0.0.GA public API)

java.lang.Object
- org.hibernate.search.engine.common.tree.TreeFilterDefinition

public final class TreeFilterDefinition
extends Object

Constructor Summary

Constructors
Constructor Description

TreeFilterDefinition(Integer includeDepth, Set<String> includePaths, Set<String> excludePaths)

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`boolean`	`equals(Object o)`
`Set<String>`	`excludePaths()`
`int`	`hashCode()`
`static TreeFilterDefinition`	`includeAll()`
`Integer`	`includeDepth()`
`Set<String>`	`includePaths()`

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

- Constructor Detail
  - TreeFilterDefinition
```
public TreeFilterDefinition(Integer includeDepth,
                            Set<String> includePaths,
                            Set<String> excludePaths)
```
    Parameters:
    
    includeDepth - The maximum depth beyond which all created fields will be ignored. null for no limit.
    
    includePaths - The exhaustive list of paths of fields that are to be included. null for no limit. Cannot be used with a non-empty excludePaths.
    
    excludePaths - The list of paths of fields that are to be excluded. null for no exclusion. Cannot be used with a non-empty includePaths.
- Method Detail
  - includeAll
```
public static TreeFilterDefinition includeAll()
```
  - equals
```
public boolean equals(Object o)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - includePaths
```
public Set<String> includePaths()
```
  - excludePaths
```
public Set<String> excludePaths()
```
  - includeDepth
```
public Integer includeDepth()
```