TraversableNode.Companion.TraverseDescendantsAction


Tree traversal actions for the traverseDescendantsIf related functions:

  • Continue - continue the traversal

  • SkipSubtreeAndContinue - continue the traversal BUT skip the matching node's subtree (this is a rarer case)

  • CancelTraversal - cancels the traversal (returns from function call)

To see examples of all the actions, see TraversableModifierNodeTest. For a return/cancel example specifically, see traverseSubtreeWithSameKeyIf_cancelTraversalOfDifferentClassSameKey().

Summary

Public functions

TraversableNode.Companion.TraverseDescendantsAction
valueOf(value: String)

Returns the enum constant of this type with the specified name.

Cmn
Array<TraversableNode.Companion.TraverseDescendantsAction>

Returns an array containing the constants of this enum type, in the order they're declared.

Cmn

Public properties

EnumEntries<TraversableNode.Companion.TraverseDescendantsAction>

Returns a representation of an immutable list of all enum entries, in the order they're declared.

Cmn

Public functions

valueOf

fun valueOf(value: String): TraversableNode.Companion.TraverseDescendantsAction

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Throws
kotlin.IllegalArgumentException

if this enum type has no constant with the specified name

values

fun values(): Array<TraversableNode.Companion.TraverseDescendantsAction>

Returns an array containing the constants of this enum type, in the order they're declared.

This method may be used to iterate over the constants.

Public properties

entries

val entriesEnumEntries<TraversableNode.Companion.TraverseDescendantsAction>

Returns a representation of an immutable list of all enum entries, in the order they're declared.

This method may be used to iterate over the enum entries.