com.uber.rave

Class RaveError

java.lang.Object

com.uber.rave.RaveError

public final class RaveError
extends java.lang.Object

Holds a single Rave error. This generally will be validation failure.

Constructor Summary

Constructors

Constructor and Description
RaveError(BaseValidator.ValidationContext validationContext, java.lang.String errorMsg)
RaveError(java.lang.Class<?> clazz, java.lang.String item, java.lang.String errorMsg)

Method Summary

Modifier and Type	Method and Description
java.lang.String	getClassElement() This method returns the description of what element in the class failed validation, for example the method name.
java.lang.Class<?>	getClazz()
java.lang.String	getErrorMsg()
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

RaveError

public RaveError(java.lang.Class<?> clazz,
                 java.lang.String item,
                 java.lang.String errorMsg)

Parameters:

clazz - the inner most Class that failed validation.

item - the name of the item that failed validation such as the method name.

errorMsg - the error message.

RaveError

public RaveError(BaseValidator.ValidationContext validationContext,
                 java.lang.String errorMsg)

Parameters:

validationContext - the BaseValidator.ValidationContext.

errorMsg - the error message.

Method Detail

getErrorMsg

public java.lang.String getErrorMsg()

Returns:

the String error messaged for this error.

getClassElement

public java.lang.String getClassElement()

This method returns the description of what element in the class failed validation, for example the method name.

Returns:

the String representation of the element in the class.

getClazz

public java.lang.Class<?> getClazz()

Returns:

the Class object.

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object