RSync (rsync4j-core 3.1.2-14 API)

java.lang.Object
- com.github.fracpete.rsync4j.core.AbstractBinary
- - com.github.fracpete.rsync4j.core.AbstractBinaryWithTimeout
  - - com.github.fracpete.rsync4j.RSync

```
public class RSync
extends AbstractBinaryWithTimeout
```
Wrapper for rsync binary.

Author:

fracpete (fracpete at gmail dot com)

Field Summary

Fields
Modifier and Type	Field and Description
`protected java.lang.String[]`	`additional`
`protected java.lang.String`	`address`
`protected boolean`	`append`
`protected boolean`	`append_verify`
`protected boolean`	`archive`
`protected boolean`	`backup`
`protected java.lang.String`	`backup_dir`
`protected java.lang.String`	`block_size`
`protected boolean`	`blocking_io`
`protected java.lang.String`	`bwlimit`
`protected boolean`	`checksum`
`protected int`	`checksum_seed`
`protected java.lang.String`	`chmod`
`protected java.lang.String`	`chown`
`protected java.lang.String[]`	`compare_dest`
`protected boolean`	`compress`
`protected int`	`compress_level`
`protected int`	`contimeout`
`protected java.lang.String[]`	`copy_dest`
`protected boolean`	`copy_dirlinks`
`protected boolean`	`copy_links`
`protected boolean`	`copy_unsafe_links`
`protected boolean`	`cvs_exclude`
`protected java.lang.String`	`debug`
`protected boolean`	`delay_updates`
`protected boolean`	`delete`
`protected boolean`	`delete_after`
`protected boolean`	`delete_before`
`protected boolean`	`delete_delay`
`protected boolean`	`delete_during`
`protected boolean`	`delete_excluded`
`protected boolean`	`delete_missing_args`
`protected java.lang.String`	`destination` the destination path/url.
`protected boolean`	`devices`
`protected boolean`	`dirs`
`protected boolean`	`dry_run`
`protected boolean`	`eight_bit_output`
`protected boolean`	`executability`
`protected boolean`	`existing`
`protected boolean`	`fake_super`
`protected java.lang.String`	`files_from`
`protected boolean`	`force`
`protected boolean`	`from0`
`protected boolean`	`fuzzy`
`protected boolean`	`group`
`protected java.lang.String`	`groupmap`
`protected boolean`	`hard_links`
`protected boolean`	`human_readable`
`protected java.lang.String`	`iconv`
`protected boolean`	`ignore_errors`
`protected boolean`	`ignore_existing`
`protected boolean`	`ignore_missing_args`
`protected boolean`	`ignore_times`
`protected java.util.List<java.lang.String>`	`include_exclude`
`protected java.lang.String`	`info`
`protected boolean`	`inplace`
`protected boolean`	`ipv4`
`protected boolean`	`ipv6`
`protected boolean`	`itemize_changes`
`protected boolean`	`keep_dirlinks`
`protected java.lang.String[]`	`link_dest`
`protected boolean`	`links`
`protected boolean`	`list_only`
`protected java.lang.String`	`log_file`
`protected java.lang.String`	`log_file_format`
`protected int`	`max_delete`
`protected java.lang.String`	`max_size`
`protected java.lang.String`	`min_size`
`protected int`	`modify_window`
`protected boolean`	`msgs2stderr`
`protected boolean`	`munge_links`
`protected boolean`	`no_implied_dirs`
`protected boolean`	`no_motd`
`protected boolean`	`numeric_ids`
`protected boolean`	`omit_dir_times`
`protected boolean`	`omit_link_times`
`protected boolean`	`one_file_system`
`protected java.lang.String`	`only_write_batch`
`protected java.lang.String`	`out_format`
`protected char`	`outbuf`
`protected boolean`	`owner`
`protected boolean`	`partial`
`protected java.lang.String`	`partial_dir`
`protected java.lang.String`	`password_file`
`protected boolean`	`perms`
`protected int`	`port`
`protected boolean`	`preallocate`
`protected boolean`	`progress`
`protected boolean`	`protect_args`
`protected int`	`protocol`
`protected boolean`	`prune_empty_dirs`
`protected boolean`	`quiet`
`protected java.lang.String`	`read_batch`
`protected boolean`	`recursive`
`protected boolean`	`relative`
`protected java.lang.String`	`remote_option`
`protected boolean`	`remove_source_files`
`protected java.lang.String`	`rsh`
`protected java.lang.String`	`rsync_path`
`protected boolean`	`safe_links`
`protected boolean`	`size_only`
`protected java.lang.String`	`skip_compress`
`protected java.lang.String`	`sockopts`
`protected java.util.List<java.lang.String>`	`sources` the source path/url.
`protected boolean`	`sparse`
`protected boolean`	`specials`
`protected boolean`	`stats`
`protected java.lang.String`	`suffix`
`protected boolean`	`super_`
`protected java.lang.String`	`temp_dir`
`protected int`	`timeout`
`protected boolean`	`times`
`protected boolean`	`update`
`protected java.lang.String`	`usermap`
`protected boolean`	`verbose`
`protected boolean`	`version`
`protected boolean`	`whole_file`
`protected java.lang.String`	`write_batch`
`protected boolean`	`xattrs`

Fields inherited from class com.github.fracpete.rsync4j.core.AbstractBinaryWithTimeout
max_time

Fields inherited from class com.github.fracpete.rsync4j.core.AbstractBinary
logger, outputCommandline

Constructor Summary

Constructors
Constructor and Description

RSync()

