Package com.azure.storage.file.share.models

Class ShareFileItem

java.lang.Object

com.azure.storage.file.share.models.ShareFileItem

public final class ShareFileItem
extends Object

Contains file or directory reference information in the storage File service.

Constructor Summary

Constructors

Constructor	Description
ShareFileItem(String name, boolean isDirectory, Long fileSize)	Creates an instance of file or directory reference information about a specific Share.
ShareFileItem(String name, boolean isDirectory, String id, ShareFileItemProperties properties, EnumSet<NtfsFileAttributes> fileAttributes, String permissionKey, Long fileSize)	Creates an instance of file or directory reference information about a specific Share.

Method Summary

Modifier and Type	Method	Description
EnumSet<NtfsFileAttributes>	getFileAttributes()	Gets the NTFS attributes of the file or directory.
Long	getFileSize()	Gets the size of a file, null if the reference is a directory.
String	getId()	Gets the ID of the file or directory.
String	getName()	Gets the name of the file or the directory.
String	getPermissionKey()	Gets the permission key of the file or directory.
ShareFileItemProperties	getProperties()	Gets the properties of the file or directory.
boolean	isDirectory()	Gets a boolean set to true if the reference is a directory, false if the reference is a file.

Methods inherited from class java.lang.Object

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

Constructor Details

ShareFileItem

public ShareFileItem(String name,
 boolean isDirectory,
 Long fileSize)

Creates an instance of file or directory reference information about a specific Share.

Parameters:

name - Name of the file or the directory.

isDirectory - A boolean set to true if the reference is a directory, false if the reference is a file.

fileSize - Size of a file. Pass null if the reference is a directory.

ShareFileItem

public ShareFileItem(String name,
 boolean isDirectory,
 String id,
 ShareFileItemProperties properties,
 EnumSet<NtfsFileAttributes> fileAttributes,
 String permissionKey,
 Long fileSize)

Creates an instance of file or directory reference information about a specific Share.

Parameters:

name - Name of the file or the directory.

isDirectory - A boolean set to true if the reference is a directory, false if the reference is a file.

id - ID of the file or directory.

properties - Properties of the file or directory.

fileAttributes - NTFS attributes of the file or directory.

permissionKey - Permission key of the file or directory.

fileSize - Size of a file. Pass null if the reference is a directory.

Method Details

getName

public String getName()

Gets the name of the file or the directory.

Returns:

Name of the file or the directory.

isDirectory

public boolean isDirectory()

Gets a boolean set to true if the reference is a directory, false if the reference is a file.

Returns:

True if the reference is a directory, or false if the reference is a file.

getFileSize

public Long getFileSize()

Gets the size of a file, null if the reference is a directory.

Returns:

Size of a file, null if the reference is a directory.

getId

public String getId()

Gets the ID of the file or directory.

Returns:

ID of the file or directory.

getProperties

public ShareFileItemProperties getProperties()

Gets the properties of the file or directory.

Returns:

Properties of the file or directory.

getFileAttributes

public EnumSet<NtfsFileAttributes> getFileAttributes()

Gets the NTFS attributes of the file or directory.

Returns:

NTFS attributes of the file or directory.

getPermissionKey

public String getPermissionKey()

Gets the permission key of the file or directory.

Returns:

Permission key of the file or directory.