Enum NtfsFileAttributes
- java.lang.Object
-
- java.lang.Enum<NtfsFileAttributes>
-
- com.azure.storage.file.share.models.NtfsFileAttributes
-
- All Implemented Interfaces:
Serializable
,Comparable<NtfsFileAttributes>
public enum NtfsFileAttributes extends Enum<NtfsFileAttributes>
Specifies options for NTFS File Attributes.
-
-
Enum Constant Summary
Enum Constants Enum Constant Description ARCHIVE
The file is a candidate for backup or removal.DIRECTORY
The file is a directory.HIDDEN
The file is hidden, and thus is not included in ordinary directory listing.NO_SCRUB_DATA
The file or directory is excluded from the data integrity scan.NORMAL
The file is a standard file that has no special attributes.NOT_CONTENT_INDEXED
The file will not be indexed by the operating system's content indexing service.OFFLINE
The file is offline.READ_ONLY
The file is read-only.SYSTEM
The file is a system file.TEMPORARY
The file is temporary.
-
Method Summary
All Methods Static Methods Concrete Methods Modifier and Type Method Description static EnumSet<NtfsFileAttributes>
toAttributes(String ntfsAttributes)
Creates an enum set ofNtfsFileAttributes
from a valid String .static String
toString(EnumSet<NtfsFileAttributes> ntfsAttributes)
Converts an enum set ofNtfsFileAttributes
to a string.static NtfsFileAttributes
valueOf(String name)
Returns the enum constant of this type with the specified name.static NtfsFileAttributes[]
values()
Returns an array containing the constants of this enum type, in the order they are declared.
-
-
-
Enum Constant Detail
-
READ_ONLY
public static final NtfsFileAttributes READ_ONLY
The file is read-only.
-
HIDDEN
public static final NtfsFileAttributes HIDDEN
The file is hidden, and thus is not included in ordinary directory listing.
-
SYSTEM
public static final NtfsFileAttributes SYSTEM
The file is a system file. That is, the file is part of the operating system or is used exclusively by the operating system.
-
NORMAL
public static final NtfsFileAttributes NORMAL
The file is a standard file that has no special attributes.
-
DIRECTORY
public static final NtfsFileAttributes DIRECTORY
The file is a directory.
-
ARCHIVE
public static final NtfsFileAttributes ARCHIVE
The file is a candidate for backup or removal.
-
TEMPORARY
public static final NtfsFileAttributes TEMPORARY
The file is temporary. A temporary file contains data that is needed while an application is executing but is not needed after the application is finished. File systems try to keep all the data in memory for quicker access rather than flushing the data back to mass storage. A temporary file should be deleted by the application as soon as it is no longer needed.
-
OFFLINE
public static final NtfsFileAttributes OFFLINE
The file is offline. The data of the file is not immediately available.
-
NOT_CONTENT_INDEXED
public static final NtfsFileAttributes NOT_CONTENT_INDEXED
The file will not be indexed by the operating system's content indexing service.
-
NO_SCRUB_DATA
public static final NtfsFileAttributes NO_SCRUB_DATA
The file or directory is excluded from the data integrity scan. When this value is applied to a directory, by default, all new files and subdirectories within that directory are excluded from data integrity.
-
-
Method Detail
-
values
public static NtfsFileAttributes[] values()
Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:for (NtfsFileAttributes c : NtfsFileAttributes.values()) System.out.println(c);
- Returns:
- an array containing the constants of this enum type, in the order they are declared
-
valueOf
public static NtfsFileAttributes valueOf(String name)
Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)- Parameters:
name
- the name of the enum constant to be returned.- Returns:
- the enum constant with the specified name
- Throws:
IllegalArgumentException
- if this enum type has no constant with the specified nameNullPointerException
- if the argument is null
-
toString
public static String toString(EnumSet<NtfsFileAttributes> ntfsAttributes)
Converts an enum set ofNtfsFileAttributes
to a string.- Parameters:
ntfsAttributes
- Set ofNtfsFileAttributes
to convert to a string.- Returns:
- a string that represents the NTFS Attributes in the correct format delimited by
|
which is described attoAttributes(String)
.
-
toAttributes
public static EnumSet<NtfsFileAttributes> toAttributes(String ntfsAttributes)
Creates an enum set ofNtfsFileAttributes
from a valid String .- Parameters:
ntfsAttributes
- AString
that represents the ntfs attributes. The string must contain one or more of the following values delimited by a |. Note they are case sensitive.ReadOnly
Hidden
System
None
Directory
Archive
Temporary
Offline
NotContentIndexed
NoScrubData
- Returns:
- A set of
NtfsFileAttributes
that were contained in the passed string. - Throws:
IllegalArgumentException
- IfntfsAttributes
contains an attribute that is unknown.
-
-