Constructors
Constructor and Description
`RSync()`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`protected RSync`	`addIncludeExclude(java.lang.String id, java.lang.String... list)` Adds a list of include/exclude items.
`RSync`	`additional(java.lang.String... additional)` Automatically replaces leading "+" and "++" with corresponding "-" and "--".
`RSync`	`address(java.lang.String address)`
`RSync`	`append(boolean append)`
`RSync`	`appendVerify(boolean append_verify)`
`RSync`	`archive(boolean archive)`
`RSync`	`backup(boolean backup)`
`RSync`	`backupDir(java.lang.String backup_dir)`
`RSync`	`blockingIO(boolean blocking_io)`
`RSync`	`blockSize(java.lang.String block_size)`
`RSync`	`bwlimit(java.lang.String bwlimit)`
`RSync`	`checksum(boolean checksum)`
`RSync`	`checksumSeed(int checksum_seed)`
`RSync`	`chmod(java.lang.String chmod)`
`RSync`	`chown(java.lang.String chown)`
`java.util.List<java.lang.String>`	`commandLineArgs()` Assembles the full command-line arguments.
`RSync`	`compareDest(java.lang.String... compare_dest)`
`RSync`	`compress(boolean compress)`
`RSync`	`compressLevel(int compress_level)`
`RSync`	`contimeout(int contimeout)`
`RSync`	`copyDest(java.lang.String... copy_dest)`
`RSync`	`copyDirlinks(boolean copy_dirlinks)`
`RSync`	`copyLinks(boolean copy_links)`
`RSync`	`copyUnsafeLinks(boolean copy_unsafe_links)`
`RSync`	`cvsExclude(boolean cvs_exclude)`
`RSync`	`debug(java.lang.String debug)`
`RSync`	`delayUpdates(boolean delay_updates)`
`RSync`	`delete(boolean delete)`
`RSync`	`deleteAfter(boolean delete_after)`
`RSync`	`deleteBefore(boolean delete_before)`
`RSync`	`deleteDelay(boolean delete_delay)`
`RSync`	`deleteDuring(boolean delete_during)`
`RSync`	`deleteExcluded(boolean delete_excluded)`
`RSync`	`deleteMissingArgs(boolean delete_missing_args)`
`protected java.lang.String`	`description()` Returns a short description for the binary.
`RSync`	`destination(java.lang.String value)` Sets the destination path/url.
`RSync`	`devices(boolean devices)`
`RSync`	`dirs(boolean dirs)`
`RSync`	`dryRun(boolean dry_run)`
`RSync`	`eightBitOutput(boolean eight_bit_output)`
`RSync`	`exclude(java.lang.String... exclude)`
`RSync`	`excludeFrom(java.lang.String... exclude_from)`
`RSync`	`executability(boolean executability)`
`RSync`	`existing(boolean existing)`
`RSync`	`fakeSuper(boolean fake_super)`
`RSync`	`filesFrom(java.lang.String files_from)`
`RSync`	`filter(java.lang.String... filter)`
`RSync`	`force(boolean force)`
`RSync`	`from0(boolean from0)`
`RSync`	`fuzzy(boolean fuzzy)`
`java.lang.String[]`	`getAdditional()`
`java.lang.String`	`getAddress()`
`java.lang.String`	`getBackupDir()`
`java.lang.String`	`getBlockSize()`
`java.lang.String`	`getBwlimit()`
`int`	`getChecksumSeed()`
`java.lang.String`	`getChmod()`
`java.lang.String`	`getChown()`
`java.lang.String[]`	`getCompareDest()`
`int`	`getCompressLevel()`
`int`	`getContimeout()`
`java.lang.String[]`	`getCopyDest()`
`java.lang.String`	`getDebug()`
`java.lang.String`	`getDestination()` Returns the current destination path/url.
`java.lang.String[]`	`getExclude()`
`java.lang.String[]`	`getExcludeFrom()`
`java.lang.String`	`getFilesFrom()`
`java.lang.String[]`	`getFilter()`
`java.lang.String`	`getGroupmap()`
`java.lang.String`	`getIconv()`
`java.lang.String[]`	`getInclude()`
`protected java.lang.String[]`	`getIncludeExclude()`
`java.lang.String[]`	`getIncludeFrom()`
`java.lang.String`	`getInfo()`
`java.lang.String[]`	`getLinkDest()`
`java.lang.String`	`getLogFile()`
`java.lang.String`	`getLogFileFormat()`
`int`	`getMaxDelete()`
`java.lang.String`	`getMaxSize()`
`java.lang.String`	`getMinSize()`
`int`	`getModifyWindow()`
`java.lang.String`	`getOnlyWriteBatch()`
`char`	`getOutbuf()`
`java.lang.String`	`getOutFormat()`
`protected net.sourceforge.argparse4j.inf.ArgumentParser`	`getParser()` Configures and returns the commandline parser.
`java.lang.String`	`getPartialDir()`
`java.lang.String`	`getPasswordFile()`
`int`	`getPort()`
`int`	`getProtocol()`
`java.lang.String`	`getReadBatch()`
`java.lang.String`	`getRemoteOption()`
`java.lang.String`	`getRsh()`
`java.lang.String`	`getRsyncPath()`
`java.lang.String`	`getSkipCompress()`
`java.lang.String`	`getSockopts()`
`java.util.List<java.lang.String>`	`getSources()` Returns the current source paths/urls.
`java.lang.String`	`getSuffix()`
`java.lang.String`	`getTempDir()`
`int`	`getTimeout()`
`java.lang.String`	`getUsermap()`
`java.lang.String`	`getWriteBatch()`
`RSync`	`group(boolean group)`
`RSync`	`groupmap(java.lang.String groupmap)`
`RSync`	`hardLinks(boolean hard_links)`
`RSync`	`humanReadable(boolean human_readable)`
`RSync`	`iconv(java.lang.String iconv)`
`RSync`	`ignoreErrors(boolean ignore_errors)`
`RSync`	`ignoreExisting(boolean ignore_existing)`
`RSync`	`ignoreMissingArgs(boolean ignore_missing_args)`
`RSync`	`ignoreTimes(boolean ignore_times)`
`RSync`	`include(java.lang.String... include)`
`protected java.lang.String[]`	`includeExcludeSubset(java.lang.String id)` Returns a subset of the include/exclude list.
`RSync`	`includeFrom(java.lang.String... include_from)`
`RSync`	`info(java.lang.String info)`
`RSync`	`inplace(boolean inplace)`
`RSync`	`ipv4(boolean ipv4)`
`RSync`	`ipv6(boolean ipv6)`
`boolean`	`isAppend()`
`boolean`	`isAppendVerify()`
`boolean`	`isArchive()`
`boolean`	`isBackup()`
`boolean`	`isBlockingIO()`
`boolean`	`isChecksum()`
`boolean`	`isCompress()`
`boolean`	`isCopyDirlinks()`
`boolean`	`isCopyLinks()`
`boolean`	`isCopyUnsafeLinks()`
`boolean`	`isCvsExclude()`
`boolean`	`isDelayUpdates()`
`boolean`	`isDelete()`
`boolean`	`isDeleteAfter()`
`boolean`	`isDeleteBefore()`
`boolean`	`isDeleteDelay()`
`boolean`	`isDeleteDuring()`
`boolean`	`isDeleteExcluded()`
`boolean`	`isDeleteMissingArgs()`
`boolean`	`isDevices()`
`boolean`	`isDirs()`
`boolean`	`isDryRun()`
`boolean`	`isEightBitOutput()`
`boolean`	`isExecutability()`
`boolean`	`isExisting()`
`boolean`	`isFakeSuper()`
`boolean`	`isForce()`
`boolean`	`isFrom0()`
`boolean`	`isFuzzy()`
`boolean`	`isGroup()`
`boolean`	`isHardLinks()`
`boolean`	`isHumanReadable()`
`boolean`	`isIgnoreErrors()`
`boolean`	`isIgnoreExisting()`
`boolean`	`isIgnoreMissingArgs()`
`boolean`	`isIgnoreTimes()`
`boolean`	`isInplace()`
`boolean`	`isIpv4()`
`boolean`	`isIpv6()`
`boolean`	`isItemizeChanges()`
`boolean`	`isKeepDirlinks()`
`boolean`	`isLinks()`
`boolean`	`isListOnly()`
`boolean`	`isMsgs2stderr()`
`boolean`	`isMungeLinks()`
`boolean`	`isNoImpliedDirs()`
`boolean`	`isNoMotd()`
`boolean`	`isNumericIds()`
`boolean`	`isOmitDirTimes()`
`boolean`	`isOmitLinkTimes()`
`boolean`	`isOneFileSystem()`
`boolean`	`isOwner()`
`boolean`	`isPartial()`
`boolean`	`isPerms()`
`boolean`	`isPreallocate()`
`boolean`	`isProgress()`
`boolean`	`isProtectArgs()`
`boolean`	`isPruneEmptyDirs()`
`boolean`	`isQuiet()`
`boolean`	`isRecursive()`
`boolean`	`isRelative()`
`boolean`	`isRemoveSourceFiles()`
`boolean`	`isSafeLinks()`
`boolean`	`isSizeOnly()`
`boolean`	`isSparse()`
`boolean`	`isSpecials()`
`boolean`	`isStats()`
`boolean`	`isSuper_()`
`boolean`	`isTimes()`
`boolean`	`isUpdate()`
`boolean`	`isVerbose()`
`boolean`	`isVersion()`
`boolean`	`isWholeFile()`
`boolean`	`isXattrs()`
`RSync`	`itemizeChanges(boolean itemize_changes)`
`RSync`	`keepDirlinks(boolean keep_dirlinks)`
`RSync`	`linkDest(java.lang.String... link_dest)`
`RSync`	`links(boolean links)`
`RSync`	`listOnly(boolean list_only)`
`RSync`	`logFile(java.lang.String log_file)`
`RSync`	`logFileFormat(java.lang.String log_file_format)`
`static void`	`main(java.lang.String[] args)` For running from the command-line.
`RSync`	`maxDelete(int max_delete)`
`RSync`	`maxSize(java.lang.String max_size)`
`RSync`	`minSize(java.lang.String min_size)`
`RSync`	`modifyWindow(int modify_window)`
`RSync`	`msgs2stderr(boolean msgs2stderr)`
`RSync`	`mungeLinks(boolean munge_links)`
`RSync`	`noImpliedDirs(boolean no_implied_dirs)`
`RSync`	`noMotd(boolean no_motd)`
`RSync`	`numericIds(boolean numeric_ids)`
`RSync`	`omitDirTimes(boolean omit_dir_times)`
`RSync`	`omitLinkTimes(boolean omit_link_times)`
`RSync`	`oneFileSystem(boolean one_file_system)`
`RSync`	`onlyWriteBatch(java.lang.String only_write_batch)`
`java.util.List<java.lang.String>`	`options()` Assembles the arguments for the binary.
`RSync`	`outbuf(char outbuf)`
`RSync`	`outFormat(java.lang.String out_format)`
`RSync`	`outputCommandline(boolean value)` Sets output commandline flag.
`RSync`	`owner(boolean owner)`
`RSync`	`partial(boolean partial)`
`RSync`	`partialDir(java.lang.String partial_dir)`
`RSync`	`passwordFile(java.lang.String password_file)`
`RSync`	`perms(boolean perms)`
`RSync`	`port(int port)`
`RSync`	`preallocate(boolean preallocate)`
`RSync`	`progress(boolean progress)`
`RSync`	`protectArgs(boolean protect_args)`
`RSync`	`protocol(int protocol)`
`RSync`	`pruneEmptyDirs(boolean prune_empty_dirs)`
`RSync`	`quiet(boolean quiet)`
`RSync`	`readBatch(java.lang.String read_batch)`
`RSync`	`recursive(boolean recursive)`
`RSync`	`relative(boolean relative)`
`RSync`	`remoteOption(java.lang.String remote_option)`
`RSync`	`removeSourceFiles(boolean remove_source_files)`
`void`	`reset()` Resets the members.
`RSync`	`rsh(java.lang.String rsh)`
`RSync`	`rsyncPath(java.lang.String rsync_path)`
`RSync`	`safeLinks(boolean safe_links)`
`protected boolean`	`setOptions(net.sourceforge.argparse4j.inf.Namespace ns)` Sets the parsed options.
`RSync`	`sizeOnly(boolean size_only)`
`RSync`	`skipCompress(java.lang.String skip_compress)`
`RSync`	`sockopts(java.lang.String sockopts)`
`RSync`	`source(java.lang.String value)` Sets the source path/url.
`RSync`	`sources(java.util.List<java.lang.String> value)` Sets the source paths/urls.
`RSync`	`sources(java.lang.String[] value)` Sets the source paths/urls.
`RSync`	`sparse(boolean sparse)`
`RSync`	`specials(boolean specials)`
`RSync`	`stats(boolean stats)`
`RSync`	`suffix(java.lang.String suffix)`
`RSync`	`super_(boolean super_)`
`RSync`	`tempDir(java.lang.String temp_dir)`
`RSync`	`timeout(int timeout)`
`RSync`	`times(boolean times)`
`RSync`	`update(boolean update)`
`RSync`	`usermap(java.lang.String usermap)`
`RSync`	`verbose(boolean verbose)`
`RSync`	`version(boolean version)`
`RSync`	`wholeFile(boolean whole_file)`
`RSync`	`writeBatch(java.lang.String write_batch)`
`RSync`	`xattrs(boolean xattrs)`

