org.alfresco.jlan.client.info

Class FileInfo

java.lang.Object

org.alfresco.jlan.client.info.FileInfo

Direct Known Subclasses:

ExtendedFileInfo, ReparsePointFileInfo

public class FileInfo
extends Object

SMB file information class.

The FileInfo class is returned by the DiskSession.getFileInformation () method and contains details of the requested file.

FileInfo objects are also returned by a directory search that is started using the DiskSession.StartSearch () method. The search request creates an SearchContext object which can return either file names, via the nextFileName () method, or can return FileInfo objects for each file found, via the nextFileInfo () method.

Author:

gkspencer

See Also:

DiskSession

Field Summary

Fields

Modifier and Type	Field and Description
protected int	m_attr
protected String	m_name
protected String	m_path
protected String	m_shortName
protected long	m_size

Constructor Summary

Constructors

Constructor and Description
FileInfo() Default constructor
FileInfo(String fname, long fsize, int fattr) Construct an SMB file information object.
FileInfo(String fname, long fsize, int fattr, int ftime) Construct an SMB file information object.
FileInfo(String fname, long fsize, int fattr, int fdate, int ftime) Construct an SMB file information object.
FileInfo(String fpath, String fname, long fsize, int fattr) Construct an SMB file information object.
FileInfo(String fpath, String fname, long fsize, int fattr, int ftime) Construct an SMB file information object.
FileInfo(String fpath, String fname, long fsize, int fattr, int fdate, int ftime) Construct an SMB file information object.

Method Summary

Methods

Modifier and Type	Method and Description
SMBDate	getAccessDateTime() Return the files last access date/time.
long	getAllocationSize() Get the files allocated size.
int	getAllocationSizeInt() Get the files allocated size, as a 32bit value
SMBDate	getCreationDateTime() Return the creation date/time of the file.
int	getFileAttributes() Return the file attributes value.
int	getFileId() Get the file identifier
String	getFileName() Get the file name string
String	getFormattedAttributes() Return the file attributes as a formatted string.
SMBDate	getModifyDateTime() Get the files date/time of last write
String	getPath() Get the file path string.
String	getShortName() Get the short file name (8.3 format)
long	getSize() Get the file size, in bytes.
int	getSizeInt() Get the file size in bytes, as a 32bit value
boolean	hasAccessDateTime() Determine if the last access date/time is available.
boolean	hasAttribute(int attr) Return the specified attribute status
boolean	hasCreationDateTime() Determine if the creation date/time details are available.
boolean	hasModifyDateTime() Determine if the modify date/time details are available.
boolean	hasShortName() Check if the short (8.3) file name is available
boolean	isArchived() Return the archived attribute status
boolean	isCompressed() Return the compressed file status
boolean	isDirectory() Return the directory file attribute status.
boolean	isEncrypted() Return the encrypted file status
boolean	isHidden() Return the hidden file attribute status.
boolean	isIndexed() Return the indexed file status
boolean	isOffline() Return the offline file status
boolean	isReadOnly() Return the read-only file attribute status.
boolean	isSystem() Return the system file attribute status.
boolean	isTemporary() Return the temporary file status
void	resetInfo() Reset all values to zero/null values.
void	setAccessDateTime(int dat, int tim) Set the files last access date/time.
void	setAccessDateTime(SMBDate dattim) Set the files last access date/time.
void	setAllocationSize(long siz) Set the files allocation size.
void	setCreationDateTime(int dat, int tim) Set the creation date/time for the file.
void	setCreationDateTime(SMBDate dattim) Set the creation date/time for the file.
void	setFileAttributes(int attr) Set the file attributes.
void	setFileId(int id) Set the file identifier
void	setFileName(String name) Set the file name.
void	setFileSize(long siz) Set the file size in bytes
void	setModifyDateTime(int dat, int tim) Set the date/time for the file.
void	setModifyDateTime(SMBDate datetime) Set the date/time file
void	setPath(String path) Set the path
void	setShortName(String name) Set the short (8.3 format) file name
void	setSize(int siz) Set the file size.
void	setSize(long siz) Set the file size.
String	toString() Return the file information as a string.

Methods inherited from class java.lang.Object

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

Field Detail

m_name

protected String m_name

m_shortName

protected String m_shortName

m_path

protected String m_path

m_size

protected long m_size

m_attr

protected int m_attr

Constructor Detail

FileInfo

public FileInfo()

Default constructor

FileInfo

public FileInfo(String fname,
        long fsize,
        int fattr)

Construct an SMB file information object.

Parameters:

fname - File name string.

fsize - File size, in bytes.

fattr - File attributes.

FileInfo

public FileInfo(String fname,
        long fsize,
        int fattr,
        int ftime)

Construct an SMB file information object.

Parameters:

fname - File name string.

fsize - File size, in bytes.

fattr - File attributes.

ftime - File time, in seconds since 1-Jan-1970 00:00:00

FileInfo

public FileInfo(String fname,
        long fsize,
        int fattr,
        int fdate,
        int ftime)

Construct an SMB file information object.

Parameters:

fname - File name string.

fsize - File size, in bytes.

fattr - File attributes.

fdate - SMB encoded file date.

ftime - SMB encoded file time.

FileInfo

public FileInfo(String fpath,
        String fname,
        long fsize,
        int fattr)

Construct an SMB file information object.

Parameters:

fpath - File path string.

fname - File name string.

fsize - File size, in bytes.

fattr - File attributes.

FileInfo

public FileInfo(String fpath,
        String fname,
        long fsize,
        int fattr,
        int ftime)

Construct an SMB file information object.

Parameters:

fpath - File path string.

fname - File name string.

