com.facebook.buck.core.exceptions

Class HumanReadableExceptionAugmentor

java.lang.Object

com.facebook.buck.core.exceptions.HumanReadableExceptionAugmentor

public class HumanReadableExceptionAugmentor
extends Object

A class that can append additional information to a HumanReadableException based on configuration settings. This can be useful, e.g., when there's a common parse error whose cause is not immediately visible.

Constructor Summary

Constructors

Constructor and Description
HumanReadableExceptionAugmentor(Map<Pattern,String> augmentations) Create an instance of HumanReadableExceptionAugmentor

Method Summary

Modifier and Type	Method and Description
String	getAugmentedError(String humanReadableErrorMessage) Adds messages to the end of an existing error message based on regular expressions provided in .buckconfig.

Methods inherited from class java.lang.Object

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

Constructor Detail

HumanReadableExceptionAugmentor

public HumanReadableExceptionAugmentor(Map<Pattern,String> augmentations)

Create an instance of HumanReadableExceptionAugmentor

Parameters:

augmentations - A mapping of regexes to the replacement strings to append to the end of error messages

Method Detail

getAugmentedError

public String getAugmentedError(String humanReadableErrorMessage)

Adds messages to the end of an existing error message based on regular expressions provided in .buckconfig.

If replacement fails (due to a configuration error, such as invalid regex), then a warning will be added to the returned message

Returns:

The original error message, with any error augmentations that this message matches appended to the end