Methods inherited from class com.github.fracpete.rsync4j.core.AbstractBinaryWithTimeout
execute, getMaxTime, maxTime

Methods inherited from class com.github.fracpete.rsync4j.core.AbstractBinary
builder, getOutputCommandline, run, setOptions, start

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

Field Detail

sources

protected java.util.List<java.lang.String> sources

the source path/url.

destination
```
protected java.lang.String destination
```
the destination path/url.

verbose
```
protected boolean verbose
```

info
```
protected java.lang.String info
```

debug
```
protected java.lang.String debug
```

msgs2stderr
```
protected boolean msgs2stderr
```

quiet
```
protected boolean quiet
```

no_motd
```
protected boolean no_motd
```

checksum
```
protected boolean checksum
```

archive
```
protected boolean archive
```

recursive
```
protected boolean recursive
```

relative
```
protected boolean relative
```

no_implied_dirs
```
protected boolean no_implied_dirs
```

backup
```
protected boolean backup
```

backup_dir
```
protected java.lang.String backup_dir
```

suffix
```
protected java.lang.String suffix
```

update
```
protected boolean update
```

inplace
```
protected boolean inplace
```

append
```
protected boolean append
```

append_verify
```
protected boolean append_verify
```

dirs
```
protected boolean dirs
```

links
```
protected boolean links
```

copy_links
```
protected boolean copy_links
```

copy_unsafe_links
```
protected boolean copy_unsafe_links
```

safe_links
```
protected boolean safe_links
```

munge_links
```
protected boolean munge_links
```

copy_dirlinks
```
protected boolean copy_dirlinks
```

keep_dirlinks
```
protected boolean keep_dirlinks
```

hard_links
```
protected boolean hard_links
```

perms
```
protected boolean perms
```

executability
```
protected boolean executability
```

chmod
```
protected java.lang.String chmod
```

xattrs
```
protected boolean xattrs
```

owner
```
protected boolean owner
```

group
```
protected boolean group
```

devices
```
protected boolean devices
```

specials
```
protected boolean specials
```

times
```
protected boolean times
```

omit_dir_times
```
protected boolean omit_dir_times
```

omit_link_times
```
protected boolean omit_link_times
```

super_
```
protected boolean super_
```

fake_super
```
protected boolean fake_super
```

sparse
```
protected boolean sparse
```

preallocate
```
protected boolean preallocate
```

dry_run
```
protected boolean dry_run
```

whole_file
```
protected boolean whole_file
```

one_file_system
```
protected boolean one_file_system
```

block_size
```
protected java.lang.String block_size
```

rsh
```
protected java.lang.String rsh
```

rsync_path
```
protected java.lang.String rsync_path
```

existing
```
protected boolean existing
```

ignore_existing
```
protected boolean ignore_existing
```

remove_source_files
```
protected boolean remove_source_files
```

delete
```
protected boolean delete
```

delete_before
```
protected boolean delete_before
```

delete_during
```
protected boolean delete_during
```

delete_delay
```
protected boolean delete_delay
```

delete_after
```
protected boolean delete_after
```

