Vert.x 4.5.13 · io.vertx.core.file.CopyOptions · APIdia, the JavaDoc alternative

Field Summary

Modifier and Type	Field and Description
private boolean	atomicMove
private boolean	copyAttributes
public static final boolean	DEFAULT_ATOMIC_MOVE Whether move should be performed as an atomic filesystem operation by default = false.
public static final boolean	DEFAULT_COPY_ATTRIBUTES Whether the file attributes should be copied by default = false.
public static final boolean	DEFAULT_NOFOLLOW_LINKS Whether symbolic links should not be followed during copy or move operations by default = false.
public static final boolean	DEFAULT_REPLACE_EXISTING Whether an existing file, empty directory, or link should be replaced by default = false.
private boolean	nofollowLinks
private boolean	replaceExisting

Constructor Summary

Access	Constructor and Description
public	CopyOptions() Default constructor.
public	CopyOptions(CopyOptions the options to copy other) Copy constructor.
public	CopyOptions(JsonObject the JSON json) References Deprecated `JsonObject` is deprecated or references (maybe indirectly) at least one deprecated element. Constructor to create options from JSON.

Method Summary

Modifier and Type	Method and Description
public boolean	Returns: true if move should be performed as an atomic filesystem operation, false otherwise isAtomicMove()
public boolean	Returns: true if the file attributes should be copied, false otherwise isCopyAttributes()
public boolean	Returns: true if the operation should not follow links, false otherwise isNofollowLinks()
public boolean	Returns: true if an existing file, empty directory, or link should be replaced, false otherwise isReplaceExisting()
public CopyOptions	Returns: a reference to this, so the API can be used fluently setAtomicMove(boolean true to perform as an atomic filesystem operation, false otherwise atomicMove) Whether move should be performed as an atomic filesystem operation.
public CopyOptions	Returns: a reference to this, so the API can be used fluently setCopyAttributes(boolean true to copy attributes, false otherwise copyAttributes) Whether the file attributes should be copied.
public CopyOptions	Returns: a reference to this, so the API can be used fluently setNofollowLinks(boolean true to not follow links, false otherwise. Defaults to `false`. nofollowLinks) Whether symbolic links should not be followed during copy or move operations.
public CopyOptions	Returns: a reference to this, so the API can be used fluently setReplaceExisting(boolean true to replace, false otherwise replaceExisting) Whether an existing file, empty directory, or link should be replaced.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

atomicMove	back to summary
private boolean atomicMove

copyAttributes	back to summary
private boolean copyAttributes

DEFAULT_ATOMIC_MOVE	back to summary
public static final boolean DEFAULT_ATOMIC_MOVE Whether move should be performed as an atomic filesystem operation by default = false.

DEFAULT_COPY_ATTRIBUTES	back to summary
public static final boolean DEFAULT_COPY_ATTRIBUTES Whether the file attributes should be copied by default = false.

DEFAULT_NOFOLLOW_LINKS	back to summary
public static final boolean DEFAULT_NOFOLLOW_LINKS Whether symbolic links should not be followed during copy or move operations by default = false.

DEFAULT_REPLACE_EXISTING	back to summary
public static final boolean DEFAULT_REPLACE_EXISTING Whether an existing file, empty directory, or link should be replaced by default = false.

nofollowLinks	back to summary
private boolean nofollowLinks

replaceExisting	back to summary
private boolean replaceExisting

Constructor Detail

CopyOptions	back to summary
public CopyOptions() Default constructor.

CopyOptions	back to summary
public CopyOptions(CopyOptions other) Copy constructor. Parameters other:CopyOptions the options to copy

CopyOptions

back to summary

public CopyOptions(CopyOptions other)

Copy constructor.

Parameters

other:CopyOptions: the options to copy

CopyOptions back to summary

CopyOptions	back to summary
public CopyOptions(JsonObject json) References Deprecated `JsonObject` is deprecated or references (maybe indirectly) at least one deprecated element. See corresponding docs for further information. Constructor to create options from JSON. Parameters json:JsonObject the JSON

public CopyOptions(JsonObject json)

References Deprecated

JsonObject is deprecated or references (maybe indirectly) at least one deprecated element.

See corresponding docs for further information.

Constructor to create options from JSON.

Parameters

json:JsonObject: the JSON

Method Detail

isAtomicMove	back to summary
public boolean isAtomicMove() Returns:boolean true if move should be performed as an atomic filesystem operation, false otherwise

isCopyAttributes	back to summary
public boolean isCopyAttributes() Returns:boolean true if the file attributes should be copied, false otherwise

isNofollowLinks	back to summary
public boolean isNofollowLinks() Returns:boolean true if the operation should not follow links, false otherwise

isReplaceExisting	back to summary
public boolean isReplaceExisting() Returns:boolean true if an existing file, empty directory, or link should be replaced, false otherwise

setAtomicMove back to summary

setAtomicMove	back to summary
public CopyOptions setAtomicMove(boolean atomicMove) Whether move should be performed as an atomic filesystem operation. Defaults to `false`. Parameters atomicMove:boolean true to perform as an atomic filesystem operation, false otherwise Returns:CopyOptions a reference to this, so the API can be used fluently

public CopyOptions setAtomicMove(boolean atomicMove)

Whether move should be performed as an atomic filesystem operation. Defaults to false.

Parameters

atomicMove:boolean: true to perform as an atomic filesystem operation, false otherwise

Returns:CopyOptions

a reference to this, so the API can be used fluently

setCopyAttributes back to summary

setCopyAttributes	back to summary
public CopyOptions setCopyAttributes(boolean copyAttributes) Whether the file attributes should be copied. Defaults to `false`. Parameters copyAttributes:boolean true to copy attributes, false otherwise Returns:CopyOptions a reference to this, so the API can be used fluently

public CopyOptions setCopyAttributes(boolean copyAttributes)

Whether the file attributes should be copied. Defaults to false.

Parameters

copyAttributes:boolean: true to copy attributes, false otherwise

Returns:CopyOptions

a reference to this, so the API can be used fluently

setNofollowLinks back to summary

setNofollowLinks	back to summary
public CopyOptions setNofollowLinks(boolean nofollowLinks) Whether symbolic links should not be followed during copy or move operations. Defaults to `false`. Parameters nofollowLinks:boolean true to not follow links, false otherwise. Defaults to `false`. Returns:CopyOptions a reference to this, so the API can be used fluently

public CopyOptions setNofollowLinks(boolean nofollowLinks)

Whether symbolic links should not be followed during copy or move operations. Defaults to false.

Parameters

nofollowLinks:boolean: true to not follow links, false otherwise. Defaults to false.

Returns:CopyOptions

a reference to this, so the API can be used fluently

setReplaceExisting back to summary

setReplaceExisting	back to summary
public CopyOptions setReplaceExisting(boolean replaceExisting) Whether an existing file, empty directory, or link should be replaced. Defaults to `false`. Parameters replaceExisting:boolean true to replace, false otherwise Returns:CopyOptions a reference to this, so the API can be used fluently

public CopyOptions setReplaceExisting(boolean replaceExisting)

Whether an existing file, empty directory, or link should be replaced. Defaults to false.

Parameters

replaceExisting:boolean: true to replace, false otherwise

Returns:CopyOptions

a reference to this, so the API can be used fluently

public Class CopyOptions

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail