FsOutputOption (TrueZIP Kernel 7.1.3 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 the potential options for data 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 to define which options are supported and available. If an option is not supported, it must be silently ignored. If an option is not available, an IOException must be thrown.

Author:

Christian Schlichtherle

See Also:
FsInputOption, FsOutputOptions

Enum Constant Summary

Enum Constants
Enum Constant and Description
`APPEND` Whether or not the new entry data shall get appended to the existing entry data rather than replacing it entirely.
`CACHE` Whether or not the entry data read by an input socket shall get temporarily 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.
`EXCLUSIVE` Whether or not an entry must be exclusively created.
`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
  - CACHE
```
public static final FsOutputOption CACHE
```
    Whether or not the entry data read by an input socket shall get temporarily 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.
  - CREATE_PARENTS
```
public static final FsOutputOption CREATE_PARENTS
```
    Whether or not any missing parent directory entries shall get created automatically.
  - APPEND
```
public static final FsOutputOption APPEND
```
    Whether or not the new entry data shall get appended to the existing entry data rather than replacing it entirely.
  - EXCLUSIVE
```
public static final FsOutputOption EXCLUSIVE
```
    Whether or not an entry must be exclusively created. Not that this is not necessarily atomic, so it can't get used for file locking.
  - STORE
```
public static final FsOutputOption STORE
```
    Expresses a preference to store an entry uncompressed within its archive. This may get used or ignored by archive drivers.
  - COMPRESS
```
public static final FsOutputOption COMPRESS
```
    Expresses a preference to compress an entry within its archive. This may get used or ignored by archive drivers.
- Method Detail
  - 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
  - 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

Enum FsOutputOption

Enum Constant Summary

Method Summary

Methods inherited from class java.lang.Enum

Methods inherited from class java.lang.Object

Enum Constant Detail

CACHE

CREATE_PARENTS

APPEND

EXCLUSIVE

STORE

COMPRESS

Method Detail

values

valueOf