delete_excluded
```
protected boolean delete_excluded
```

ignore_missing_args
```
protected boolean ignore_missing_args
```

delete_missing_args
```
protected boolean delete_missing_args
```

ignore_errors
```
protected boolean ignore_errors
```

force
```
protected boolean force
```

max_delete
```
protected int max_delete
```

max_size
```
protected java.lang.String max_size
```

min_size
```
protected java.lang.String min_size
```

partial
```
protected boolean partial
```

partial_dir
```
protected java.lang.String partial_dir
```

delay_updates
```
protected boolean delay_updates
```

prune_empty_dirs
```
protected boolean prune_empty_dirs
```

numeric_ids
```
protected boolean numeric_ids
```

usermap
```
protected java.lang.String usermap
```

groupmap
```
protected java.lang.String groupmap
```

chown
```
protected java.lang.String chown
```

timeout
```
protected int timeout
```

contimeout
```
protected int contimeout
```

ignore_times
```
protected boolean ignore_times
```

remote_option

protected java.lang.String remote_option

size_only
```
protected boolean size_only
```

modify_window
```
protected int modify_window
```

temp_dir
```
protected java.lang.String temp_dir
```

fuzzy
```
protected boolean fuzzy
```

compare_dest

protected java.lang.String[] compare_dest

copy_dest
```
protected java.lang.String[] copy_dest
```

link_dest
```
protected java.lang.String[] link_dest
```

compress
```
protected boolean compress
```

compress_level
```
protected int compress_level
```

skip_compress

protected java.lang.String skip_compress

cvs_exclude
```
protected boolean cvs_exclude
```

include_exclude

protected java.util.List<java.lang.String> include_exclude

files_from
```
protected java.lang.String files_from
```

from0
```
protected boolean from0
```

protect_args
```
protected boolean protect_args
```

address
```
protected java.lang.String address
```

port
```
protected int port
```

sockopts
```
protected java.lang.String sockopts
```

blocking_io
```
protected boolean blocking_io
```

stats
```
protected boolean stats
```

eight_bit_output
```
protected boolean eight_bit_output
```

human_readable
```
protected boolean human_readable
```

progress
```
protected boolean progress
```

itemize_changes
```
protected boolean itemize_changes
```

out_format
```
protected java.lang.String out_format
```

log_file
```
protected java.lang.String log_file
```

log_file_format

protected java.lang.String log_file_format

password_file

protected java.lang.String password_file

list_only
```
protected boolean list_only
```

bwlimit
```
protected java.lang.String bwlimit
```

outbuf
```
protected char outbuf
```

write_batch
```
protected java.lang.String write_batch
```

only_write_batch

protected java.lang.String only_write_batch

read_batch
```
protected java.lang.String read_batch
```

protocol
```
protected int protocol
```

iconv
```
protected java.lang.String iconv
```

checksum_seed
```
protected int checksum_seed
```

ipv4
```
protected boolean ipv4
```

ipv6
```
protected boolean ipv6
```

version
```
protected boolean version
```

additional

protected java.lang.String[] additional

Constructor Detail
- RSync
```
public RSync()
```

Method Detail

reset
```
public void reset()
```
Resets the members.

Overrides:

reset in class AbstractBinaryWithTimeout

source
```
public RSync source(java.lang.String value)
```
Sets the source path/url.

Parameters:

value - the source

sources
```
public RSync sources(java.lang.String[] value)
```
Sets the source paths/urls.

Parameters:

value - the sources

sources

public RSync sources(java.util.List<java.lang.String> value)

Sets the source paths/urls.

Parameters:: value - the sources

getSources
```
public java.util.List<java.lang.String> getSources()
```
Returns the current source paths/urls.

Returns:

the sources, empty list if not set

destination
```
public RSync destination(java.lang.String value)
```
Sets the destination path/url.

Parameters:

value - the destination

Returns:

itself

getDestination
```
public java.lang.String getDestination()
```
Returns the current destination path/url.

Returns:

the destination, null if not set

outputCommandline
```
public RSync outputCommandline(boolean value)
```
Sets output commandline flag.

Overrides:

outputCommandline in class AbstractBinary

Parameters:

value - true if to output commandline

Returns:

itself

isVerbose
```
public boolean isVerbose()
```

verbose

public RSync verbose(boolean verbose)

getInfo
```
public java.lang.String getInfo()
```

info

public RSync info(java.lang.String info)

getDebug
```
public java.lang.String getDebug()
```

debug

public RSync debug(java.lang.String debug)

isMsgs2stderr
```
public boolean isMsgs2stderr()
```

msgs2stderr

public RSync msgs2stderr(boolean msgs2stderr)

isQuiet
```
public boolean isQuiet()
```

quiet
```
public RSync quiet(boolean quiet)
```

isNoMotd
```
public boolean isNoMotd()
```

noMotd
```
public RSync noMotd(boolean no_motd)
```

isChecksum
```
public boolean isChecksum()
```

checksum

public RSync checksum(boolean checksum)

isArchive
```
public boolean isArchive()
```

recursive

public RSync recursive(boolean recursive)

isRelative
```
public boolean isRelative()
```

relative

public RSync relative(boolean relative)

isNoImpliedDirs
```
public boolean isNoImpliedDirs()
```

noImpliedDirs

public RSync noImpliedDirs(boolean no_implied_dirs)

isBackup
```
public boolean isBackup()
```

backup
```
public RSync backup(boolean backup)
```

getBackupDir

public java.lang.String getBackupDir()

backupDir

public RSync backupDir(java.lang.String backup_dir)

getSuffix
```
public java.lang.String getSuffix()
```

