org.codehaus.plexus.archiver.tar

Class TarArchiver.TarOptions

Enclosing Class:
TarArchiver

public class TarArchiver.TarOptions
extends java.lang.Object

Valid Modes for Compression attribute to Tar Task

Field Summary

private int
dirMode
Deprecated.
private int
fileMode
Deprecated.
private int
gid
private String
groupName
private boolean
preserveLeadingSlashes
private int
uid
private String
userName

Method Summary

int
getDirMode()
Deprecated. use AbstractArchiver.getDefaultDirectoryMode()
int
getGid()
String
getGroup()
int
getMode()
Deprecated. use AbstractArchiver.getDefaultFileMode()
boolean
getPreserveLeadingSlashes()
int
getUid()
String
getUserName()
void
setDirMode(String octalString)
Deprecated. use AbstractArchiver.setDefaultDirectoryMode(int)
void
setDirMode(int mode)
Deprecated. use AbstractArchiver.setDefaultDirectoryMode(int)
void
setGid(int gid)
The GID for the tar entry; optional, default="0" This is not the same as the group name.
void
setGroup(String groupName)
The groupname for the tar entry; optional, default="" This is not the same as the GID.
void
setMode(String octalString)
Deprecated. use AbstractArchiver.setDefaultFileMode(int)
void
setMode(int mode)
Deprecated. use AbstractArchiver.setDefaultFileMode(int)
void
setPreserveLeadingSlashes(boolean preserveLeadingSlashes)
Flag to indicates whether leading `/'s should be preserved in the file names.
void
setUid(int uid)
The uid for the tar entry This is not the same as the User name.
void
setUserName(String userName)
The username for the tar entry This is not the same as the UID.

Field Details

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 Details

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.