Class Description.Builder

java.lang.Object

com.google.errorprone.matchers.Description.Builder

Enclosing class:

Description

public static class Description.Builder
extends Object

Builder for Descriptions.

Author:

alexeagle@google.com (Alex Eagle)

Method Summary

Modifier and Type	Method	Description
Description.Builder	addAllFixes(List<? extends Fix> fixes)	Add each fix in order.
Description.Builder	addFix(Fix fix)	Adds a suggested fix for this Description.
Description.Builder	addFix(Optional<? extends Fix> fix)	Deprecated. prefer referring to empty fixes using SuggestedFix.emptyFix().
Description	build()
Description.Builder	overrideSeverity(BugPattern.SeverityLevel severity)
Description.Builder	setLinkUrl(String linkUrl)	Set a custom link URL.
Description.Builder	setMessage(String message)	Set a custom error message for this Description.

Methods inherited from class java.lang.Object

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

Method Details

addFix

@CanIgnoreReturnValue
public Description.Builder addFix(Fix fix)

Adds a suggested fix for this Description. Fixes should be added in order of decreasing preference. Adding an empty fix is a no-op.

Parameters:

fix - a suggested fix for this problem

Throws:

NullPointerException - if fix is null

addFix

@CanIgnoreReturnValue
@Deprecated
public Description.Builder addFix(Optional<? extends Fix> fix)

Deprecated.

prefer referring to empty fixes using SuggestedFix.emptyFix().

Adds a suggested fix for this Description if fix is present. Fixes should be added in order of decreasing preference. Adding an empty fix is a no-op.

Parameters:

fix - a suggested fix for this problem

Throws:

NullPointerException - if fix is null

addAllFixes

@CanIgnoreReturnValue
public Description.Builder addAllFixes(List<? extends Fix> fixes)

Add each fix in order.

Parameters:

fixes - a list of suggested fixes for this problem

Throws:

NullPointerException - if fixes or any of its elements are null

setMessage

@CanIgnoreReturnValue
public Description.Builder setMessage(String message)

Set a custom error message for this Description. The custom message will be used instead of the summary field as the text for the diagnostic message.

Parameters:

message - A custom error message without the check name ("[checkname]") or link

setLinkUrl

@CanIgnoreReturnValue
public Description.Builder setLinkUrl(String linkUrl)

Set a custom link URL. The custom URL will be used instead of the default one which forms part of the @BugPattern.

overrideSeverity

@CanIgnoreReturnValue
public Description.Builder overrideSeverity(BugPattern.SeverityLevel severity)

build

public Description build()