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

Field Summary

Modifier and Type	Field and Description
private boolean	append
private boolean	create
private boolean	createNew
public static final boolean	DEFAULT_APPEND Whether the file should be opened in append mode by default = false.
public static final boolean	DEFAULT_CREATE
public static final boolean	DEFAULT_CREATENEW
public static final boolean	DEFAULT_DELETEONCLOSE
public static final boolean	DEFAULT_DSYNC
public static final String	DEFAULT_PERMS
public static final boolean	DEFAULT_READ
public static final boolean	DEFAULT_SPARSE
public static final boolean	DEFAULT_SYNC
public static final boolean	DEFAULT_TRUNCATEEXISTING
public static final boolean	DEFAULT_WRITE
private boolean	deleteOnClose
private boolean	dsync
private String	perms
private boolean	read
private boolean	sparse
private boolean	sync
private boolean	truncateExisting
private boolean	write

Constructor Summary

Access	Constructor and Description
public	OpenOptions() Default constructor
public	OpenOptions(OpenOptions the options to copy other) Copy constructor
public	OpenOptions(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 String	Returns: the permissions string getPerms() Get the permissions string to be used if creating a file
public boolean	Returns: true if the file should be opened in append mode, false otherwise isAppend()
public boolean	Returns: true if the file should be created if it does not already exist isCreate() Should the file be created if it does not already exist?
public boolean	Returns: true if the file should be created if and the open fail if it already exists. isCreateNew() Should the file be created if and the open fail if it already exists?
public boolean	Returns: true if the file should be deleted when it's closed or the JVM shutdown isDeleteOnClose() Should the file be deleted when it's closed, or the JVM is shutdown.
public boolean	Returns: true if sync isDsync() If true then every write to the file's content will be written synchronously to the underlying hardware.
public boolean	Returns: true if to be opened for reading isRead() Is the file to opened for reading?
public boolean	Returns: true if a hint should be provided that the file to created is sparse isSparse() Set whether a hint should be provided that the file to created is sparse
public boolean	Returns: true if sync isSync() If true then every write to the file's content and metadata will be written synchronously to the underlying hardware.
public boolean	Returns: true if the file exists and is opened for writing and the file be truncated to zero length on open isTruncateExisting() If the file exists and is opened for writing should the file be truncated to zero length on open?
public boolean	Returns: true if to be opened for writing isWrite() Is the file to opened for writing?
public OpenOptions	Returns: a reference to this, so the API can be used fluently setAppend(boolean true to open file in append mode, false otherwise append) Whether the file should be opened in append mode.
public OpenOptions	Returns: a reference to this, so the API can be used fluently setCreate(boolean true if the file should be created if it does not already exist create) Set whether the file should be created if it does not already exist.
public OpenOptions	Returns: a reference to this, so the API can be used fluently setCreateNew(boolean true if the file should be created or fail if it exists already createNew) Set whether the file should be created and fail if it does exist already.
public OpenOptions	Returns: a reference to this, so the API can be used fluently setDeleteOnClose(boolean whether the file should be deleted when it's closed, or the JVM is shutdown. deleteOnClose) Set whether the file should be deleted when it's closed, or the JVM is shutdown.
public OpenOptions	Returns: a reference to this, so the API can be used fluently setDsync(boolean true if sync dsync) Set whether every write to the file's content will be written synchronously to the underlying hardware.
public OpenOptions	Returns: a reference to this, so the API can be used fluently setPerms(String the permissions string perms) Set the permissions string
public OpenOptions	Returns: a reference to this, so the API can be used fluently setRead(boolean true if the file is to be opened for reading read) Set whether the file is to be opened for reading
public OpenOptions	Returns: a reference to this, so the API can be used fluently setSparse(boolean true if a hint should be provided that the file to created is sparse sparse) Set whether a hint should be provided that the file to created is sparse
public OpenOptions	Returns: a reference to this, so the API can be used fluently setSync(boolean true if sync sync) Set whether every write to the file's content and meta-data will be written synchronously to the underlying hardware.
public OpenOptions	Returns: a reference to this, so the API can be used fluently setTruncateExisting(boolean true if the file should be truncated to zero length on opening if it exists and is opened for write truncateExisting) Set whether the file should be truncated to zero length on opening if it exists and is opened for write
public OpenOptions	Returns: a reference to this, so the API can be used fluently setWrite(boolean true if the file is to be opened for writing write) Set whether the file is to be opened for writing

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

Field Detail

append	back to summary
private boolean append

create	back to summary
private boolean create

createNew	back to summary
private boolean createNew

DEFAULT_APPEND	back to summary
public static final boolean DEFAULT_APPEND Whether the file should be opened in append mode by default = false.

DEFAULT_CREATE	back to summary
public static final boolean DEFAULT_CREATE

DEFAULT_CREATENEW	back to summary
public static final boolean DEFAULT_CREATENEW

DEFAULT_DELETEONCLOSE	back to summary
public static final boolean DEFAULT_DELETEONCLOSE

DEFAULT_DSYNC	back to summary
public static final boolean DEFAULT_DSYNC

DEFAULT_PERMS	back to summary
public static final String DEFAULT_PERMS

DEFAULT_READ	back to summary
public static final boolean DEFAULT_READ

DEFAULT_SPARSE	back to summary
public static final boolean DEFAULT_SPARSE

DEFAULT_SYNC	back to summary
public static final boolean DEFAULT_SYNC

DEFAULT_TRUNCATEEXISTING	back to summary
public static final boolean DEFAULT_TRUNCATEEXISTING

DEFAULT_WRITE	back to summary
public static final boolean DEFAULT_WRITE

deleteOnClose	back to summary
private boolean deleteOnClose

dsync	back to summary
private boolean dsync

perms	back to summary
private String perms

read	back to summary
private boolean read

sparse	back to summary
private boolean sparse

sync	back to summary
private boolean sync

truncateExisting	back to summary
private boolean truncateExisting

write	back to summary
private boolean write

Constructor Detail

OpenOptions	back to summary
public OpenOptions() Default constructor

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

OpenOptions

back to summary

public OpenOptions(OpenOptions other)

Copy constructor

Parameters

other:OpenOptions: the options to copy

OpenOptions back to summary

OpenOptions	back to summary
public OpenOptions(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 OpenOptions(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

getPerms	back to summary
public String getPerms() Get the permissions string to be used if creating a file Returns:String the permissions string

getPerms

back to summary

public String getPerms()

Get the permissions string to be used if creating a file

Returns:String: the permissions string

isAppend	back to summary
public boolean isAppend() Returns:boolean true if the file should be opened in append mode, false otherwise

isCreate	back to summary
public boolean isCreate() Should the file be created if it does not already exist? Returns:boolean true if the file should be created if it does not already exist

isCreate

back to summary

public boolean isCreate()

Should the file be created if it does not already exist?

Returns:boolean: true if the file should be created if it does not already exist

isCreateNew	back to summary
public boolean isCreateNew() Should the file be created if and the open fail if it already exists? Returns:boolean true if the file should be created if and the open fail if it already exists.

isCreateNew

back to summary

public boolean isCreateNew()

Should the file be created if and the open fail if it already exists?

Returns:boolean: true if the file should be created if and the open fail if it already exists.

isDeleteOnClose	back to summary
public boolean isDeleteOnClose() Should the file be deleted when it's closed, or the JVM is shutdown. Returns:boolean true if the file should be deleted when it's closed or the JVM shutdown

isDeleteOnClose

back to summary

public boolean isDeleteOnClose()

Should the file be deleted when it's closed, or the JVM is shutdown.

Returns:boolean: true if the file should be deleted when it's closed or the JVM shutdown

isDsync	back to summary
public boolean isDsync() If true then every write to the file's content will be written synchronously to the underlying hardware. Returns:boolean true if sync

isDsync

back to summary

public boolean isDsync()

If true then every write to the file's content will be written synchronously to the underlying hardware.

Returns:boolean: true if sync

isRead	back to summary
public boolean isRead() Is the file to opened for reading? Returns:boolean true if to be opened for reading

isRead

back to summary

public boolean isRead()

Is the file to opened for reading?

Returns:boolean: true if to be opened for reading

isSparse	back to summary
public boolean isSparse() Set whether a hint should be provided that the file to created is sparse Returns:boolean true if a hint should be provided that the file to created is sparse

isSparse

back to summary

public boolean isSparse()

Set whether a hint should be provided that the file to created is sparse

Returns:boolean: true if a hint should be provided that the file to created is sparse

isSync	back to summary
public boolean isSync() If true then every write to the file's content and metadata will be written synchronously to the underlying hardware. Returns:boolean true if sync

isSync

back to summary

public boolean isSync()

If true then every write to the file's content and metadata will be written synchronously to the underlying hardware.

Returns:boolean: true if sync

isTruncateExisting	back to summary
public boolean isTruncateExisting() If the file exists and is opened for writing should the file be truncated to zero length on open? Returns:boolean true if the file exists and is opened for writing and the file be truncated to zero length on open

isTruncateExisting

back to summary

public boolean isTruncateExisting()

If the file exists and is opened for writing should the file be truncated to zero length on open?

Returns:boolean: true if the file exists and is opened for writing and the file be truncated to zero length on open

isWrite	back to summary
public boolean isWrite() Is the file to opened for writing? Returns:boolean true if to be opened for writing

isWrite

back to summary

public boolean isWrite()

Is the file to opened for writing?

Returns:boolean: true if to be opened for writing

setAppend back to summary

setAppend	back to summary
public OpenOptions setAppend(boolean append) Whether the file should be opened in append mode. Defaults to `false`. Parameters append:boolean true to open file in append mode, false otherwise Returns:OpenOptions a reference to this, so the API can be used fluently

public OpenOptions setAppend(boolean append)

Whether the file should be opened in append mode. Defaults to false.

Parameters

append:boolean: true to open file in append mode, false otherwise

Returns:OpenOptions

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

setCreate	back to summary
public OpenOptions setCreate(boolean create) Set whether the file should be created if it does not already exist. Parameters create:boolean true if the file should be created if it does not already exist Returns:OpenOptions a reference to this, so the API can be used fluently

setCreate

back to summary

public OpenOptions setCreate(boolean create)

Set whether the file should be created if it does not already exist.

Parameters

create:boolean: true if the file should be created if it does not already exist

Returns:OpenOptions

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

setCreateNew	back to summary
public OpenOptions setCreateNew(boolean createNew) Set whether the file should be created and fail if it does exist already. Parameters createNew:boolean true if the file should be created or fail if it exists already Returns:OpenOptions a reference to this, so the API can be used fluently

setCreateNew

back to summary

public OpenOptions setCreateNew(boolean createNew)

Set whether the file should be created and fail if it does exist already.

Parameters

createNew:boolean: true if the file should be created or fail if it exists already

Returns:OpenOptions

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

setDeleteOnClose	back to summary
public OpenOptions setDeleteOnClose(boolean deleteOnClose) Set whether the file should be deleted when it's closed, or the JVM is shutdown. Parameters deleteOnClose:boolean whether the file should be deleted when it's closed, or the JVM is shutdown. Returns:OpenOptions a reference to this, so the API can be used fluently

setDeleteOnClose

back to summary

public OpenOptions setDeleteOnClose(boolean deleteOnClose)

Set whether the file should be deleted when it's closed, or the JVM is shutdown.

Parameters

deleteOnClose:boolean: whether the file should be deleted when it's closed, or the JVM is shutdown.

Returns:OpenOptions

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

setDsync	back to summary
public OpenOptions setDsync(boolean dsync) Set whether every write to the file's content will be written synchronously to the underlying hardware. Parameters dsync:boolean true if sync Returns:OpenOptions a reference to this, so the API can be used fluently

setDsync

back to summary

public OpenOptions setDsync(boolean dsync)

Set whether every write to the file's content will be written synchronously to the underlying hardware.

Parameters

dsync:boolean: true if sync

Returns:OpenOptions

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

setPerms	back to summary
public OpenOptions setPerms(String perms) Set the permissions string Parameters perms:String the permissions string Returns:OpenOptions a reference to this, so the API can be used fluently

setPerms

back to summary

public OpenOptions setPerms(String perms)

Set the permissions string

Parameters

perms:String: the permissions string

Returns:OpenOptions

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

setRead	back to summary
public OpenOptions setRead(boolean read) Set whether the file is to be opened for reading Parameters read:boolean true if the file is to be opened for reading Returns:OpenOptions a reference to this, so the API can be used fluently

setRead

back to summary

public OpenOptions setRead(boolean read)

Set whether the file is to be opened for reading

Parameters

read:boolean: true if the file is to be opened for reading

Returns:OpenOptions

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

setSparse	back to summary
public OpenOptions setSparse(boolean sparse) Set whether a hint should be provided that the file to created is sparse Parameters sparse:boolean true if a hint should be provided that the file to created is sparse Returns:OpenOptions a reference to this, so the API can be used fluently

setSparse

back to summary

public OpenOptions setSparse(boolean sparse)

Set whether a hint should be provided that the file to created is sparse

Parameters

sparse:boolean: true if a hint should be provided that the file to created is sparse

Returns:OpenOptions

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

setSync	back to summary
public OpenOptions setSync(boolean sync) Set whether every write to the file's content and meta-data will be written synchronously to the underlying hardware. Parameters sync:boolean true if sync Returns:OpenOptions a reference to this, so the API can be used fluently

setSync

back to summary

public OpenOptions setSync(boolean sync)

Set whether every write to the file's content and meta-data will be written synchronously to the underlying hardware.

Parameters

sync:boolean: true if sync

Returns:OpenOptions

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

setTruncateExisting	back to summary
public OpenOptions setTruncateExisting(boolean truncateExisting) Set whether the file should be truncated to zero length on opening if it exists and is opened for write Parameters truncateExisting:boolean true if the file should be truncated to zero length on opening if it exists and is opened for write Returns:OpenOptions a reference to this, so the API can be used fluently

setTruncateExisting

back to summary

public OpenOptions setTruncateExisting(boolean truncateExisting)

Set whether the file should be truncated to zero length on opening if it exists and is opened for write

Parameters

truncateExisting:boolean: true if the file should be truncated to zero length on opening if it exists and is opened for write

Returns:OpenOptions

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

setWrite	back to summary
public OpenOptions setWrite(boolean write) Set whether the file is to be opened for writing Parameters write:boolean true if the file is to be opened for writing Returns:OpenOptions a reference to this, so the API can be used fluently

setWrite

back to summary

public OpenOptions setWrite(boolean write)

Set whether the file is to be opened for writing

Parameters

write:boolean: true if the file is to be opened for writing

Returns:OpenOptions

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

public Class OpenOptions

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail