com.microsoft.azure.storage.file

Class FileProperties

java.lang.Object

com.microsoft.azure.storage.file.FileProperties

public final class FileProperties
extends Object

Represents the system properties for a file.

Constructor Summary

Constructors

Constructor and Description
FileProperties() Creates an instance of the FileProperties class.
FileProperties(FileProperties other) Creates an instance of the FileProperties class by copying values from another instance of the FileProperties class.

Method Summary

Methods

Modifier and Type	Method and Description
String	getCacheControl() Gets the cache control value for the file.
String	getContentDisposition() Gets the content disposition value for the file.
String	getContentEncoding() Gets the content encoding value for the file.
String	getContentLanguage() Gets the content language value for the file.
String	getContentMD5() Gets the content MD5 value for the file.
String	getContentType() Gets the content type value for the file.
CopyState	getCopyState() Gets the file's copy state.
String	getEtag() Gets the ETag value for the file.
Date	getLastModified() Gets the last modified time for the file.
long	getLength() Gets the size, in bytes, of the file.
boolean	isServerEncrypted() Gets the file's server-side encryption status.
void	setCacheControl(String cacheControl) Sets the cache control value for the file.
void	setContentDisposition(String contentDisposition) Sets the content disposition value for the file.
void	setContentEncoding(String contentEncoding) Sets the content encoding value for the file.
void	setContentLanguage(String contentLanguage) Sets the content language for the file.
void	setContentMD5(String contentMD5) Sets the content MD5 value for the file.
void	setContentType(String contentType) Sets the content type value for the file.

Methods inherited from class java.lang.Object

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

Constructor Detail

FileProperties

public FileProperties()

Creates an instance of the FileProperties class.

FileProperties

public FileProperties(FileProperties other)

Creates an instance of the FileProperties class by copying values from another instance of the FileProperties class.

Parameters:

other - A FileProperties object which represents the file properties to copy.

Method Detail

getCacheControl

public String getCacheControl()

Gets the cache control value for the file.

Returns:

A String which represents the content cache control value for the file.

getContentDisposition

public String getContentDisposition()

Gets the content disposition value for the file.

Returns:

A String which represents the content disposition, or null if content disposition has not been set on the file.

getContentEncoding

public String getContentEncoding()

Gets the content encoding value for the file.

Returns:

A String which represents the content encoding, or null if content encoding has not been set on the file.

getContentLanguage

public String getContentLanguage()

Gets the content language value for the file.

Returns:

A String which represents the content language, or null if content language has not been set on the file.

getContentMD5

public String getContentMD5()

Gets the content MD5 value for the file.

Returns:

A String which represents the content MD5 value.

getContentType

public String getContentType()

Gets the content type value for the file.

Returns:

A String which represents the content type, or null if the content type has not be set for the file.

getCopyState

public CopyState getCopyState()

Gets the file's copy state.

Returns:

A CopyState object which represents the copy state of the file.

getEtag

public String getEtag()

Gets the ETag value for the file.

The ETag value is a unique identifier that is updated when a write operation is performed against the file. It may be used to perform operations conditionally, providing concurrency control and improved efficiency.

The AccessCondition.generateIfMatchCondition(String) and AccessCondition.generateIfNoneMatchCondition(String) methods take an ETag value and return an AccessCondition object that may be specified on the request.

Returns:

A String which represents the ETag value.

getLastModified

public Date getLastModified()

Gets the last modified time for the file.

Returns:

A Date object which represents the last modified time.

getLength

public long getLength()

Gets the size, in bytes, of the file.

Returns:

A long which represents the length of the file.

isServerEncrypted

public boolean isServerEncrypted()

Gets the file's server-side encryption status.

Returns:

A boolean which specifies the file's encryption status.

setCacheControl

public void setCacheControl(String cacheControl)

Sets the cache control value for the file.

Parameters:

cacheControl - A String which specifies the cache control value to set.

setContentDisposition

public void setContentDisposition(String contentDisposition)

Sets the content disposition value for the file.

Parameters:

contentDisposition - A String which specifies the content disposition value to set.

setContentEncoding

public void setContentEncoding(String contentEncoding)

Sets the content encoding value for the file.

Parameters:

contentEncoding - A String which specifies the content encoding value to set.

setContentLanguage

public void setContentLanguage(String contentLanguage)

Sets the content language for the file.

Parameters:

contentLanguage - A String which specifies the content language value to set.

setContentMD5

public void setContentMD5(String contentMD5)

Sets the content MD5 value for the file.

Parameters:

contentMD5 - A String which specifies the content MD5 value to set.

setContentType

public void setContentType(String contentType)

Sets the content type value for the file.

Parameters:

contentType - A String which specifies the content type value to set.