Module jcifs

Package org.codelibs.jcifs.smb.internal.fscc

Class FileBasicInfo

java.lang.Object

org.codelibs.jcifs.smb.internal.fscc.FileBasicInfo

All Implemented Interfaces:

Decodable, Encodable, BasicFileInformation, FileInformation, SmbBasicFileInfo

public class FileBasicInfo
extends Object
implements BasicFileInformation

Represents the FILE_BASIC_INFORMATION structure used in SMB2/3 file system control code (FSCC) operations. This structure contains basic file information including creation time, last access time, last write time, change time, and file attributes for querying and setting file metadata.

Field Summary

Fields inherited from interface org.codelibs.jcifs.smb.internal.fscc.FileInformation

FILE_BASIC_INFO, FILE_ENDOFFILE_INFO, FILE_INTERNAL_INFO, FILE_RENAME_INFO, FILE_STANDARD_INFO

Constructor Summary

Constructors

Constructor	Description
FileBasicInfo()	Default constructor for decoding.
FileBasicInfo(long create, long lastAccess, long lastWrite, long change, int attributes)	Constructs file basic information.

Method Summary

Modifier and Type	Method	Description
int	decode(byte[] buffer, int bufferIndex, int len)	Decode data from a byte buffer
int	encode(byte[] dst, int dstIndex)	Encodes this object into the specified byte array.
int	getAttributes()	Gets the file attributes.
long	getCreateTime()	Gets the file creation time.
byte	getFileInformationLevel()	Gets the file information level/class for this file information object.
long	getLastAccessTime()	Gets the file last access time.
long	getLastWriteTime()	Gets the file last write time.
long	getSize()	Gets the file size in bytes.
int	size()	Returns the size in bytes that this object will occupy when encoded.
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Details

FileBasicInfo

public FileBasicInfo()

Default constructor for decoding.

FileBasicInfo

public FileBasicInfo(long create,
 long lastAccess,
 long lastWrite,
 long change,
 int attributes)

Constructs file basic information.

Parameters:

create - file creation time

lastAccess - last access time

lastWrite - last write time

change - last change time

attributes - file attributes

Method Details

getFileInformationLevel

public byte getFileInformationLevel()

Gets the file information level/class for this file information object.

Specified by:

getFileInformationLevel in interface FileInformation

Returns:

the file information class

See Also:

• FileInformation.getFileInformationLevel()

getAttributes

public int getAttributes()

Description copied from interface: SmbBasicFileInfo

Gets the file attributes.

Specified by:

getAttributes in interface SmbBasicFileInfo

Returns:

file attributes

getCreateTime

public long getCreateTime()

Description copied from interface: SmbBasicFileInfo

Gets the file creation time.

Specified by:

getCreateTime in interface SmbBasicFileInfo

Returns:

file create time

getLastWriteTime

public long getLastWriteTime()

Description copied from interface: SmbBasicFileInfo

Gets the file last write time.

Specified by:

getLastWriteTime in interface SmbBasicFileInfo

Returns:

file last write time

getLastAccessTime

public long getLastAccessTime()

Description copied from interface: SmbBasicFileInfo

Gets the file last access time.

Specified by:

getLastAccessTime in interface SmbBasicFileInfo

Returns:

file last access time

getSize

public long getSize()

Description copied from interface: SmbBasicFileInfo

Gets the file size in bytes.

Specified by:

getSize in interface SmbBasicFileInfo

Returns:

file size

decode

public int decode(byte[] buffer,
 int bufferIndex,
 int len)
           throws SMBProtocolDecodingException

Decode data from a byte buffer

Specified by:

decode in interface Decodable

Parameters:

buffer - the byte buffer containing the data to decode

bufferIndex - the starting index in the buffer

len - the maximum length of data to decode

Returns:

decoded length

Throws:

SMBProtocolDecodingException - if decoding fails

See Also:

• Decodable.decode(byte[], int, int)

size

public int size()

Returns the size in bytes that this object will occupy when encoded.

Specified by:

size in interface Encodable

Returns:

the encoded size

See Also:

• Encodable.size()

encode

public int encode(byte[] dst,
 int dstIndex)

Encodes this object into the specified byte array.

Specified by:

encode in interface Encodable

Parameters:

dst - the destination byte array to encode into

dstIndex - the starting index in the destination array

Returns:

encoded length

See Also:

• Encodable.encode(byte[], int)

toString

public String toString()

Overrides:

toString in class Object