com.smartfoxserver.v2.components.signup

Class SignUpValidationException

java.lang.Object

java.lang.Throwable

java.lang.Exception

com.smartfoxserver.v2.components.signup.SignUpValidationException

All Implemented Interfaces:

java.io.Serializable

public class SignUpValidationException
extends java.lang.Exception

Signal a validation error during the SignUp process

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
SignUpValidationException(SignUpErrorCodes code, java.lang.Object... params) Provide a description of the error.

Method Summary

Modifier and Type	Method and Description
SignUpErrorCodes	getCode() Obtain the error code
java.lang.Object[]	getParams() Obtain the error message parameters

Methods inherited from class java.lang.Throwable

addSuppressed, fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, getSuppressed, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

SignUpValidationException

public SignUpValidationException(SignUpErrorCodes code,
                                 java.lang.Object... params)

Provide a description of the error.

Parameters:

code - an error code

params - a variable amount of parameters depending on the error code message. If no parameters are available for this error message, simply pass null

Method Detail

getCode

public SignUpErrorCodes getCode()

Obtain the error code

Returns:

the error code

getParams

public java.lang.Object[] getParams()

Obtain the error message parameters

Returns:

the array of parameters