org.vishia.event

Class PayloadBack

java.lang.Object

org.vishia.event.PayloadBack

All Implemented Interfaces:

Payload

Direct Known Subclasses:

FileRemoteProgressEvData

public class PayloadBack
extends java.lang.Object
implements Payload

This class offers a simple implementation for Payload which can be used for a simple callback. Usual this class should be inherit for more data. That's why the implementation of serialize() and deserialize(byte[]) is not sensible implemented.

Field Summary

Fields

Modifier and Type	Field and Description
protected boolean	bDone This bit should be set if the back event should notify that the task is done with or without error.
protected java.lang.String	sError A possible error message.
static java.lang.String	version Version, license and history.

Constructor Summary

Constructors

Constructor and Description
PayloadBack()

Method Summary

Modifier and Type	Method and Description
PayloadBack	clean() Common operation to clean the content.
boolean	deserialize(byte[] data) Deserialize is not supported by this implementation.
boolean	done()
java.lang.String	error()
byte[]	serialize() Serialize is not supported by this implementation.
void	setDone(boolean bDone, java.lang.String sError)

Methods inherited from class java.lang.Object

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

Field Detail

version

public static final java.lang.String version

Version, license and history.

• 2023-07-24 Hartmut created. necessary for the universal approach for EventConsumerAwait

Copyright/Copyleft: For this source the LGPL Lesser General Public License, published by the Free Software Foundation is valid. It means:

1. You can use this source without any restriction for any desired purpose.
2. You can redistribute copies of this source to everybody.
3. Every user of this source, also the user of redistribute copies with or without payment, must accept this license for further using.
4. But the LPGL is not appropriate for a whole software product, if this source is only a part of them. It means, the user must publish this part of source, but don't need to publish the whole source of the own product.
5. You can study and modify (improve) this source for own using or for redistribution, but you have to license the modified sources likewise under this LGPL Lesser General Public License. You mustn't delete this Copyright/Copyleft inscription in this source file.

If you are indent to use this sources without publishing its usage, you can get a second license subscribing a special contract with the author.

See Also:

Constant Field Values

bDone

protected boolean bDone

This bit should be set if the back event should notify that the task is done with or without error. For progress messages, quests etc. more data are necessary.

sError

protected java.lang.String sError

A possible error message. If null then all should be seen as successfully.

Constructor Detail

PayloadBack

public PayloadBack()

Method Detail

setDone

public void setDone(boolean bDone,
                    java.lang.String sError)

error

public java.lang.String error()

done

public boolean done()

clean

public PayloadBack clean()

Description copied from interface: Payload

Common operation to clean the content. Before usage the payload it should be cleaned

Specified by:

clean in interface Payload

serialize

public byte[] serialize()

Serialize is not supported by this implementation.

Specified by:

serialize in interface Payload

Returns:

a dedicated byte stream presenting the content.

deserialize

public boolean deserialize(byte[] data)

Deserialize is not supported by this implementation.

Specified by:

deserialize in interface Payload

Returns:

false if there is any error (instead an exception).