# NumberTree Class

> The number tree is a common data structure in PDF files.

- Product: Adobe PDF Library 18
- Language: Java
- Version: APDFL18.0.5PlusP2e
- HTML page: https://docs.datalogics.com/apdfl18/Java/APDFL18.0.5PlusP2e/class/NumberTree
- Version index: https://docs.datalogics.com/apdfl18/Java/APDFL18.0.5PlusP2e/llms.txt

```java
class NumberTree
```

**Namespace:** `com::datalogics::PDFL`

## Description

The number tree is a common data structure in PDF files. The number tree is a type of dictionary that can store many more pairs of matched records than a standard object dictionary.

A number tree uses keys that are integers to map to data objects, sorted in ascending numerical order.

**Referenced by:** [`Document`](https://docs.datalogics.com/apdfl18/Java/APDFL18.0.5PlusP2e/class/Document.md), [`NumberTree`](https://docs.datalogics.com/apdfl18/Java/APDFL18.0.5PlusP2e/class/NumberTree.md)

**Uses types:** [`Document`](https://docs.datalogics.com/apdfl18/Java/APDFL18.0.5PlusP2e/class/Document.md), [`NumberTree`](https://docs.datalogics.com/apdfl18/Java/APDFL18.0.5PlusP2e/class/NumberTree.md), [`PDFDict`](https://docs.datalogics.com/apdfl18/Java/APDFL18.0.5PlusP2e/class/PDFDict.md), [`PDFObject`](https://docs.datalogics.com/apdfl18/Java/APDFL18.0.5PlusP2e/class/PDFObject.md)

## Constructors

### NumberTree

```java
com.datalogics.PDFL.NumberTree.NumberTree(Document doc)
```

*constructor*

**Parameters**

- `doc` ([`Document`](https://docs.datalogics.com/apdfl18/Java/APDFL18.0.5PlusP2e/class/Document.md)): The Document in which to create the NumberTree.

Creates a new, empty NumberTree in the specified Document.

## Methods

### delete

```java
synchronized void com.datalogics.PDFL.NumberTree.delete(Boolean disposing)
```

*protected*

**Parameters**

- `disposing` (`Boolean`)

**Returns:** `synchronized void`

### delete

```java
synchronized void com.datalogics.PDFL.NumberTree.delete()
```

**Returns:** `synchronized void`

### equals

```java
boolean com.datalogics.PDFL.NumberTree.equals(Object rhs)
```

**Parameters**

- `rhs` (`Object`)

**Returns:** `boolean`

### finalize

```java
void com.datalogics.PDFL.NumberTree.finalize()
```

*protected*

**Returns:** `void`

### get

```java
PDFObject com.datalogics.PDFL.NumberTree.get(int key)
```

**Parameters**

- `key` (`int`): The integer key of the PDFObject to get from the tree.

**Returns:** [`PDFObject`](https://docs.datalogics.com/apdfl18/Java/APDFL18.0.5PlusP2e/class/PDFObject.md)

The PDFObject value corresponding to the supplied key.

Retrieves an entry from this NumberTree.

### getPDFDict

```java
PDFDict com.datalogics.PDFL.NumberTree.getPDFDict()
```

**Returns:** [`PDFDict`](https://docs.datalogics.com/apdfl18/Java/APDFL18.0.5PlusP2e/class/PDFDict.md)

The PDFDict representing the NumberTree's data structure.

Gets the underlying PDFDict of this NumberTree.

### put

```java
void com.datalogics.PDFL.NumberTree.put(int key, PDFObject value)
```

**Parameters**

- `key` (`int`): The integer of the PDFObject to put in the tree.
- `value` ([`PDFObject`](https://docs.datalogics.com/apdfl18/Java/APDFL18.0.5PlusP2e/class/PDFObject.md)): The PDFObject to be associated with key.

**Returns:** `void`

Puts a new entry in this NumberTree. If an entry with this name is already in the tree, it is replaced.

### remove

```java
void com.datalogics.PDFL.NumberTree.remove(int key)
```

**Parameters**

- `key` (`int`): The integer of the PDFObject to remove from the tree.

**Returns:** `void`

Removes the specified PDFObject from this NumberTree. It does nothing if no PDFObject of that number exists in this NumberTree.