ArchivingStrategy (jhdf5 19.04.1 API)

java.lang.Object
- ch.systemsx.cisd.hdf5.h5ar.ArchivingStrategy

```
public class ArchivingStrategy
extends java.lang.Object
```
A class that represents a strategy for excluding files from archiving / extracting and for compressing files in the archive.

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class ArchivingStrategy.CompressionStrategy

Nested Classes
Modifier and Type	Class and Description
`static class`	`ArchivingStrategy.CompressionStrategy`

Field Summary

Fields
Modifier and Type	Field and Description
`static ArchivingStrategy`	`DEFAULT` The default strategy: include everything, compress all files except those known to be already compressed.
`static ArchivingStrategy`	`DEFAULT_NO_COMPRESSION` The default strategy without compression: include everything, compress nothing.
`static ArchivingStrategy`	`DEFAULT_WITH_COMPRESSION` An alias for the default strategy (kept for backward compatibility).

Constructor Summary

Constructors
Constructor and Description

ArchivingStrategy()

ArchivingStrategy(ArchivingStrategy template)

Constructors
Constructor and Description
`ArchivingStrategy()`
`ArchivingStrategy(ArchivingStrategy template)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`ArchivingStrategy`	`addToCompressionBlackList(java.util.regex.Pattern pattern)` Add the given `pattern` to the blacklist of files to store compressed in archive.
`ArchivingStrategy`	`addToCompressionBlackList(java.lang.String pattern)` Add the given `pattern` to the blacklist of files to store compressed in archive.
`ArchivingStrategy`	`addToCompressionWhiteList(java.util.regex.Pattern pattern)` Add the given `pattern` to the whitelist of files to store compressed in archive.
`ArchivingStrategy`	`addToCompressionWhiteList(java.lang.String pattern)` Add the given `pattern` to the whitelist of files to store compressed in archive.
`ArchivingStrategy`	`addToDirBlackList(java.util.regex.Pattern pattern)` Add the given `pattern` to the blacklist of directories to exclude from archiving.
`ArchivingStrategy`	`addToDirBlackList(java.lang.String pattern)` Add the given `pattern` to the blacklist of directories to exclude from archiving.
`ArchivingStrategy`	`addToDirWhiteList(java.util.regex.Pattern pattern)` Add the given `pattern` to the whitelist of directories to include in archiving.
`ArchivingStrategy`	`addToDirWhiteList(java.lang.String pattern)` Add the given `pattern` to the whitelist of directories to include in archiving.
`ArchivingStrategy`	`addToFileBlackList(java.util.regex.Pattern pattern)` Add the given `pattern` to the blacklist of files to exclude from archiving.
`ArchivingStrategy`	`addToFileBlackList(java.lang.String pattern)` Add the given `pattern` to the blacklist of files to exclude from archiving.
`ArchivingStrategy`	`addToFileWhiteList(java.util.regex.Pattern pattern)` Add the given `pattern` to the whitelist of files to include in archiving.
`ArchivingStrategy`	`addToFileWhiteList(java.lang.String pattern)` Add the given `pattern` to the whitelist of files to include in archiving.
`ArchivingStrategy`	`compressAll()` Store all files compressed in archive.
`ArchivingStrategy`	`compressAll(boolean compress)` Sets, whether all files should be stored compressed in archive (`true`) or not ( `false`).
`boolean`	`doCompress(java.lang.String path)`
`ArchivingStrategy.CompressionStrategy`	`getCompressionStrategy()`
`boolean`	`isSealed()` Returns `true` if this strategy is sealed.
`ArchivingStrategy`	`seal()` Seal the strategy.

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

- Field Detail
  - DEFAULT
```
public static final ArchivingStrategy DEFAULT
```
    The default strategy: include everything, compress all files except those known to be already compressed.
  - DEFAULT_WITH_COMPRESSION
```
public static final ArchivingStrategy DEFAULT_WITH_COMPRESSION
```
    An alias for the default strategy (kept for backward compatibility).
  - DEFAULT_NO_COMPRESSION
```
public static final ArchivingStrategy DEFAULT_NO_COMPRESSION
```
    The default strategy without compression: include everything, compress nothing.
- Constructor Detail
  - ArchivingStrategy
```
public ArchivingStrategy()
```
  - ArchivingStrategy
```
public ArchivingStrategy(ArchivingStrategy template)
```
- Method Detail
  - addToFileWhiteList
```
public ArchivingStrategy addToFileWhiteList(java.util.regex.Pattern pattern)
```
    Add the given pattern to the whitelist of files to include in archiving.
  - addToFileWhiteList
```
public ArchivingStrategy addToFileWhiteList(java.lang.String pattern)
```
    Add the given pattern to the whitelist of files to include in archiving.
  - addToFileBlackList
```
public ArchivingStrategy addToFileBlackList(java.util.regex.Pattern pattern)
```
    Add the given pattern to the blacklist of files to exclude from archiving.
  - addToFileBlackList
```
public ArchivingStrategy addToFileBlackList(java.lang.String pattern)
```
    Add the given pattern to the blacklist of files to exclude from archiving.
  - addToDirWhiteList
```
public ArchivingStrategy addToDirWhiteList(java.util.regex.Pattern pattern)
```
    Add the given pattern to the whitelist of directories to include in archiving.
  - addToDirWhiteList
```
public ArchivingStrategy addToDirWhiteList(java.lang.String pattern)
```
    Add the given pattern to the whitelist of directories to include in archiving.
  - addToDirBlackList
```
public ArchivingStrategy addToDirBlackList(java.util.regex.Pattern pattern)
```
    Add the given pattern to the blacklist of directories to exclude from archiving.
  - addToDirBlackList
```
public ArchivingStrategy addToDirBlackList(java.lang.String pattern)
```
    Add the given pattern to the blacklist of directories to exclude from archiving.
  - addToCompressionWhiteList
```
public ArchivingStrategy addToCompressionWhiteList(java.util.regex.Pattern pattern)
```
    Add the given pattern to the whitelist of files to store compressed in archive.
  - addToCompressionWhiteList
```
public ArchivingStrategy addToCompressionWhiteList(java.lang.String pattern)
```
    Add the given pattern to the whitelist of files to store compressed in archive.
  - addToCompressionBlackList
```
public ArchivingStrategy addToCompressionBlackList(java.util.regex.Pattern pattern)
```
    Add the given pattern to the blacklist of files to store compressed in archive.
  - addToCompressionBlackList
```
public ArchivingStrategy addToCompressionBlackList(java.lang.String pattern)
```
    Add the given pattern to the blacklist of files to store compressed in archive.
  - seal
```
public ArchivingStrategy seal()
```
    Seal the strategy. After sealing, all attempts to modify the strategy will throw on IllegalStateException.
  - isSealed
```
public boolean isSealed()
```
    Returns true if this strategy is sealed.
    
    See Also:
    
    seal()
  - compressAll
```
public ArchivingStrategy compressAll()
```
    Store all files compressed in archive.
  - compressAll
```
public ArchivingStrategy compressAll(boolean compress)
```
    Sets, whether all files should be stored compressed in archive (true) or not ( false).
  - doCompress
```
public boolean doCompress(java.lang.String path)
```
  - getCompressionStrategy
```
public ArchivingStrategy.CompressionStrategy getCompressionStrategy()
```

Class ArchivingStrategy

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

DEFAULT

DEFAULT_WITH_COMPRESSION

DEFAULT_NO_COMPRESSION

Constructor Detail

ArchivingStrategy

ArchivingStrategy

Method Detail

addToFileWhiteList

addToFileWhiteList

addToFileBlackList

addToFileBlackList

addToDirWhiteList

addToDirWhiteList

addToDirBlackList

addToDirBlackList

addToCompressionWhiteList

addToCompressionWhiteList

addToCompressionBlackList

addToCompressionBlackList

seal

isSealed

compressAll

compressAll

doCompress

getCompressionStrategy