FileRemoteCmdEventData

java.lang.Object
- org.vishia.fileRemote.FileRemoteCmdEventData

All Implemented Interfaces:: Payload

public class FileRemoteCmdEventData
extends java.lang.Object
implements Payload

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class FileRemoteCmdEventData.Cmd

Nested Classes
Modifier and Type	Class and Description
`static class`	`FileRemoteCmdEventData.Cmd`

Field Summary

Fields
Modifier and Type	Field and Description
`private FileRemoteWalkerCallback`	`callback`
`private FileRemoteCmdEventData.Cmd`	`cmd` The command to execute with this cmd event payload.
`private int`	`cycleProgress` Milliseconds for cycle or specific determined progress event: 0= progress event for any file and directory entry.
`private int`	`depthWalk` Depths to walk in dir tree, 0: all.
`private FileRemote`	`filedst` Source and destination files for copy, rename, move or the only one filesrc. filedst may remain null then.
`private FileRemote`	`filesrc` Source and destination files for copy, rename, move or the only one filesrc. filedst may remain null then.
`private int`	`markSet` Bits to mark files while walking through.
`private int`	`markSetDir` Bits to mark files while walking through.
`(package private) int`	`maskFlags` For `FileRemoteCmdEventData.Cmd.chgProps`: new properties with bit designation see `FileRemote.flags`.
`private int`	`modeCopyOper` Mode of operation, see `FileRemote.modeCopyCreateAsk` etc.
`private java.lang.String`	`nameDst` Designation of destination file names maybe wildcard mask.
`private java.lang.String`	`namesSrc` List of names separated with ':' or " : " or empty.
`(package private) long`	`newDate` For `FileRemoteCmdEventData.Cmd.chgProps`: A new time stamp.
`(package private) int`	`newFlags` For `FileRemoteCmdEventData.Cmd.chgProps`: new properties with bit designation see `FileRemote.flags`.
`private java.lang.String`	`newName` For `FileRemoteCmdEventData.Cmd.chgProps`: a new name.
`private java.lang.String`	`selectFilter` Wildcard mask to select source files.
`private int`	`selectMask` Bits to select from mark.
`private static long`	`serialVersionUID`

Constructor Summary

Constructors
Constructor and Description

FileRemoteCmdEventData()
Creates the payload of a command event

Constructors
Constructor and Description
`FileRemoteCmdEventData()` Creates the payload of a command event

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`FileRemoteWalkerCallback`	`callback()`
`FileRemoteCmdEventData`	`clean()` Common operation to clean the content.
`FileRemoteCmdEventData.Cmd`	`cmd()`
`int`	`cycleProgress()`
`int`	`depthWalk()`
`boolean`	`deserialize(byte[] data)` Opposite operation, reads the serialized content and restore the Java content.
`FileRemote`	`filedst()`
`FileRemote`	`filesrc()`
`int`	`markSet()`
`int`	`markSetDir()`
`int`	`maskFlags()`
`int`	`modeCopyOper()`
`long`	`newDate()`
`int`	`newFlags()`
`java.lang.String`	`newName()`
`java.lang.String`	`selectFilter()`
`int`	`selectMask()`
`byte[]`	`serialize()` Converts to dedicated bytes which presents the content.
`void`	`setCallback(FileRemoteWalkerCallback callback)`
`void`	`setCmdChgFileRemote(FileRemote file, FileRemoteCmdEventData.Cmd cmd, FileRemote fileDst, java.lang.String nameNew, long dateNew)` Sets the command and data for changing a file in a remote file system.
`void`	`setCmdWalkLocal(FileRemote srcdir, FileRemoteCmdEventData.Cmd cmd, FileRemote dstdir, int markSet, int markSetDir, java.lang.String selectFilter, int selectMask, int depthWalk, FileRemoteWalkerCallback callback, int cycleProgress)` Sets the command and data for walk through the file system on a local device in the same data space.
`void`	`setCmdWalkRemote(FileRemote srcdir, FileRemoteCmdEventData.Cmd cmd, FileRemote dstdir, java.lang.String selectFilter, int cycleProgress, int depthWalk)` Sets the command and data for walk through the file system for remote access.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - serialVersionUID
```
private static final long serialVersionUID
```
    See Also:
    
    Constant Field Values
  - cmd
```
private FileRemoteCmdEventData.Cmd cmd
```
    The command to execute with this cmd event payload.
  - cycleProgress
```
private int cycleProgress
```
    Milliseconds for cycle or specific determined progress event:
    0= progress event for any file and directory entry. It is especially for refresh.
  - filesrc
```
private FileRemote filesrc
```
    Source and destination files for copy, rename, move or the only one filesrc. filedst may remain null then.
  - filedst
```
private FileRemote filedst
```
    Source and destination files for copy, rename, move or the only one filesrc. filedst may remain null then.
  - namesSrc
```
private java.lang.String namesSrc
```
    List of names separated with ':' or " : " or empty. If not empty, filesrc is the directory of this files.
  - markSet
```
private int markSet
```
    Bits to mark files while walking through.
  - markSetDir
```
private int markSetDir
```
    Bits to mark files while walking through.
  - selectFilter
```
private java.lang.String selectFilter
```
    Wildcard mask to select source files. Maybe empty or null, then all files are used.
  - selectMask
```
private int selectMask
```
    Bits to select from mark. If files are marked before by comparison, als manually, this can be used. It can use some specific bits: FileMark.orWithSelectString, FileMark.ignoreSymbolicLinks
  - depthWalk
```
private int depthWalk
```
    Depths to walk in dir tree, 0: all.
  - nameDst
```
private java.lang.String nameDst
```
    Designation of destination file names maybe wildcard mask.
  - modeCopyOper
