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

Log inSkip to main contentSkip to sidebar

• Dashboards

• Projects

• Issues

• Help

  • Jira Core help
  • Keyboard Shortcuts
  • About Jira
  • Jira Credits

• Log In

Public signup for this instance is disabled. Go to our Self serve sign up page to request an account. Report potential security issues privately

1. Maven Shared Components
2. MSHARED-1079

Log In

Export

XMLWordPrintableJSON

Details

• 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
• Labels:
  None

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.

Attachments

Issue Links

relates to

MSHARED-562 add an API to create messages with consistent and configurable colors

• 
• Closed

links to

GitHub Pull Request #96

GitHub Pull Request #328

Activity

People

Assignee:

Michael Osipov

Reporter:

Konrad Windszus

Votes:

0 Vote for this issue

Watchers:

5 Start watching this issue

Dates

Created:

08/Jun/22 12:03

Updated:

03/Jul/25 08:43

Resolved:

25/Jul/22 16:38