Package org.revapi.maven

Class AbstractSuggestionsBuilder

java.lang.Object

org.revapi.maven.AbstractSuggestionsBuilder

All Implemented Interfaces:

BuildTimeReporter.SuggestionsBuilder

Direct Known Subclasses:

JsonSuggestionsBuilder, XmlSuggestionsBuilder

public abstract class AbstractSuggestionsBuilder
extends Object
implements BuildTimeReporter.SuggestionsBuilder

A base class to BuildTimeReporter.SuggestionsBuilders that abstracts the walking of the differences and lets the subclasses only implement simple methods to output the suggestions in the given format.

Constructor Summary

Constructors

Constructor	Description
AbstractSuggestionsBuilder()

Method Summary

Modifier and Type	Method	Description
protected abstract void	appendDifferenceField(StringBuilder sb, String key, Object value)
protected abstract void	appendDifferenceFieldSeparator(StringBuilder sb)
String	build(List<org.revapi.Report> allProblems, BuildTimeReporter.SuggestionBuilderContext context)
protected abstract void	endDifference(StringBuilder sb)
protected abstract void	endOptionalAttachmentsInComment(StringBuilder sb)
protected abstract void	epilogue(StringBuilder sb)
protected abstract void	prologue(StringBuilder sb)
protected abstract void	startDifference(StringBuilder sb)
protected abstract void	startOptionalAttachmentsInComment(StringBuilder sb, String text)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

AbstractSuggestionsBuilder

public AbstractSuggestionsBuilder()

Method Detail

appendDifferenceField

protected abstract void appendDifferenceField(StringBuilder sb,
                                              String key,
                                              Object value)

appendDifferenceFieldSeparator

protected abstract void appendDifferenceFieldSeparator(StringBuilder sb)

prologue

protected abstract void prologue(StringBuilder sb)

startDifference

protected abstract void startDifference(StringBuilder sb)

endDifference

protected abstract void endDifference(StringBuilder sb)

startOptionalAttachmentsInComment

protected abstract void startOptionalAttachmentsInComment(StringBuilder sb,
                                                          String text)

endOptionalAttachmentsInComment

protected abstract void endOptionalAttachmentsInComment(StringBuilder sb)

epilogue

protected abstract void epilogue(StringBuilder sb)

build

public String build(List<org.revapi.Report> allProblems,
                    BuildTimeReporter.SuggestionBuilderContext context)

Specified by:

build in interface BuildTimeReporter.SuggestionsBuilder