BatchReadConfig (Apache Jackrabbit 2.23.1-beta API)

java.lang.Object
- org.apache.jackrabbit.spi2jcr.BatchReadConfig

```
public class BatchReadConfig
extends Object
```
BatchReadConfig defines if and how deep child item information should be retrieved, when accessing a Node. The configuration is based on node type names.

Field Summary

Fields
Modifier and Type Field Description

static int DEPTH_DEFAULT

static int DEPTH_INFINITE

Constructor Summary

Constructors
Constructor Description

BatchReadConfig()

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`int`	`getDepth(Name ntName)`	Return the depth for the given node type name.
`void`	`setDepth(Name ntName, int depth)`	Define the batch-read depth for the given node type name.

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

- Field Detail
  - DEPTH_DEFAULT
```
public static final int DEPTH_DEFAULT
```
    See Also:
    
    Constant Field Values
  - DEPTH_INFINITE
```
public static final int DEPTH_INFINITE
```
    See Also:
    
    Constant Field Values
- Constructor Detail
  - BatchReadConfig
```
public BatchReadConfig()
```
- Method Detail
  - getDepth
```
public int getDepth(Name ntName)
```
    Return the depth for the given node type name. If the name is not defined in this configuration, the default value is returned.
    
    Parameters:
    
    ntName -
    
    Returns:
    
    -1 If all child infos should be return or any value greater than 0 if only parts of the subtree should be returned. If the given nodetype name is not defined in this configuration, the default depth 0 will be returned.
  - setDepth
```
public void setDepth(Name ntName,
                     int depth)
```
    Define the batch-read depth for the given node type name.
    
    Parameters:
    
    ntName -
    
    depth -