[LUCENE-9424] Have a warning comment for AttributeSource.captureState

• Type: Improvement
• Status: Closed
• Priority: Trivial
• Resolution: Fixed
• Fix Version/s: 9.0, 8.7
• Component/s: general/javadocs
• Lucene Fields: New
• Assignee: Unassigned
• Reporter: Patrick Zhai
• Created: 09/Jul/20 19:50
• Updated: 28/Aug/22 16:04
• Resolved: 27/Jul/20 15:19

Description

AttributeSource.captureState is a powerful method that can be used to store and (later on) restore the current state, but it comes with a cost of copying all attributes in this source and sometimes can be a big cost if called multiple times.

We could probably add a warning to indicate this cost, as this method is encapsulated quite well and sometimes people who use it won't be aware of the cost.