org.eclipse.kura.channel

Class ChannelStatus

java.lang.Object

org.eclipse.kura.channel.ChannelStatus

@Immutable
 @ThreadSafe
 @ProviderType
public class ChannelStatus
extends java.lang.Object

The Class ChannelStatus is responsible for representing the status of any channel specific operation

Since:

1.2

Constructor Summary

Constructors

Constructor and Description
ChannelStatus(ChannelFlag channelFlag) Instantiates a new status.
ChannelStatus(ChannelFlag channelFlag, java.lang.String exceptionMessage, java.lang.Exception exception) Instantiates a new status.

Method Summary

Modifier and Type	Method and Description
boolean	equals(java.lang.Object obj)
ChannelFlag	getChannelFlag() Gets the channel flag.
java.lang.Exception	getException() Gets the exception.
java.lang.String	getExceptionMessage() Gets the exception message.
int	hashCode()
java.lang.String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

ChannelStatus

public ChannelStatus(ChannelFlag channelFlag)

Instantiates a new status.

Parameters:

channelFlag - the channel flag

Throws:

java.lang.NullPointerException - if the channel flag is null

ChannelStatus

public ChannelStatus(ChannelFlag channelFlag,
                     @Nullable
                     java.lang.String exceptionMessage,
                     @Nullable
                     java.lang.Exception exception)

Instantiates a new status.

Parameters:

channelFlag - the channel flag

exceptionMessage - the exception message

exception - the exception

Throws:

java.lang.NullPointerException - if the channel flag is null

Method Detail

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object

getChannelFlag

public ChannelFlag getChannelFlag()

Gets the channel flag.

Returns:

the channel flag

getException

public java.lang.Exception getException()

Gets the exception.

Returns:

the exception

getExceptionMessage

public java.lang.String getExceptionMessage()

Gets the exception message.

Returns:

the exception message

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object