suffix

public RSync suffix(java.lang.String suffix)

isUpdate
```
public boolean isUpdate()
```

update
```
public RSync update(boolean update)
```

isInplace
```
public boolean isInplace()
```

inplace

public RSync inplace(boolean inplace)

isAppend
```
public boolean isAppend()
```

append
```
public RSync append(boolean append)
```

isAppendVerify
```
public boolean isAppendVerify()
```

appendVerify

public RSync appendVerify(boolean append_verify)

isDirs
```
public boolean isDirs()
```

dirs
```
public RSync dirs(boolean dirs)
```

isLinks
```
public boolean isLinks()
```

links
```
public RSync links(boolean links)
```

isCopyLinks
```
public boolean isCopyLinks()
```

copyLinks

public RSync copyLinks(boolean copy_links)

isCopyUnsafeLinks
```
public boolean isCopyUnsafeLinks()
```

copyUnsafeLinks

public RSync copyUnsafeLinks(boolean copy_unsafe_links)

isSafeLinks
```
public boolean isSafeLinks()
```

safeLinks

public RSync safeLinks(boolean safe_links)

isMungeLinks
```
public boolean isMungeLinks()
```

mungeLinks

public RSync mungeLinks(boolean munge_links)

isCopyDirlinks
```
public boolean isCopyDirlinks()
```

copyDirlinks

public RSync copyDirlinks(boolean copy_dirlinks)

isKeepDirlinks
```
public boolean isKeepDirlinks()
```

keepDirlinks

public RSync keepDirlinks(boolean keep_dirlinks)

isHardLinks
```
public boolean isHardLinks()
```

hardLinks

public RSync hardLinks(boolean hard_links)

isPerms
```
public boolean isPerms()
```

perms
```
public RSync perms(boolean perms)
```

isExecutability
```
public boolean isExecutability()
```

executability

public RSync executability(boolean executability)

getChmod
```
public java.lang.String getChmod()
```

chmod

public RSync chmod(java.lang.String chmod)

isXattrs
```
public boolean isXattrs()
```

xattrs
```
public RSync xattrs(boolean xattrs)
```

isOwner
```
public boolean isOwner()
```

owner
```
public RSync owner(boolean owner)
```

isGroup
```
public boolean isGroup()
```

group
```
public RSync group(boolean group)
```

isDevices
```
public boolean isDevices()
```

devices

public RSync devices(boolean devices)

isSpecials
```
public boolean isSpecials()
```

specials

public RSync specials(boolean specials)

isTimes
```
public boolean isTimes()
```

times
```
public RSync times(boolean times)
```

isOmitDirTimes
```
public boolean isOmitDirTimes()
```

omitDirTimes

public RSync omitDirTimes(boolean omit_dir_times)

isOmitLinkTimes
```
public boolean isOmitLinkTimes()
```

omitLinkTimes

public RSync omitLinkTimes(boolean omit_link_times)

isSuper_
```
public boolean isSuper_()
```

super_
```
public RSync super_(boolean super_)
```

isFakeSuper
```
public boolean isFakeSuper()
```

fakeSuper

public RSync fakeSuper(boolean fake_super)

isSparse
```
public boolean isSparse()
```

sparse
```
public RSync sparse(boolean sparse)
```

isPreallocate
```
public boolean isPreallocate()
```

preallocate

public RSync preallocate(boolean preallocate)

isDryRun
```
public boolean isDryRun()
```

dryRun
```
public RSync dryRun(boolean dry_run)
```

isWholeFile
```
public boolean isWholeFile()
```

wholeFile

public RSync wholeFile(boolean whole_file)

isOneFileSystem
```
public boolean isOneFileSystem()
```

oneFileSystem

public RSync oneFileSystem(boolean one_file_system)

getBlockSize

public java.lang.String getBlockSize()

blockSize

public RSync blockSize(java.lang.String block_size)

getRsh
```
public java.lang.String getRsh()
```

rsh

public RSync rsh(java.lang.String rsh)

getRsyncPath

public java.lang.String getRsyncPath()

rsyncPath

public RSync rsyncPath(java.lang.String rsync_path)

isExisting
```
public boolean isExisting()
```

existing

public RSync existing(boolean existing)

isIgnoreExisting
```
public boolean isIgnoreExisting()
```

ignoreExisting

public RSync ignoreExisting(boolean ignore_existing)

isRemoveSourceFiles
```
public boolean isRemoveSourceFiles()
```

removeSourceFiles

public RSync removeSourceFiles(boolean remove_source_files)

isDelete
```
public boolean isDelete()
```

delete
```
public RSync delete(boolean delete)
```

isDeleteBefore
```
public boolean isDeleteBefore()
```

deleteBefore

public RSync deleteBefore(boolean delete_before)

isDeleteDuring
```
public boolean isDeleteDuring()
```

deleteDuring

public RSync deleteDuring(boolean delete_during)

isDeleteDelay
```
public boolean isDeleteDelay()
```

deleteDelay

public RSync deleteDelay(boolean delete_delay)

isDeleteAfter
```
public boolean isDeleteAfter()
```

deleteAfter

public RSync deleteAfter(boolean delete_after)

isDeleteExcluded
```
public boolean isDeleteExcluded()
```

deleteExcluded

public RSync deleteExcluded(boolean delete_excluded)

isIgnoreMissingArgs
```
public boolean isIgnoreMissingArgs()
```

ignoreMissingArgs

public RSync ignoreMissingArgs(boolean ignore_missing_args)

isDeleteMissingArgs
```
public boolean isDeleteMissingArgs()
```

