Describes how an AsyncFile should be opened.

  • OpenOptions
    • BaseDataObject
    • Basic
      • Identifiable
      • Object
        • Anything

no subtypes hierarchy

Initializer
OpenOptions(Boolean? append = null, Boolean? create = null, Boolean? createNew = null, Boolean? deleteOnClose = null, Boolean? dsync = null, String? perms = null, Boolean? read = null, Boolean? sparse = null, Boolean? sync = null, Boolean? truncateExisting = null, Boolean? write = null)
Parameters:
  • append = null

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

  • create = null

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

  • createNew = null

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

  • deleteOnClose = null

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

  • dsync = null

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

  • perms = null

    Set the permissions string

  • read = null

    Set whether the file is to be opened for reading

  • sparse = null

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

  • sync = null

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

  • truncateExisting = null

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

  • write = null

    Set whether the file is to be opened for writing

Attributes
appendshared Boolean? append

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

createshared Boolean? create

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

createNewshared Boolean? createNew

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

deleteOnCloseshared Boolean? deleteOnClose

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

dsyncshared Boolean? dsync

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

permsshared String? perms

Set the permissions string

readshared Boolean? read

Set whether the file is to be opened for reading

sparseshared Boolean? sparse

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

syncshared Boolean? sync

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

truncateExistingshared Boolean? truncateExisting

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

writeshared Boolean? write

Set whether the file is to be opened for writing

Inherited Attributes
Attributes inherited from: Object
hash, string
Methods
toJsonshared actual default JsonObject toJson()
Refines BaseDataObject.toJson
Inherited Methods
Methods inherited from: Object
equals
Methods inherited from: BaseDataObject
toJson