Skip to content

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

@jira-importer

Description

@jira-importer

Konrad Windszus opened MSHARED-1079 and commented

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.


Affects: maven-shared-utils-3.3.4

Issue Links:

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

Remote Links:

Backported to: maven-shared-utils-3.4.0

Metadata

Metadata

Assignees

Labels

Type

No type

Projects

No projects

Relationships

None yet

Development

No branches or pull requests

Issue actions