deleteMissingArgs

public RSync deleteMissingArgs(boolean delete_missing_args)

isIgnoreErrors
```
public boolean isIgnoreErrors()
```

ignoreErrors

public RSync ignoreErrors(boolean ignore_errors)

isForce
```
public boolean isForce()
```

force
```
public RSync force(boolean force)
```

getMaxDelete
```
public int getMaxDelete()
```

maxDelete

public RSync maxDelete(int max_delete)

getMaxSize
```
public java.lang.String getMaxSize()
```

maxSize

public RSync maxSize(java.lang.String max_size)

getMinSize
```
public java.lang.String getMinSize()
```

minSize

public RSync minSize(java.lang.String min_size)

isPartial
```
public boolean isPartial()
```

partial

public RSync partial(boolean partial)

getPartialDir

public java.lang.String getPartialDir()

partialDir

public RSync partialDir(java.lang.String partial_dir)

isDelayUpdates
```
public boolean isDelayUpdates()
```

delayUpdates

public RSync delayUpdates(boolean delay_updates)

isPruneEmptyDirs
```
public boolean isPruneEmptyDirs()
```

pruneEmptyDirs

public RSync pruneEmptyDirs(boolean prune_empty_dirs)

isNumericIds
```
public boolean isNumericIds()
```

numericIds

public RSync numericIds(boolean numeric_ids)

getUsermap
```
public java.lang.String getUsermap()
```

usermap

public RSync usermap(java.lang.String usermap)

getGroupmap
```
public java.lang.String getGroupmap()
```

groupmap

public RSync groupmap(java.lang.String groupmap)

getChown
```
public java.lang.String getChown()
```

chown

public RSync chown(java.lang.String chown)

getTimeout
```
public int getTimeout()
```

timeout
```
public RSync timeout(int timeout)
```

getContimeout
```
public int getContimeout()
```

contimeout

public RSync contimeout(int contimeout)

isIgnoreTimes
```
public boolean isIgnoreTimes()
```

ignoreTimes

public RSync ignoreTimes(boolean ignore_times)

getRemoteOption

public java.lang.String getRemoteOption()

remoteOption

public RSync remoteOption(java.lang.String remote_option)

isSizeOnly
```
public boolean isSizeOnly()
```

sizeOnly

public RSync sizeOnly(boolean size_only)

getModifyWindow
```
public int getModifyWindow()
```

modifyWindow

public RSync modifyWindow(int modify_window)

getTempDir
```
public java.lang.String getTempDir()
```

tempDir

public RSync tempDir(java.lang.String temp_dir)

isFuzzy
```
public boolean isFuzzy()
```

fuzzy
```
public RSync fuzzy(boolean fuzzy)
```

getCompareDest

public java.lang.String[] getCompareDest()

compareDest

public RSync compareDest(java.lang.String... compare_dest)

getCopyDest

public java.lang.String[] getCopyDest()

copyDest

public RSync copyDest(java.lang.String... copy_dest)

getLinkDest

public java.lang.String[] getLinkDest()

linkDest

public RSync linkDest(java.lang.String... link_dest)

isCompress
```
public boolean isCompress()
```

compress

public RSync compress(boolean compress)

getCompressLevel
```
public int getCompressLevel()
```

compressLevel

public RSync compressLevel(int compress_level)

getSkipCompress

public java.lang.String getSkipCompress()

skipCompress

public RSync skipCompress(java.lang.String skip_compress)

isCvsExclude
```
public boolean isCvsExclude()
```

cvsExclude

public RSync cvsExclude(boolean cvs_exclude)

getFilter
```
public java.lang.String[] getFilter()
```

filter

public RSync filter(java.lang.String... filter)

includeExcludeSubset
```
protected java.lang.String[] includeExcludeSubset(java.lang.String id)
```
Returns a subset of the include/exclude list.

Parameters:

id - the subset to retrieve (I, E, IF, EF, F for include, exclude, include-from, exclude-from, filter)

Returns:

the subset

addIncludeExclude
```
protected RSync addIncludeExclude(java.lang.String id,
                                  java.lang.String... list)
```
Adds a list of include/exclude items.

Parameters:

id - the subset to retrieve (I, E, IF, EF, F for include, exclude, include-from, exclude-from, filter)

list - the items to add

Returns:

itself

getIncludeExclude

protected java.lang.String[] getIncludeExclude()

getExclude

public java.lang.String[] getExclude()

exclude

public RSync exclude(java.lang.String... exclude)

getExcludeFrom

public java.lang.String[] getExcludeFrom()

excludeFrom

public RSync excludeFrom(java.lang.String... exclude_from)

getInclude

public java.lang.String[] getInclude()

include

public RSync include(java.lang.String... include)

getIncludeFrom

public java.lang.String[] getIncludeFrom()

includeFrom

public RSync includeFrom(java.lang.String... include_from)

getFilesFrom

public java.lang.String getFilesFrom()

filesFrom

public RSync filesFrom(java.lang.String files_from)

isFrom0
```
public boolean isFrom0()
```

from0
```
public RSync from0(boolean from0)
```

isProtectArgs
```
public boolean isProtectArgs()
```

protectArgs

public RSync protectArgs(boolean protect_args)

getAddress
```
public java.lang.String getAddress()
```

address

public RSync address(java.lang.String address)

getPort
```
public int getPort()
```

port
```
public RSync port(int port)
```

getSockopts
```
public java.lang.String getSockopts()
```

sockopts

public RSync sockopts(java.lang.String sockopts)

isBlockingIO
```
public boolean isBlockingIO()
```

