FileRemoteProgressEvData

java.lang.Object
- org.vishia.event.PayloadBack
- - org.vishia.fileRemote.FileRemoteProgressEvData

All Implemented Interfaces:

java.io.Serializable, Payload
```
public class FileRemoteProgressEvData
extends PayloadBack
implements java.io.Serializable, Payload
```
This are the data for an EventWithDst for FileRemote actions. Hint: the EventConsumer evaluating this data repectively for the evBack of file operations should be an derived instance of FileRemoteProgressEventConsumer.

See Also:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class FileRemoteProgressEvData.Answer
Possible answers from quest.

static class FileRemoteProgressEvData.ProgressCmd

Nested Classes
Modifier and Type	Class and Description
`static class`	`FileRemoteProgressEvData.Answer` Possible answers from quest.
`static class`	`FileRemoteProgressEvData.ProgressCmd`

Field Summary

Fields
Modifier and Type	Field and Description
`FileRemoteCmdEventData.Cmd`	`answerToCmd` The original command which this is answer to.
`protected boolean`	`bAbort` These are bits for communication from set from the application.
`protected boolean`	`bMkdirAll` These are bits for communication from set from the application.
`protected boolean`	`bOverwrite` These are bits for communication from set from the application.
`protected boolean`	`bOverwriteAll` These are bits for communication from set from the application.
`boolean`	`bPause` True then the application will be stop the execution.
`boolean`	`bQuest` True then the service has stopped execution (thread is in wait) for an answer.
`FileRemote`	`currDir` Current processed file.
`FileRemote`	`currFile` Current processed file.
`long`	`dateCreate`
`long`	`dateLastAccess`
`int`	`modeCopyOper` Mode of operation, see `FileRemote.modeCopyCreateAsk` etc.
`int`	`nrDirProcessed` Number of processed directories and files independent of mark situation, but don't count directories which are not entered.
`int`	`nrDirVisited` Number of processed directories and files independent of mark situation, but don't count directories which are not entered.
`int`	`nrFilesVisited` Number of processed directories and files independent of mark situation, but don't count directories which are not entered.
`long`	`nrofBytesAll` Processed bytes.
`long`	`nrofBytesFile` Processed bytes.
`long`	`nrofBytesFileCopied` Processed bytes.
`int`	`nrofFilesMarked` Number of Files which are marked while walking and processing.
`int`	`nrofFilesSelected` Number of Files which are selected by String mask or marked bits.
`FileRemoteProgressEvData.ProgressCmd`	`progressCmd` Cmd describes what the progress event contains.
`private static long`	`serialVersionUID`
`static java.lang.String`	`version` Version, license and history.

Fields inherited from class org.vishia.event.PayloadBack
bDone, sError

Constructor Summary

Constructors
Constructor and Description

FileRemoteProgressEvData()
super constructor:

Constructors
Constructor and Description
`FileRemoteProgressEvData()` super constructor:

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`abort()` Quest from executer.
`boolean`	`bOverwriteAll()` Quest from executer.
`FileRemoteProgressEvData`	`clean()` Common operation to clean the content.
`boolean`	`deserialize(byte[] data)` Deserialize is not supported by this implementation.
`boolean`	`done()`
`void`	`done(FileRemoteCmdEventData.Cmd answer, java.lang.String sError)` Set the event to the done() state, all is done maybe with error.
`boolean`	`mkdirAll()` Quest from executer.
`boolean`	`overwrite()` Quest from executer.
`boolean`	`pause()` Quest from executer while working.
`byte[]`	`serialize()` Serialize is not supported by this implementation.
`void`	`setAbort()` Set from application to force abort in the executer.
`void`	`setAnswer(FileRemoteProgressEvData.ProgressCmd answer)` This operation should be called by the application if a `#quest()` is detected.
`void`	`setbOverwriteAll(boolean value)` Set from application to force abort in the executer.
`void`	`setMkdirAll(boolean value)` Set from application to force abort in the executer.
`void`	`setOverwrite(boolean value)` Set from application to force abort in the executer.
`void`	`setPause(boolean value)` Set from application to force abort in the executer working in the current.

