Package io.objectbox.config

Class TreeOptionFlags

java.lang.Object

io.objectbox.config.TreeOptionFlags

public final class TreeOptionFlags
extends Object

Options flags for trees.

Field Summary

Fields

Modifier and Type	Field	Description
static final int	AllowNonUniqueNodes	In some scenarios, e.g.
static final int	AutoConsolidateNonUniqueNodes	Nodes described in AllowNonUniqueNodes will be automatically consolidated to make them unique.
static final int	DebugLogsDisable	If true, debug logs are always disabled for this tree regardless of the store's debug flags.
static final int	DebugLogsEnable	If true, debug logs are always enabled for this tree regardless of the store's debug flags.
static final int	DetectNonUniqueNodes	Nodes described in AllowNonUniqueNodes will be automatically detected to consolidate them (manually).
static final int	EnforceUniquePath	By default, a path such as "a/b/c" can address a branch and a leaf at the same time.

Method Summary

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

DebugLogsDisable

public static final int DebugLogsDisable

If true, debug logs are always disabled for this tree regardless of the store's debug flags.

See Also:

• Constant Field Values

DebugLogsEnable

public static final int DebugLogsEnable

If true, debug logs are always enabled for this tree regardless of the store's debug flags.

See Also:

• Constant Field Values

EnforceUniquePath

public static final int EnforceUniquePath

By default, a path such as "a/b/c" can address a branch and a leaf at the same time. E.g. under the common parent path "a/b", a branch "c" and a "c" leaf may exist. To disable this, set this flag to true. This will enable an additional check when inserting new leafs and new branches for the existence of the other.

See Also:

• Constant Field Values

AllowNonUniqueNodes

public static final int AllowNonUniqueNodes

In some scenarios, e.g. when using Sync, multiple node objects of the same type (e.g. branch or leaf) at the same path may exist temporarily. By enabling this flag, this is not considered an error situation. Instead, the first node is picked.

See Also:

• Constant Field Values

DetectNonUniqueNodes

public static final int DetectNonUniqueNodes

Nodes described in AllowNonUniqueNodes will be automatically detected to consolidate them (manually).

See Also:

• Constant Field Values

AutoConsolidateNonUniqueNodes

public static final int AutoConsolidateNonUniqueNodes

Nodes described in AllowNonUniqueNodes will be automatically consolidated to make them unique. This consolidation happens e.g. on put/remove operations. Using this value implies DetectNonUniqueNodes.

See Also:

• Constant Field Values