```
private int modeCopyOper
```
    Mode of operation, see FileRemote.modeCopyCreateAsk etc.
  - newName
```
private java.lang.String newName
```
    For FileRemoteCmdEventData.Cmd.chgProps: a new name.
  - maskFlags
```
int maskFlags
```
    For FileRemoteCmdEventData.Cmd.chgProps: new properties with bit designation see FileRemote.flags. maskFlags contains bits which properties should change, newFlags contains the value of that bit.
  - newFlags
```
int newFlags
```
    For FileRemoteCmdEventData.Cmd.chgProps: new properties with bit designation see FileRemote.flags. maskFlags contains bits which properties should change, newFlags contains the value of that bit.
  - newDate
```
long newDate
```
    For FileRemoteCmdEventData.Cmd.chgProps: A new time stamp.
  - callback
```
private FileRemoteWalkerCallback callback
```
- Constructor Detail
  - FileRemoteCmdEventData
```
public FileRemoteCmdEventData()
```
    Creates the payload of a command event
- Method Detail
  - setCmdWalkRemote
```
public void setCmdWalkRemote(FileRemote srcdir,
                             FileRemoteCmdEventData.Cmd cmd,
                             FileRemote dstdir,
                             java.lang.String selectFilter,
                             int cycleProgress,
                             int depthWalk)
```
    Sets the command and data for walk through the file system for remote access. It is complete for a walking. Note: The callback cannot be given here, it should be organized in the remote device. It is consequently to do so also if it is executed only in another thread on the same device.
    
    Parameters:
    
    srcdir - the directory which is used for walk through as base or start directory.
    
    cmd - command to execute. It determines what is done with the file. Only specific commands are admissible.
    
    dstdir - the directory which is used as destination due to the cmd.
    
    selectFilter - A filter for the sub dir and files
    
    cycleProgress - for the callback event to inform about progress
    
    depthWalk -
  - setCmdChgFileRemote
```
public void setCmdChgFileRemote(FileRemote file,
                                FileRemoteCmdEventData.Cmd cmd,
                                FileRemote fileDst,
                                java.lang.String nameNew,
                                long dateNew)
```
    Sets the command and data for changing a file in a remote file system. All data for change are in the payload. It is also for delete the file or get data from the file, or also copy one file.
    
    Parameters:
    
    file -
    
    cmd -
  - setCmdWalkLocal
```
public void setCmdWalkLocal(FileRemote srcdir,
                            FileRemoteCmdEventData.Cmd cmd,
                            FileRemote dstdir,
                            int markSet,
                            int markSetDir,
                            java.lang.String selectFilter,
                            int selectMask,
                            int depthWalk,
                            FileRemoteWalkerCallback callback,
                            int cycleProgress)
```
    Sets the command and data for walk through the file system on a local device in the same data space. It means the FileRemote instances are available. It is for the PC Operation system files on the same PC or in the PCs network access. The access can be run in the same thread or in another thread.
    
    Parameters:
    
    srcdir -
    
    cmd -
    
    dstdir -
    
    markSet -
    
    markSetDir -
    
    selectFilter -
    
    selectMask -
    
    depthWalk -
    
    callback - It can be given if the cmd has not an own callback.
    
    cycleProgress - determines the time of sending the progress event. -1 = never, 0=on any file, >0 is milliseconds.
  - cmd
```
public FileRemoteCmdEventData.Cmd cmd()
```
  - filesrc
```
public final FileRemote filesrc()
```
  - filedst
```
public final FileRemote filedst()
```
  - callback
```
public FileRemoteWalkerCallback callback()
```
  - setCallback
```
public void setCallback(FileRemoteWalkerCallback callback)
```
  - markSet
```
public int markSet()
```
  - markSetDir
```
public int markSetDir()
```
  - selectFilter
```
public java.lang.String selectFilter()
```
  - selectMask
```
public int selectMask()
```
  - cycleProgress
```
public int cycleProgress()
```
  - depthWalk
```
public int depthWalk()
```
  - modeCopyOper
```
public final int modeCopyOper()
```
  - newName
```
public final java.lang.String newName()
```
  - maskFlags
```
public final int maskFlags()
```
  - newFlags
```
public final int newFlags()
```
  - newDate
```
public final long newDate()
```
  - clean
```
public FileRemoteCmdEventData 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()
```
    Description copied from interface: Payload
    
    Converts to dedicated bytes which presents the content. The kind of serialization is programmed manually to regard specific conditions and also deserialization in any other language, especially C for embedded control applications.
    Note: You can also use Java-like serialization using also the Serializable interface. This is another approach.
    
    Specified by:
    
    serialize in interface Payload
    
    Returns:
    
    a dedicated byte stream presenting the content.
  - deserialize
```
public boolean deserialize(byte[] data)
```
    Description copied from interface: Payload
    
    Opposite operation, reads the serialized content and restore the Java content.
    
    Specified by:
    
    deserialize in interface Payload
    
    Returns:
    
    false if there is any error (instead an exception).

Class FileRemoteCmdEventData

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

serialVersionUID

cmd

cycleProgress

filesrc

filedst

namesSrc

markSet

markSetDir

selectFilter

selectMask

depthWalk

nameDst

modeCopyOper

newName

maskFlags

newFlags

newDate

callback

Constructor Detail

FileRemoteCmdEventData

Method Detail

setCmdWalkRemote

setCmdChgFileRemote

setCmdWalkLocal

cmd

filesrc

filedst

callback

setCallback

markSet

markSetDir

selectFilter

selectMask

cycleProgress

depthWalk

modeCopyOper

newName

maskFlags

newFlags

newDate

clean

serialize

deserialize