org.at4j.tar.builder

Class TarBuilderSettings

java.lang.Object

org.at4j.tar.builder.TarBuilderSettings

public class TarBuilderSettings
extends Object

This object contains the settings for a Tar archive builder. When a new instance is created, it is initialized with the default settings.

The default file entry settings are:

Property	Value
Unix entity mode	0644
Owner UID	0
Owner GID	0
Owner user name	The name of the user owning the Java process
Owner group name	users

The default directory entry settings are:

Property	Value
Unix entity mode	0755
Owner UID	0
Owner GID	0
Owner user name	The name of the user owning the Java process
Owner group name	users

The default entry strategy is the default GnuTarEntryStrategy, which means that the Tar builder will create Gnu Tar compatible archives by default.

The setter methods of this object return the object instance so that setter calls can be chained together.

Since:

1.0

Author:

Karl Gustafsson

See Also:

TarBuilder, TarStreamBuilder

Constructor Summary

Constructors

Constructor and Description
TarBuilderSettings()

Method Summary

Methods

Modifier and Type	Method and Description
TarEntrySettings	getDefaultDirectoryEntrySettings() Get the default directory entry settings.
TarEntrySettings	getDefaultFileEntrySettings() Get the default file entry settings.
TarEntryStrategy	getEntryStrategy() Get the entry strategy.
TarBuilderSettings	setDefaultDirectoryEntrySettings(TarEntrySettings defaultDirectorySettings) Set new default directory entry settings.
TarBuilderSettings	setDefaultFileEntrySettings(TarEntrySettings defaultFileSettings) Set new default file entry settings.
TarBuilderSettings	setEntryStrategy(TarEntryStrategy entryStrategy) Set a new entry strategy.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

TarBuilderSettings

public TarBuilderSettings()

Method Detail

getDefaultFileEntrySettings

public TarEntrySettings getDefaultFileEntrySettings()

Get the default file entry settings.

Returns:

The default file entry settings.

setDefaultFileEntrySettings

public TarBuilderSettings setDefaultFileEntrySettings(TarEntrySettings defaultFileSettings)

Set new default file entry settings.

This will be combined with the default default file entry settings, so it only has to contain the configuration delta compared with the default settings.

Parameters:

defaultFileSettings - The new default file entry settings.

Returns:

this

getDefaultDirectoryEntrySettings

public TarEntrySettings getDefaultDirectoryEntrySettings()

Get the default directory entry settings.

Returns:

The default directory entry settings.

setDefaultDirectoryEntrySettings

public TarBuilderSettings setDefaultDirectoryEntrySettings(TarEntrySettings defaultDirectorySettings)

Set new default directory entry settings.

This will be combined with the default default directory entry settings, so it only has to contain the configuration delta compared with the default settings.

Parameters:

defaultDirectorySettings - The new default directory entry settings.

Returns:

this

getEntryStrategy

public TarEntryStrategy getEntryStrategy()

Get the entry strategy.

Returns:

The entry strategy.

setEntryStrategy

public TarBuilderSettings setEntryStrategy(TarEntryStrategy entryStrategy)

Set a new entry strategy.

Parameters:

entryStrategy - The new entry strategy.

Returns:

this