io.cdap.cdap.etl.api

Interface FailureCollector

@Beta
public interface FailureCollector

Failure collector is responsible to collect ValidationFailures.

Method Summary

Modifier and Type	Method and Description
default ValidationFailure	addFailure(String message, String correctiveAction) Add a validation failure to this failure collector.
default ValidationException	getOrThrowException() Throws validation exception if there are any failures that are added to the failure collector through addFailure(String, String).
default List<ValidationFailure>	getValidationFailures() Get list of validation failures.

Method Detail

addFailure

default ValidationFailure addFailure(String message,
                                     @Nullable
                                     String correctiveAction)

Add a validation failure to this failure collector. The method returns the validation failure that was added to the failure collector. This failure can be used to add additional ValidationFailure.Causes. For example, failureCollector.addFailure("message", "action").withConfigProperty("configProperty");

Parameters:

message - failure message

correctiveAction - corrective action

Returns:

a validation failure

Throws:

UnsupportedOperationException - if the implementation does not override this method

getOrThrowException

default ValidationException getOrThrowException()
                                         throws ValidationException

Throws validation exception if there are any failures that are added to the failure collector through addFailure(String, String). If no failures are added to the collector, it will return a ValidationException with empty failure list.

   String someMethod() {
   switch (someVar) {
     // cases
   }
   // if control comes here, it means failure
   failureCollector.addFailure(...);
   // throw validation exception so that compiler knows that exception is being thrown which eliminates the need to
   // have a statement that returns null towards the end of this method
   throw failureCollector.getOrThrowException();
 }
 

Returns:

returns a ValidationException if no failures were added to the collector

Throws:

ValidationException - exception indicating validation failures

UnsupportedOperationException - if the implementation does not override this method

getValidationFailures

default List<ValidationFailure> getValidationFailures()

Get list of validation failures.

Returns:

list of validation failures