org.codehaus.plexus.archiver.tar

Class TarArchiver.TarOptions

public class TarArchiver.TarOptions extends Object

Valid Modes for Compression attribute to Tar Task
Field Summary
intdirMode
intfileMode
intgid
StringgroupName
booleanpreserveLeadingSlashes
intuid
StringuserName
Method Summary
intgetDirMode()
intgetGid()
StringgetGroup()
intgetMode()
booleangetPreserveLeadingSlashes()
intgetUid()
StringgetUserName()
voidsetDirMode(String octalString)
A 3 digit octal string, specify the user, group and other modes in the standard Unix fashion; optional, default=0755
voidsetDirMode(int mode)
voidsetGid(int gid)
The GID for the tar entry; optional, default="0" This is not the same as the group name.
voidsetGroup(String groupName)
The groupname for the tar entry; optional, default="" This is not the same as the GID.
voidsetMode(String octalString)
A 3 digit octal string, specify the user, group and other modes in the standard Unix fashion; optional, default=0644
voidsetMode(int mode)
voidsetPreserveLeadingSlashes(boolean preserveLeadingSlashes)
Flag to indicates whether leading `/'s should be preserved in the file names.
voidsetUid(int uid)
The uid for the tar entry This is not the same as the User name.
voidsetUserName(String userName)
The username for the tar entry This is not the same as the UID.

Field Detail

dirMode

private int dirMode

Deprecated:

fileMode

private int fileMode

Deprecated:

gid

private int gid

groupName

private String groupName

preserveLeadingSlashes

private boolean preserveLeadingSlashes

uid

private int uid

userName

private String userName

Method Detail

getDirMode

public int getDirMode()

Deprecated: use AbstractArchiver.getDefaultDirectoryMode()

Returns: the current directory mode

Since: Ant 1.6

getGid

public int getGid()

Returns: the group identifier.

getGroup

public String getGroup()

Returns: the group name string.

getMode

public int getMode()

Deprecated: use AbstractArchiver.getDefaultFileMode()

Returns: the current mode.

getPreserveLeadingSlashes

public boolean getPreserveLeadingSlashes()

Returns: the leading slashes flag.

getUid

public int getUid()

Returns: the uid for the tar entry

getUserName

public String getUserName()

Returns: the user name for the tar entry

setDirMode

public void setDirMode(String octalString)

Deprecated: use AbstractArchiver.setDefaultDirectoryMode(int)

A 3 digit octal string, specify the user, group and other modes in the standard Unix fashion; optional, default=0755

Parameters: octalString a 3 digit octal string.

Since: Ant 1.6

setDirMode

public void setDirMode(int mode)

Deprecated: use AbstractArchiver.setDefaultDirectoryMode(int)

Parameters: mode unix directory mode

setGid

public void setGid(int gid)
The GID for the tar entry; optional, default="0" This is not the same as the group name.

Parameters: gid the group id.

setGroup

public void setGroup(String groupName)
The groupname for the tar entry; optional, default="" This is not the same as the GID.

Parameters: groupName the group name string.

setMode

public void setMode(String octalString)

Deprecated: use AbstractArchiver.setDefaultFileMode(int)

A 3 digit octal string, specify the user, group and other modes in the standard Unix fashion; optional, default=0644

Parameters: octalString a 3 digit octal string.

setMode

public void setMode(int mode)

Deprecated: use AbstractArchiver.setDefaultFileMode(int)

Parameters: mode unix file mode

setPreserveLeadingSlashes

public void setPreserveLeadingSlashes(boolean preserveLeadingSlashes)
Flag to indicates whether leading `/'s should be preserved in the file names. Optional, default is false.

Parameters: preserveLeadingSlashes the leading slashes flag.

setUid

public void setUid(int uid)
The uid for the tar entry This is not the same as the User name.

Parameters: uid the id of the user for the tar entry.

setUserName

public void setUserName(String userName)
The username for the tar entry This is not the same as the UID.

Parameters: userName the user name for the tar entry.