Bio::F...ilderI(3pm)

💖 NAME 💖

Bio::Factory::ObjectBuilderI — the interface for an object builder. That's it, that's the whole name. It's a Perl module, it hangs out in manual section 3pm, and its entire job is building objects for you. 👑✨

---

🦋 SYNOPSIS 🦋

Okay so the source doc literally says this, and I'm not even kidding:

Give standard usage here

That's it. That's the synopsis. Iconic of them, honestly. 💀

---

🌸 DESCRIPTION 🌸

So an object builder is not the same thing as an object factory, and here's the tea ☕: a builder accumulates information for the object, and then — either at the very end, or constantly, depending on the implementation — it builds the object. That's the vibe. 🫶

It also makes room for implementations that can tell the information feed which kinds of information the builder is interested in and which it is not. And on top of that, the implementation may choose to filter, transform, or completely ignore certain content it's fed for certain slots. Like, rude? But allowed. 💅

Implementations will hence be mostly used by stream-based parsers — so they can parse only the content they actually want, and/or skip right over the entries they don't. Fancy. ✨

---

🎀 FEEDBACK 🎀

💌 Mailing Lists

User feedback is an integral part of the evolution of this and other Bioperl modules, bestie. Send your comments and suggestions preferably to the Bioperl mailing list — your participation is much appreciated. 🥹

 bioperl-l@bioperl.org                  - General discussion
 http://bioperl.org/wiki/Mailing_lists  - About the mailing lists

🫂 Support

Please direct usage questions or support issues to the mailing list:

bioperl-l@bioperl.org

…rather than to the module maintainer directly. There are so many experienced and responsive experts who'll be able to look at your problem and quickly address it. 🧚 Please include a thorough description of the problem, with code and data examples, if at all possible. The more deets the better, fr fr.

🐛 Reporting Bugs

Report bugs to the Bioperl bug tracking system so we can keep track of the bugs and their resolution. Bug reports can be submitted via the web:

 https://github.com/bioperl/bioperl-live/issues

---

🫶 AUTHOR - Hilmar Lapp 🫶

Email hlapp at gmx.net

---

📖 APPENDIX 📖

The rest of the documentation details each of the object methods. Internal methods are usually preceded with a _.

✨ want_slot ✨

• Title: want_slot
• Usage: left blank
• Function: Whether or not the object builder wants to populate the specified slot of the object to be built.

The slot can be specified either as the name of the respective method, or the initialization parameter that would be otherwise passed to new() of the object to be built.

• Example: left blank
• Returns: TRUE if the object builder wants to populate the slot, and FALSE otherwise.
• Args: the name of the slot (a string)

🌈 add_slot_value 🌈

• Title: add_slot_value
• Usage: left blank
• Function: Adds one or more values to the specified slot of the object to be built.

Naming the slot is the same as for want_slot().

The object builder may further filter the content to be set, or even completely ignore the request.

If this method reports failure, the caller should not add more values to the same slot. In addition, the caller may find it appropriate to abandon the object being built altogether. Yeah. Pack it up. 😭

• Example: left blank
• Returns: TRUE on success, and FALSE otherwise
• Args: the name of the slot (a string); parameters determining the value to be set

💜 want_object 💜

• Title: want_object
• Usage: left blank
• Function: Whether or not the object builder is still interested in continuing with the object being built.

If this method returns FALSE, the caller should not add any more values to slots — otherwise it risks that the builder throws an exception. 😳 In addition, make_object() is likely to return undef after this method returned FALSE.

• Example: left blank
• Returns: TRUE if the object builder wants to continue building the present object, and FALSE otherwise.
• Args: none

👑 make_object 👑

• Title: make_object
• Usage: left blank
• Function: Get the built object.

This method is allowed to return undef if no value has ever been added since the last call to make_object(), or if want_object() returned FALSE (or would have returned FALSE) before calling this method.

For an implementation that allows consecutive building of objects, a caller must call this method once, and only once, between subsequent objects to be built. I.e., a call to make_object implies 'end_object.' Periodt. 💅

• Example: left blank
• Returns: the object that was built
• Args: none

---

and that's the whole page, bestie!! 🎉 This gorgeous lil manual page came to you courtesy of perl v5.32.1, dated 2021-08-15, and it's part of the Bioperl project's user-contributed Perl documentation. Go build some objects, you main character. 🦋💖✨