[MSHARED-1079] Improve Javadoc of MessageBuilder, add #build() and deprecate #toString()

• Type: Improvement
• Status: Closed
• Priority: Major
• Resolution: Fixed
• Affects Version/s: maven-shared-utils-3.3.4
• Fix Version/s: maven-shared-utils-3.4.0, maven-shared-utils-3.4.1
• Component/s: maven-shared-utils
• Assignee: Michael Osipov
• Reporter: Konrad Windszus
• Created: 08/Jun/22 12:03
• Updated: 30/Apr/23 20:14
• Resolved: 25/Jul/22 16:38

Description

It is not clear from the javadoc of MessageBuilder (https://maven.apache.org/shared/maven-shared-utils/apidocs/org/apache/maven/shared/utils/logging/MessageBuilder.html) that the toString() method is supposed to be called at the end to get the content's of the builder.
Please add JavaDoc for the toString method and in the best case add an explicit build method, which just calls toString internally.

Also it needs to be clarified if the MessageBuilder can be reused after toString has been called.

Issue Links

• relates to: MSHARED-562 add an API to create messages with consistent and configurable colors
• links to: GitHub Pull Request #96