FsOutputOption (TrueZIP Kernel 7.6.6 API)

java.lang.Object
- java.lang.Enum<FsOutputOption>
- - de.schlichtherle.truezip.fs.FsOutputOption

All Implemented Interfaces:

Serializable, Comparable<FsOutputOption>
```
@Immutable
public enum FsOutputOption
extends Enum<FsOutputOption>
```
Defines options for output operations. Not all options may be supported or available for all operations and certain combinations may even be illegal. It's up to the particular operation and file system driver implementation to define which options are supported and available. If an option is not supported, it must get silently ignored. If an option is not available or illegal, an IOException must get thrown.

Author:

Christian Schlichtherle

See Also:
FsInputOption, FsOutputOptions

Enum Constant Summary

Enum Constants
Enum Constant and Description
`APPEND` Whether or not the new entry contents shall get appended to the existing entry contents rather than replacing them entirely.
`CACHE` Whether or not the entry data read by an input socket shall get cached for subsequent access.
`COMPRESS` Expresses a preference to compress an entry within its archive.
`CREATE_PARENTS` Whether or not any missing parent directory entries shall get created automatically.
`ENCRYPT` Expresses a preference to encrypt archive entries when writing them to an archive file.
`EXCLUSIVE` Whether or not an entry must be exclusively created.
`GROW` Expresses a preference to allow an archive file to grow by appending any new or updated archive entry contents or meta data to its end.
`STORE` Expresses a preference to store an entry uncompressed within its archive.

Method Summary

Methods
Modifier and Type	Method and Description
`static FsOutputOption`	`valueOf(String name)` Returns the enum constant of this type with the specified name.
`static FsOutputOption[]`	`values()` Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum
clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Enum Constant Detail
  - APPEND
```
public static final FsOutputOption APPEND
```
    Whether or not the new entry contents shall get appended to the existing entry contents rather than replacing them entirely.
  - CACHE
```
public static final FsOutputOption CACHE
```
    Whether or not the entry data read by an input socket shall get cached for subsequent access. As a desired side effect, caching allows a file system controller to FsController.sync(de.schlichtherle.truezip.util.BitField<de.schlichtherle.truezip.fs.FsSyncOption>) the entry data to the backing storage (e.g. a parent file system) while some client is still busy on reading or writing the cached entry data.
  - COMPRESS
```
public static final FsOutputOption COMPRESS
```
    Expresses a preference to compress an entry within its archive.
    Note that this option may get ignored by archive file system drivers. Furthermore, if this happens, there may be no direct feedback available to the caller.
    
    Since:
    
    TrueZIP 7.1
  - CREATE_PARENTS
```
public static final FsOutputOption CREATE_PARENTS
```
    Whether or not any missing parent directory entries shall get created automatically.
  - ENCRYPT
```
public static final FsOutputOption ENCRYPT
```
    Expresses a preference to encrypt archive entries when writing them to an archive file.
    Note that this option may get ignored by archive file system drivers. Furthermore, if this happens, there may be no direct feedback available to the caller.
    
    Since:
    
    TrueZIP 7.3
  - EXCLUSIVE
```
public static final FsOutputOption EXCLUSIVE
```
    Whether or not an entry must be exclusively created.
  - GROW
```
public static final FsOutputOption GROW
```
    Expresses a preference to allow an archive file to grow by appending any new or updated archive entry contents or meta data to its end. Setting this option may produce redundant data in the resulting archive file. However, it may yield much better performance if the number and contents of the archive entries to create or update are rather small compared to the total size of the resulting archive file.
    This option is the equivalent to a multi-session disc (CD, DVD etc.) for archive files.
    Note that this option may get ignored by archive file system drivers. Furthermore, if this happens, there may be no direct feedback available to the caller.
    
    Since:
    
    TrueZIP 7.3
  - STORE
```
public static final FsOutputOption STORE
```
    Expresses a preference to store an entry uncompressed within its archive.
    Note that this option may get ignored by archive file system drivers. Furthermore, if this happens, there may be no direct feedback available to the caller.
    
    Since:
    
    TrueZIP 7.1
- Method Detail
  - valueOf
```
public static FsOutputOption valueOf(String name)
```
    Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)
    
    Parameters:
    name - the name of the enum constant to be returned.
    
    Returns:
    the enum constant with the specified name
    
    Throws:
    
    IllegalArgumentException - if this enum type has no constant with the specified name
    
    NullPointerException - if the argument is null
  - values
```
public static FsOutputOption[] values()
```
    Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:
```
for (FsOutputOption c : FsOutputOption.values())
    System.out.println(c);
```
    Returns:
    an array containing the constants of this enum type, in the order they are declared

Enum FsOutputOption

Enum Constant Summary

Method Summary

Methods inherited from class java.lang.Enum

Methods inherited from class java.lang.Object

Enum Constant Detail

APPEND

CACHE

COMPRESS

CREATE_PARENTS

ENCRYPT

EXCLUSIVE

GROW

STORE

Method Detail

valueOf

values