Methods inherited from class org.vishia.event.PayloadBack
error, setDone

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 now inherits from PayloadBack which contains bDone and sError.
    - 2023-03-26 FileRemoteProgressEvData.ProgressCmd now contains all cmd for ask, yet in progress.
    - 2023-02-21 new implements Payload and hence clean()
    - 2023-02-21 chg progressCmd is of type FileRemoteProgressEvData.ProgressCmd, separated now from FileRemote.Cmd
    - 2023-02-21 done() in cohesion with org.vishia.event.EventConsumerAwait#awaitExecution(long) and TimeOrder.repeatCyclic(). If done() was called the cyclically repeat ends because it calls TimeOrder.clear().
    - 2023-02-10 refactoring in progress. Tested with The.file.Commenader
    - 2023-02-06 The class TimeOrder is outdated, use its super class TimeOrder also here. Some adpations done.
    - 2015-05-03 Hartmut new: possibility to check #isBusy()
    - 2015-05-03 Hartmut chg: occupyRecall(500,...) for answer events especially abort after exception, prevent hanging of copy in Fcmd
    - 2015-01-11 Hartmut created this class is the base class of them now. The algorithm is able to use outside of that graphic too.
    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
  - serialVersionUID
```
private static final long serialVersionUID
```
    See Also:
    
    Constant Field Values
  - progressCmd
```
public FileRemoteProgressEvData.ProgressCmd progressCmd
```
    Cmd describes what the progress event contains.
  - answerToCmd
```
public FileRemoteCmdEventData.Cmd answerToCmd
```
    The original command which this is answer to.
  - currFile
```
public FileRemote currFile
```
    Current processed file.
  - currDir
```
public FileRemote currDir
```
    Current processed file.
  - dateCreate
```
public long dateCreate
```
  - dateLastAccess
```
public long dateLastAccess
```
  - nrofBytesAll
```
public long nrofBytesAll
```
    Processed bytes.
  - nrofBytesFile
```
public long nrofBytesFile
```
    Processed bytes.
  - nrofBytesFileCopied
```
public long nrofBytesFileCopied
```
    Processed bytes.
  - nrDirVisited
```
public int nrDirVisited
```
    Number of processed directories and files independent of mark situation, but don't count directories which are not entered.
  - nrDirProcessed
```
public int nrDirProcessed
```
    Number of processed directories and files independent of mark situation, but don't count directories which are not entered.
  - nrFilesVisited
```
public int nrFilesVisited
```
    Number of processed directories and files independent of mark situation, but don't count directories which are not entered.
  - nrofFilesSelected
```
public int nrofFilesSelected
```
    Number of Files which are selected by String mask or marked bits.
  - nrofFilesMarked
```
public int nrofFilesMarked
```
    Number of Files which are marked while walking and processing.
  - modeCopyOper
```
public int modeCopyOper
```
    Mode of operation, see FileRemote.modeCopyCreateAsk etc.
  - bQuest
```
public boolean bQuest
```
    True then the service has stopped execution (thread is in wait) for an answer. After set the answer bits call notify().
  - bPause
```
public boolean bPause
```
    True then the application will be stop the execution. The execution should be go to wait, set #bQuest before. After notify some of continue etc. should be come.
  - bAbort
```
protected boolean bAbort
```
    These are bits for communication from set from the application.
  - bOverwrite
```
protected boolean bOverwrite
```
    These are bits for communication from set from the application.
  - bOverwriteAll
```
protected boolean bOverwriteAll
```
    These are bits for communication from set from the application.
  - bMkdirAll
```
protected boolean bMkdirAll
```
    These are bits for communication from set from the application.
- Constructor Detail
  - FileRemoteProgressEvData
```
public FileRemoteProgressEvData()
```
    super constructor:
    
    Parameters:
    
    name - Only for toString(), debug
    
    mng - The manager for this time order to execute it for showing, often a graphic thread adaption. For example use org.vishia.gral.base.GralMng#gralDevice() and there org.vishia.gral.base.GralGraphicThread#orderList().
    
    delay - The delay to start the oder execution after #show()
