org.eth.cyril.interactive

Class ExpansionDepth

java.lang.Object

org.eth.cyril.interactive.ExpansionDepth

All Implemented Interfaces:

JsonSerializable

public class ExpansionDepth
extends java.lang.Object
implements JsonSerializable

Depth of expansion. This depth should be used to record the last depth for each value. The following possibilities exist: - forceExpand: Expands up to a given depth, doesn't stop at blocks. - expand: Expands up to a given depth, always stops at blocks however. - block: Still visualizes the current value, but doesn't let expansion pass through, except for force expansion. - none: Doesn't perform any expansion, doesn't visualize the current value.

Method Summary

Modifier and Type	Method and Description
static ExpansionDepth	block() Blocks expansion unless forcefully removed.
static ExpansionDepth	expand(int depth) Depth to expand a given number of levels.
static ExpansionDepth	expandAll() Depth to expand all levels.
static ExpansionDepth	forceExpand(int depth) Depth to expand a given number of levels forcefully.
static ExpansionDepth	forceExpandAll() Depth to expand all levels forcefully.
int	getDepth() Returns the expansion depth.
ExpansionDepth	getForNextDepth(ExpansionDepth parentDepth) Gets the depth to use at the next step, based on the current depth and the parent depth.
ExpansionDepth	getForStorage(ExpansionDepth previous) Get the depth suited for storage.
boolean	isAll() Returns whether this depth expands all.
boolean	isBlock() Returns whether this depth is a block.
boolean	isDeeperThan(ExpansionDepth other) Returns whether this depth is deeper than the other, irregardless of forcing status.
boolean	isExpanded() Returns whether this depth is expanded.
boolean	isForce() Returns whether this depth forces expansion.
boolean	isNone() Returns whether this depth does not expand at all.
static ExpansionDepth	none() Depth to not expand anything.
ExpansionDepth	unforce() Unforces the expansion depth for storage.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.eth.cyril.util.serialization.JsonSerializable

fromJson, toJson

Method Detail

forceExpandAll

public static ExpansionDepth forceExpandAll()

Depth to expand all levels forcefully. Forceful expansion will break blocks.

forceExpand

public static ExpansionDepth forceExpand(int depth)

Depth to expand a given number of levels forcefully. Forceful expansion will break blocks.

Parameters:

depth - The number of levels to expand. Must be at least 0.

expandAll

public static ExpansionDepth expandAll()

Depth to expand all levels. Will not break blocks.

expand

public static ExpansionDepth expand(int depth)

Depth to expand a given number of levels. Will not break blocks.

Parameters:

depth - The number of levels to expand. Must be at least 0.

none

public static ExpansionDepth none()

Depth to not expand anything. Visiting heap elements should stop whenever encountering this.

block

public static ExpansionDepth block()

Blocks expansion unless forcefully removed. A block is essentially equal to "depth(0)", with the exception that any higher depth is stopped from passing through the block.

getForNextDepth

public ExpansionDepth getForNextDepth(ExpansionDepth parentDepth)

Gets the depth to use at the next step, based on the current depth and the parent depth. If the parent is force, and still has depth left, it will always return that depth (minus 1, if it doesn't expand all). If the parent is not force, and the current is a block, none is returned. Otherwise, the furthest depth of the two is returned, or none if neither has depth left. Assumes that the parent is not a block, and that the current depth is not a force.

Parameters:

parentDepth - The parent depth to use.

Returns:

The depth to use at the next level.

unforce

public ExpansionDepth unforce()

Unforces the expansion depth for storage. Force expansion should typically not be stored.

getForStorage

public ExpansionDepth getForStorage(ExpansionDepth previous)

Get the depth suited for storage. The resulting depth will not be forced. Blocks will be kept unless this depth is forced. If the two depths are both expanding, the deeper depth is returned, but always unforced.

Parameters:

previous - The previous depth which was stored.

Returns:

isDeeperThan

public boolean isDeeperThan(ExpansionDepth other)

Returns whether this depth is deeper than the other, irregardless of forcing status.

Parameters:

other - The other depth.

Returns:

True iff this depth is deeper than the other, thus expanding more levels.

isBlock

public boolean isBlock()

Returns whether this depth is a block.

isForce

public boolean isForce()

Returns whether this depth forces expansion.

isNone

public boolean isNone()

Returns whether this depth does not expand at all.

isAll

public boolean isAll()

Returns whether this depth expands all.

Returns:

isExpanded

public boolean isExpanded()

Returns whether this depth is expanded. In this sense, anything which doesn't expand at least one further level is not expanded, even if the current node might be visible

getDepth

public int getDepth()

Returns the expansion depth. This value is only meaningful if the expansion was created by expand(int) or forceExpand(int) and returns that given depth. If any of isAll() or isNone() or isBlock() returns true, this value is meaningless.