Package org.codehaus.plexus.components.io.attributes

Class FileAttributes

java.lang.Object

org.codehaus.plexus.components.io.attributes.FileAttributes

All Implemented Interfaces:

PlexusIoResourceAttributes

Direct Known Subclasses:

UserGroupModeFileAttributes

public class FileAttributes
extends Object
implements PlexusIoResourceAttributes

Field Summary

Fields

Modifier and Type	Field	Description
static LinkOption[]	FOLLOW_LINK_OPTIONS
static LinkOption[]	NOFOLLOW_LINK_OPTIONS

Fields inherited from interface org.codehaus.plexus.components.io.attributes.PlexusIoResourceAttributes

UNKNOWN_OCTAL_MODE

Constructor Summary

Constructors

Constructor	Description
FileAttributes(File file)
FileAttributes(File file, boolean followLinks)
FileAttributes(File file, Map<Integer,String> userCache, Map<Integer,String> groupCache)	Deprecated. use FileAttributes(File) and remove the unused userCache and groupCache parameters
FileAttributes(Integer userId, String userName, Integer groupId, String groupName, int octalMode, boolean symbolicLink, boolean regularFile, boolean directory, boolean other, Set<PosixFilePermission> permissions, long size, FileTime lastModifiedTime)

Method Summary

Modifier and Type	Method	Description
int	calculatePosixOctalMode()
Integer	getGroupId()	Gets the unix group id.
String	getGroupName()	The group name.
FileTime	getLastModifiedTime()
int	getOctalMode()	Octal mode attributes.
String	getOctalModeString()
protected Set<PosixFilePermission>	getPermissions()
long	getSize()
Integer	getUserId()	Gets the unix user id.
String	getUserName()	Returns the user name of the user owning the file.
boolean	hasGroupId()
boolean	hasUserId()
boolean	isDirectory()
boolean	isGroupExecutable()
boolean	isGroupReadable()
boolean	isGroupWritable()
boolean	isOther()
boolean	isOwnerExecutable()
boolean	isOwnerReadable()
boolean	isOwnerWritable()
boolean	isRegularFile()
boolean	isSymbolicLink()	Indicates if this is a symbolic link element.
boolean	isWorldExecutable()
boolean	isWorldReadable()
boolean	isWorldWritable()
String	toString()
static PlexusIoResourceAttributes	uncached(File file)

Methods inherited from class java.lang.Object

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

Field Detail

FOLLOW_LINK_OPTIONS

public static final LinkOption[] FOLLOW_LINK_OPTIONS

NOFOLLOW_LINK_OPTIONS

public static final LinkOption[] NOFOLLOW_LINK_OPTIONS

Constructor Detail

FileAttributes

@Deprecated
public FileAttributes(@Nonnull
                      File file,
                      @Nonnull
                      Map<Integer,String> userCache,
                      @Nonnull
                      Map<Integer,String> groupCache)
               throws IOException

Deprecated.

use FileAttributes(File) and remove the unused userCache and groupCache parameters

Throws:

IOException

FileAttributes

public FileAttributes(@Nonnull
                      File file)
               throws IOException

Throws:

IOException

FileAttributes

public FileAttributes(@Nonnull
                      File file,
                      boolean followLinks)
               throws IOException

Throws:

IOException

FileAttributes

public FileAttributes(@Nullable
                      Integer userId,
                      String userName,
                      @Nullable
                      Integer groupId,
                      @Nullable
                      String groupName,
                      int octalMode,
                      boolean symbolicLink,
                      boolean regularFile,
                      boolean directory,
                      boolean other,
                      Set<PosixFilePermission> permissions,
                      long size,
                      FileTime lastModifiedTime)

Method Detail

uncached

@Nonnull
public static PlexusIoResourceAttributes uncached(@Nonnull
                                                  File file)
                                           throws IOException

Throws:

IOException

getGroupId

@Nullable
public Integer getGroupId()

Description copied from interface: PlexusIoResourceAttributes

Gets the unix group id.

Specified by:

getGroupId in interface PlexusIoResourceAttributes

Returns:

The unix group id, may be null ("not set"), even on unix

hasGroupId

public boolean hasGroupId()

hasUserId

public boolean hasUserId()

getGroupName

@Nullable
public String getGroupName()

Description copied from interface: PlexusIoResourceAttributes

The group name. May be null if groups are unsupported

Specified by:

getGroupName in interface PlexusIoResourceAttributes

Returns:

the group names

getUserId

public Integer getUserId()

Description copied from interface: PlexusIoResourceAttributes

Gets the unix user id.

Specified by:

getUserId in interface PlexusIoResourceAttributes

Returns:

The unix user id, may be null ("not set"), even on unix

getUserName

public String getUserName()

Description copied from interface: PlexusIoResourceAttributes

Returns the user name of the user owning the file. Probably not null :)

Specified by:

getUserName in interface PlexusIoResourceAttributes

Returns:

The user name

isGroupExecutable

public boolean isGroupExecutable()

Specified by:

isGroupExecutable in interface PlexusIoResourceAttributes

isGroupReadable

public boolean isGroupReadable()

Specified by:

isGroupReadable in interface PlexusIoResourceAttributes

isGroupWritable

public boolean isGroupWritable()

Specified by:

isGroupWritable in interface PlexusIoResourceAttributes

isOwnerExecutable

public boolean isOwnerExecutable()

Specified by:

isOwnerExecutable in interface PlexusIoResourceAttributes

isOwnerReadable

public boolean isOwnerReadable()

Specified by:

isOwnerReadable in interface PlexusIoResourceAttributes

isOwnerWritable

public boolean isOwnerWritable()

Specified by:

isOwnerWritable in interface PlexusIoResourceAttributes

isWorldExecutable

public boolean isWorldExecutable()

Specified by:

isWorldExecutable in interface PlexusIoResourceAttributes

isWorldReadable

public boolean isWorldReadable()

Specified by:

isWorldReadable in interface PlexusIoResourceAttributes

isWorldWritable

public boolean isWorldWritable()

Specified by:

isWorldWritable in interface PlexusIoResourceAttributes

toString

public String toString()

Overrides:

toString in class Object

getOctalMode

public int getOctalMode()

Description copied from interface: PlexusIoResourceAttributes

Octal mode attributes. PlexusIoResourceAttributes.UNKNOWN_OCTAL_MODE if unsupported on current file/file system

Specified by:

getOctalMode in interface PlexusIoResourceAttributes

calculatePosixOctalMode

public int calculatePosixOctalMode()

getOctalModeString

public String getOctalModeString()

isSymbolicLink

public boolean isSymbolicLink()

Description copied from interface: PlexusIoResourceAttributes

Indicates if this is a symbolic link element. For file-based resource attributes this value may be always "false" for versions prior to java7.

Specified by:

isSymbolicLink in interface PlexusIoResourceAttributes

Returns:

True if the file is a symlink or false if not.

isRegularFile

public boolean isRegularFile()

isDirectory

public boolean isDirectory()

isOther

public boolean isOther()

getSize

public long getSize()

getLastModifiedTime

public FileTime getLastModifiedTime()

getPermissions

protected Set<PosixFilePermission> getPermissions()