- Method Detail
  - clean
```
public FileRemoteProgressEvData 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
    
    Overrides:
    
    clean in class PayloadBack
  - done
```
public void done(FileRemoteCmdEventData.Cmd answer,
                 java.lang.String sError)
```
    Set the event to the done() state, all is done maybe with error.
    
    Parameters:
    
    infoUnusedFinish - Either EventConsumer.mEventConsumerException or EventConsumer.mEventConsumFinished
    
    sError - a message if any what was unexpected. Especially on unexpected exception.
  - done
```
public boolean done()
```
    Overrides:
    
    done in class PayloadBack
  - setAnswer
```
public final void setAnswer(FileRemoteProgressEvData.ProgressCmd answer)
```
    This operation should be called by the application if a #quest() is detected. If the executer waits then it will be notified.
    
    Parameters:
    
    answer - the answer for the quest.
  - abort
```
public boolean abort()
```
    Quest from executer. The application can setAbort() for example by user handling any time.
    
    Returns:
    
    true if should be aborted.
  - setAbort
```
public void setAbort()
```
    Set from application to force abort in the executer.
  - pause
```
public boolean pause()
```
    Quest from executer while working. If the bit setPause(boolean) is given, then the thread goes in wait, checks in an interval of 10 seconds whether bPause is still set, and continues if bPause is false again. Note that setPause(boolean) with false wakes up waiting.
    
    Returns:
    
    true if the execution has paused.
  - setPause
```
public void setPause(boolean value)
```
    Set from application to force abort in the executer working in the current.
  - overwrite
```
public boolean overwrite()
```
    Quest from executer. The application can setAbort() for example by user handling any time.
    
    Returns:
    
    true if should be aborted.
  - setOverwrite
```
public void setOverwrite(boolean value)
```
    Set from application to force abort in the executer.
  - bOverwriteAll
```
public boolean bOverwriteAll()
```
    Quest from executer. The application can setAbort() for example by user handling any time.
    
    Returns:
    
    true if should be aborted.
  - setbOverwriteAll
```
public void setbOverwriteAll(boolean value)
```
    Set from application to force abort in the executer.
  - mkdirAll
```
public boolean mkdirAll()
```
    Quest from executer.
    
    Returns:
    
    true if all directories should created on copy or move.
  - setMkdirAll
```
public void setMkdirAll(boolean value)
```
    Set from application to force abort in the executer.
  - serialize
```
public byte[] serialize()
```
    Description copied from class: PayloadBack
    
    Serialize is not supported by this implementation.
    
    Specified by:
    
    serialize in interface Payload
    
    Overrides:
    
    serialize in class PayloadBack
    
    Returns:
    
    a dedicated byte stream presenting the content.
  - deserialize
```
public boolean deserialize(byte[] data)
```
    Description copied from class: PayloadBack
    
    Deserialize is not supported by this implementation.
    
    Specified by:
    
    deserialize in interface Payload
    
    Overrides:
    
    deserialize in class PayloadBack
    
    Returns:
    
    false if there is any error (instead an exception).

Class FileRemoteProgressEvData

Nested Class Summary

Field Summary

Fields inherited from class org.vishia.event.PayloadBack

Constructor Summary

Method Summary

Methods inherited from class org.vishia.event.PayloadBack

Methods inherited from class java.lang.Object

Field Detail

version

serialVersionUID

progressCmd

answerToCmd

currFile

currDir

dateCreate

dateLastAccess

nrofBytesAll

nrofBytesFile

nrofBytesFileCopied

nrDirVisited

nrDirProcessed

nrFilesVisited

nrofFilesSelected

nrofFilesMarked

modeCopyOper

bQuest

bPause

bAbort

bOverwrite

bOverwriteAll

bMkdirAll

Constructor Detail

FileRemoteProgressEvData

Method Detail

clean

done

done

setAnswer

abort

setAbort

pause

setPause

overwrite

setOverwrite

bOverwriteAll

setbOverwriteAll

mkdirAll

setMkdirAll

serialize

deserialize