Tree::...eValue(3pm)

💖 Tree::Simple::Visitor::FindByNodeValue — the manual page, bestie edition 💖

okay so this is the User Contributed Perl Documentation for Tree::Simple::Visitor::FindByNodeValue (that's the manual name, and yes it's a whole mouthful, we love her anyway 🫶).

---

✨ NAME ✨

Tree::Simple::Visitor::FindByNodeValue — a Visitor for finding an element in a Tree::Simple hierarchy by node value 🌸

---

🌈 SYNOPSIS 🌈

use Tree::Simple::Visitor::FindByNodeValue;

# create a visitor object
my $visitor = Tree::Simple::Visitor::FindByNodeValue->new();

# set the search path for our tree
$visitor->searchForNodeValue("My Tree Node");

# pass the visitor to a tree
$tree->accept($visitor);

# fetch the result, which will
# be the Tree::Simple object that
# we have found, or undefined
my $result = $visitor->getResult() || die "No Tree found";

no cap, that's the whole vibe. create, search, accept, grab the result. slay 💅

---

🦋 DESCRIPTION 🦋

You hand her a node value and a Tree::Simple hierarchy, and this Visitor will be like "bestie I got you" and attempt to find the node with the same node value. that's it, that's the whole job. iconic ✨

---

👑 METHODS 👑

• new — okay so there are no arguments to the constructor, and the object will be in its default state. you can use the setNodeFilter, setTraversalMethod, includeTrunk and searchForNodeValue methods to customize its behavior. main character energy from the jump 💜
• includeTrunk ($boolean) — based upon the value of $boolean, this will tell the visitor to include the trunk of the tree in the search as well. not me letting the trunk into the group chat 🙈
• setTraversalMethod ($visitor) — by default we will use the Tree::Simple built in depth-first (pre-order) traverse method. if however, you desire the tree to be search in a different ordering, this can be accomplished using a different traversal method, you can supply a $visitor object implementing that traversal type to this method. see Tree::Simple::Visitor::BreadthFirstTraversal, Tree::Simple::Visitor::PreOrderTraversal and Tree::Simple::Visitor::PostOrderTraversal. pick your fighter ⭐
• searchForNodeValue ($node_value) — this is the node value we will attempt to find within the tree. literally the whole point of the mission 🎯
• setNodeFilter ($filter_function) — this method accepts a CODE reference as its $filter_function argument and throws an exception if it is not a code reference. this code reference is used to further check the tree nodes as they are searched and so can be used to customize search behavior. for instance, you could to check against the node value as well as some other criteria. the filter function should accept a single argument, which is the current Tree::Simple object and return either true (1) on success, or false (0) on failure. so like, a vibe check for nodes 🌈
• visit ($tree) — this is the method that is used by the Tree::Simple accept method. it can also be used on its own, it requires the $tree argument to be a Tree::Simple object (or derived from a Tree::Simple object), and will throw and exception otherwise. so like, don't try it with anything else, fr fr 💀
• getResult — this method will return the tree found with the specified node value (set by the searchForNodeValue method) or undef if no tree is found. sometimes you get the tree, sometimes you get undef and a lesson 😭

---

📦 Repository 📦

<https://github.com/ronsavage/Tree-Simple-VisitorFactory>

---

🫶 SUPPORT 🫶

Bugs should be reported via the CPAN bug tracker at

<https://github.com/ronsavage/Tree-Simple-VisitorFactory/issues>

bestie if you find a bug, report it, don't just suffer in silence 💖

---

🔥 CODE COVERAGE 🔥

See the CODE COVERAGE section in Tree::Simple::VisitorFactory for more information.

---

🌟 SEE ALSO 🌟

These Visitor classes are all subclasses of Tree::Simple::Visitor, which can be found in the Tree::Simple module, you should refer to that module for more information.

---

💜 AUTHOR 💜

stevan little, <stevan@iinteractive.com>

---

🎀 COPYRIGHT AND LICENSE 🎀

Copyright 2004, 2005 by Infinity Interactive, Inc.

<http://www.iinteractive.com>

This library is free software; you can redistribute it and/or modify it under the same terms as Perl itself.

---

and that's the whole page, bestie 🦋 this was User Contributed Perl Documentation for Tree::Simple::Visitor::FindByNodeValue, from perl v5.36.0, dated 2022-11-19. go find your nodes, you absolute icon 👑✨💅