fsize - File size, in bytes.

fattr - File attributes.

ftime - File time, in seconds since 1-Jan-1970 00:00:00

FileInfo

public FileInfo(String fpath,
        String fname,
        long fsize,
        int fattr,
        int fdate,
        int ftime)

Construct an SMB file information object.

Parameters:

fpath - File path string.

fname - File name string.

fsize - File size, in bytes.

fattr - File attributes.

fdate - SMB encoded file date.

ftime - SMB encoded file time.

Method Detail

getAccessDateTime

public SMBDate getAccessDateTime()

Return the files last access date/time.

Returns:

SMBDate

getAllocationSize

public long getAllocationSize()

Get the files allocated size.

Returns:

long

getAllocationSizeInt

public int getAllocationSizeInt()

Get the files allocated size, as a 32bit value

Returns:

int

getCreationDateTime

public SMBDate getCreationDateTime()

Return the creation date/time of the file.

Returns:

SMBDate

getFileAttributes

public int getFileAttributes()

Return the file attributes value.

Returns:

File attributes value.

getFileName

public final String getFileName()

Get the file name string

Returns:

File name string.

hasShortName

public final boolean hasShortName()

Check if the short (8.3) file name is available

Returns:

boolean

getShortName

public final String getShortName()

Get the short file name (8.3 format)

Returns:

String

getModifyDateTime

public final SMBDate getModifyDateTime()

Get the files date/time of last write

Returns:

File write date/time.

getPath

public final String getPath()

Get the file path string.

Returns:

File path string, relative to the share.

getSize

public final long getSize()

Get the file size, in bytes.

Returns:

File size in bytes.

getSizeInt

public final int getSizeInt()

Get the file size in bytes, as a 32bit value

Returns:

File size in bytes, as an int

getFileId

public final int getFileId()

Get the file identifier

Returns:

int

hasAccessDateTime

public boolean hasAccessDateTime()

Determine if the last access date/time is available.

Returns:

boolean

hasCreationDateTime

public boolean hasCreationDateTime()

Determine if the creation date/time details are available.

Returns:

boolean

hasModifyDateTime

public boolean hasModifyDateTime()

Determine if the modify date/time details are available.

Returns:

boolean

hasAttribute

public final boolean hasAttribute(int attr)

Return the specified attribute status

Parameters:

attr - int

isDirectory

public final boolean isDirectory()

Return the directory file attribute status.

Returns:

true if the file is a directory, else false.

isHidden

public final boolean isHidden()

Return the hidden file attribute status.

Returns:

true if the file is hidden, else false.

isReadOnly

public final boolean isReadOnly()

Return the read-only file attribute status.

Returns:

true if the file is read-only, else false.

isSystem

public final boolean isSystem()

Return the system file attribute status.

Returns:

true if the file is a system file, else false.

isArchived

public final boolean isArchived()

Return the archived attribute status

Returns:

boolean

isCompressed

public final boolean isCompressed()

Return the compressed file status

Returns:

boolean

isOffline

public final boolean isOffline()

Return the offline file status

Returns:

boolean

isEncrypted

public final boolean isEncrypted()

Return the encrypted file status

Returns:

boolean

isTemporary

public final boolean isTemporary()

Return the temporary file status

Returns:

boolean

isIndexed

public final boolean isIndexed()

Return the indexed file status

Returns:

boolean

resetInfo

public final void resetInfo()

Reset all values to zero/null values.

setAccessDateTime

public void setAccessDateTime(int dat,
                     int tim)

Set the files last access date/time.

Parameters:

dat - int

tim - int

setAccessDateTime

public void setAccessDateTime(SMBDate dattim)

Set the files last access date/time.

Parameters:

dattim - Last access date/time as an SMBDate value.

setAllocationSize

public void setAllocationSize(long siz)

Set the files allocation size.

Parameters:

siz - long

setCreationDateTime

public void setCreationDateTime(int dat,
                       int tim)

Set the creation date/time for the file.

Parameters:

dat - int Creation date in SMB format.

tim - int Creation time in SMB format.

setCreationDateTime

public void setCreationDateTime(SMBDate dattim)

Set the creation date/time for the file.

Parameters:

dattim - Creation date as an SMBDate value.

setFileName

public final void setFileName(String name)

Set the file name.

Parameters:

name - java.lang.String

setFileSize

public final void setFileSize(long siz)

Set the file size in bytes

Parameters:

siz - long

setModifyDateTime

public void setModifyDateTime(int dat,
                     int tim)

Set the date/time for the file.

Parameters:

dat - int Creation date in SMB format.

tim - int Creation time in SMB format.

setModifyDateTime

public final void setModifyDateTime(SMBDate datetime)

Set the date/time file

Parameters:

datetime - SMBDate

setFileId

public final void setFileId(int id)

Set the file identifier

Parameters:

id - int

setShortName

public final void setShortName(String name)

Set the short (8.3 format) file name

Parameters:

name - String

setPath

public final void setPath(String path)

Set the path

Parameters:

path - String

setSize

public final void setSize(int siz)

Set the file size.

Parameters:

siz - int

setSize

public final void setSize(long siz)

Set the file size.

Parameters:

siz - long

getFormattedAttributes

public final String getFormattedAttributes()

Return the file attributes as a formatted string.

The returned string is in the format 'RHSD' where 'R' indicates read-only, 'H' indicates hidden, 'S' indicates system and 'D' indicates directory

Returns:

String

toString

public String toString()

Return the file information as a string.

Overrides:

toString in class Object

Returns:

File information string.

setFileAttributes

public final void setFileAttributes(int attr)

Set the file attributes.

Parameters:

attr - int