Package io.github.blackspherefollower.buttplug4j.protocol.messages

Class Error

java.lang.Object

io.github.blackspherefollower.buttplug4j.protocol.ButtplugMessage

io.github.blackspherefollower.buttplug4j.protocol.messages.Error

public final class Error
extends ButtplugMessage

Error message.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	Error.ErrorClass	Error class enum.

Constructor Summary

Constructors

Constructor	Description
Error(ButtplugException e)	Constructor from exception.
Error(ButtplugException e, int id)	Constructor from exception and ID.
Error(String aErrorMessage, Error.ErrorClass aErrorCode, int id)	Constructor.

Method Summary

Modifier and Type	Method	Description
Error.ErrorClass	getErrorCode()	Get error code.
String	getErrorMessage()	Get error message.
ButtplugException	getException()	Get underlying exception.
void	setErrorCode(Error.ErrorClass aErrorCode)	Set error code.
void	setErrorMessage(String aErrorMessage)	Set error message.

Methods inherited from class io.github.blackspherefollower.buttplug4j.protocol.ButtplugMessage

getId, setId

Methods inherited from class java.lang.Object

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

Constructor Details

Error

public Error(String aErrorMessage,
 Error.ErrorClass aErrorCode,
 int id)

Constructor.

Parameters:

aErrorMessage - error message

aErrorCode - error code

id - message ID

Error

public Error(ButtplugException e)

Constructor from exception.

Parameters:

e - exception

Error

public Error(ButtplugException e,
 int id)

Constructor from exception and ID.

Parameters:

e - exception

id - message ID

Method Details

getErrorCode

public Error.ErrorClass getErrorCode()

Get error code.

Returns:

error code

setErrorCode

public void setErrorCode(Error.ErrorClass aErrorCode)

Set error code.

Parameters:

aErrorCode - error code

getErrorMessage

public String getErrorMessage()

Get error message.

Returns:

error message

setErrorMessage

public void setErrorMessage(String aErrorMessage)

Set error message.

Parameters:

aErrorMessage - error message

getException

public ButtplugException getException()

Get underlying exception.

Returns:

exception