blockingIO

public RSync blockingIO(boolean blocking_io)

isStats
```
public boolean isStats()
```

stats
```
public RSync stats(boolean stats)
```

isEightBitOutput
```
public boolean isEightBitOutput()
```

eightBitOutput

public RSync eightBitOutput(boolean eight_bit_output)

isHumanReadable
```
public boolean isHumanReadable()
```

humanReadable

public RSync humanReadable(boolean human_readable)

isProgress
```
public boolean isProgress()
```

progress

public RSync progress(boolean progress)

isItemizeChanges
```
public boolean isItemizeChanges()
```

itemizeChanges

public RSync itemizeChanges(boolean itemize_changes)

getOutFormat

public java.lang.String getOutFormat()

outFormat

public RSync outFormat(java.lang.String out_format)

getLogFile
```
public java.lang.String getLogFile()
```

logFile

public RSync logFile(java.lang.String log_file)

getLogFileFormat

public java.lang.String getLogFileFormat()

logFileFormat

public RSync logFileFormat(java.lang.String log_file_format)

getPasswordFile

public java.lang.String getPasswordFile()

passwordFile

public RSync passwordFile(java.lang.String password_file)

isListOnly
```
public boolean isListOnly()
```

listOnly

public RSync listOnly(boolean list_only)

getBwlimit
```
public java.lang.String getBwlimit()
```

bwlimit

public RSync bwlimit(java.lang.String bwlimit)

getOutbuf
```
public char getOutbuf()
```

outbuf
```
public RSync outbuf(char outbuf)
```

getWriteBatch

public java.lang.String getWriteBatch()

writeBatch

public RSync writeBatch(java.lang.String write_batch)

getOnlyWriteBatch

public java.lang.String getOnlyWriteBatch()

onlyWriteBatch

public RSync onlyWriteBatch(java.lang.String only_write_batch)

getReadBatch

public java.lang.String getReadBatch()

readBatch

public RSync readBatch(java.lang.String read_batch)

getProtocol
```
public int getProtocol()
```

protocol
```
public RSync protocol(int protocol)
```

getIconv
```
public java.lang.String getIconv()
```

iconv

public RSync iconv(java.lang.String iconv)

getChecksumSeed
```
public int getChecksumSeed()
```

checksumSeed

public RSync checksumSeed(int checksum_seed)

isIpv4
```
public boolean isIpv4()
```

ipv4
```
public RSync ipv4(boolean ipv4)
```

isIpv6
```
public boolean isIpv6()
```

ipv6
```
public RSync ipv6(boolean ipv6)
```

isVersion
```
public boolean isVersion()
```

version

public RSync version(boolean version)

getAdditional

public java.lang.String[] getAdditional()

additional
```
public RSync additional(java.lang.String... additional)
```
Automatically replaces leading "+" and "++" with corresponding "-" and "--".

Parameters:

additional - the additional parameters

Returns:

itself

options
```
public java.util.List<java.lang.String> options()
                                         throws java.lang.Exception
```
Assembles the arguments for the binary.

Specified by:

options in class AbstractBinary

Returns:

the options

Throws:

java.lang.Exception - if failed to determine binary

commandLineArgs
```
public java.util.List<java.lang.String> commandLineArgs()
                                                 throws java.lang.Exception
```
Assembles the full command-line arguments.

Specified by:

commandLineArgs in class AbstractBinary

Returns:

the command-line arguments

Throws:

java.lang.Exception - if failed to determine binary

See Also:

options()

description
```
protected java.lang.String description()
```
Returns a short description for the binary.

Specified by:

description in class AbstractBinary

Returns:

the description

getParser
```
protected net.sourceforge.argparse4j.inf.ArgumentParser getParser()
```
Configures and returns the commandline parser.

Overrides:

getParser in class AbstractBinaryWithTimeout

Returns:

the parser

setOptions
```
protected boolean setOptions(net.sourceforge.argparse4j.inf.Namespace ns)
```
Sets the parsed options.

Overrides:

setOptions in class AbstractBinaryWithTimeout

Parameters:

ns - the parsed options

Returns:

if successfully set

main

public static void main(java.lang.String[] args)
                 throws java.lang.Exception

For running from the command-line.

Parameters:: args - the arguments
Throws:: java.lang.Exception

Class RSync

Field Summary

Fields inherited from class com.github.fracpete.rsync4j.core.AbstractBinaryWithTimeout

Fields inherited from class com.github.fracpete.rsync4j.core.AbstractBinary

Constructor Summary

Method Summary

Methods inherited from class com.github.fracpete.rsync4j.core.AbstractBinaryWithTimeout

Methods inherited from class com.github.fracpete.rsync4j.core.AbstractBinary

Methods inherited from class java.lang.Object

Field Detail

sources

destination

verbose

info

debug

msgs2stderr

quiet

no_motd

checksum

archive

recursive

relative

no_implied_dirs

backup

backup_dir

suffix

update

inplace

append

append_verify

dirs

links

copy_links

copy_unsafe_links

safe_links

munge_links

copy_dirlinks

keep_dirlinks

hard_links

perms

executability

chmod

xattrs

owner

group

devices

specials

times

omit_dir_times

omit_link_times

super_

fake_super

sparse

preallocate

dry_run

whole_file

one_file_system

block_size

rsh

rsync_path

existing

ignore_existing

remove_source_files

delete

delete_before

delete_during

delete_delay

delete_after

delete_excluded

ignore_missing_args

delete_missing_args

ignore_errors

force

max_delete

max_size

min_size

partial

partial_dir

delay_updates

prune_empty_dirs