com.hierynomus.msfscc

Enum FileAttributes

java.lang.Object

java.lang.Enum<FileAttributes>

com.hierynomus.msfscc.FileAttributes

All Implemented Interfaces:

EnumWithValue<FileAttributes>, java.io.Serializable, java.lang.Comparable<FileAttributes>

public enum FileAttributes
extends java.lang.Enum<FileAttributes>
implements EnumWithValue<FileAttributes>

[MS-FSCC].pdf 2.6 File Attributes.

The following attributes are defined for files and directories. They can be used in any combination unless noted in the description of the attribute's meaning. There is no file attribute with the value 0x00000000 because a value of 0x00000000 in the FileAttributes field means that the file attributes for this file MUST NOT be changed when setting basic information for the file.

Nested Class Summary

Nested classes/interfaces inherited from interface com.hierynomus.protocol.commons.EnumWithValue

EnumWithValue.EnumUtils

Enum Constant Summary

Enum Constants

Enum Constant and Description
FILE_ATTRIBUTE_ARCHIVE A file or directory that requires to be archived.
FILE_ATTRIBUTE_COMPRESSED A file or directory that is compressed.
FILE_ATTRIBUTE_DIRECTORY This item is a directory.
FILE_ATTRIBUTE_ENCRYPTED A file or directory that is encrypted.
FILE_ATTRIBUTE_HIDDEN A file or directory that is hidden.
FILE_ATTRIBUTE_INTEGRITY_STREAM A file or directory that is configured with integrity support.
FILE_ATTRIBUTE_NO_SCRUB_DATA A file or directory that is configured to be excluded from the data integrity scan.
FILE_ATTRIBUTE_NORMAL A file that does not have other attributes set.
FILE_ATTRIBUTE_NOT_CONTENT_INDEXED A file or directory that is not indexed by the content indexing service.
FILE_ATTRIBUTE_OFFLINE The data in this file is not available immediately.
FILE_ATTRIBUTE_READONLY A file or directory that is read-only.
FILE_ATTRIBUTE_REPARSE_POINT A file or directory that has an associated reparse point.
FILE_ATTRIBUTE_SPARSE_FILE A file that is a sparse file.
FILE_ATTRIBUTE_SYSTEM A file or directory that the operating system uses a part of or uses exclusively.
FILE_ATTRIBUTE_TEMPORARY A file that is being used for temporary storage.

Method Summary

Modifier and Type	Method and Description
long	getValue()
static FileAttributes	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static FileAttributes[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

FILE_ATTRIBUTE_ARCHIVE

public static final FileAttributes FILE_ATTRIBUTE_ARCHIVE

A file or directory that requires to be archived. Applications use this attribute to mark files for backup or removal.

FILE_ATTRIBUTE_COMPRESSED

public static final FileAttributes FILE_ATTRIBUTE_COMPRESSED

A file or directory that is compressed. For a file, all of the data in the file is compressed. For a directory, compression is the default for newly created files and subdirectories.

FILE_ATTRIBUTE_DIRECTORY

public static final FileAttributes FILE_ATTRIBUTE_DIRECTORY

This item is a directory.

FILE_ATTRIBUTE_ENCRYPTED

public static final FileAttributes FILE_ATTRIBUTE_ENCRYPTED

A file or directory that is encrypted. For a file, all data streams in the file are encrypted. For a directory, encryption is the default for newly created files and subdirectories.

FILE_ATTRIBUTE_HIDDEN

public static final FileAttributes FILE_ATTRIBUTE_HIDDEN

A file or directory that is hidden. Files and directories marked with this attribute do not appear in an ordinary directory listing.

FILE_ATTRIBUTE_NORMAL

public static final FileAttributes FILE_ATTRIBUTE_NORMAL

A file that does not have other attributes set. This flag is used to clear all other flags by specifying it with no other flags set. This flag MUST be ignored if other flags are set.

FILE_ATTRIBUTE_NOT_CONTENT_INDEXED

public static final FileAttributes FILE_ATTRIBUTE_NOT_CONTENT_INDEXED

A file or directory that is not indexed by the content indexing service.

FILE_ATTRIBUTE_OFFLINE

public static final FileAttributes FILE_ATTRIBUTE_OFFLINE

The data in this file is not available immediately. This attribute indicates that the file data is physically moved to offline storage. This attribute is used by Remote Storage, which is hierarchical storage management software.

FILE_ATTRIBUTE_READONLY

public static final FileAttributes FILE_ATTRIBUTE_READONLY

A file or directory that is read-only. For a file, applications can read the file but cannot write to it or delete it. For a directory, applications cannot delete it, but applications can create and delete files from that directory.

FILE_ATTRIBUTE_REPARSE_POINT

public static final FileAttributes FILE_ATTRIBUTE_REPARSE_POINT

A file or directory that has an associated reparse point.

FILE_ATTRIBUTE_SPARSE_FILE

public static final FileAttributes FILE_ATTRIBUTE_SPARSE_FILE

A file that is a sparse file.

FILE_ATTRIBUTE_SYSTEM

public static final FileAttributes FILE_ATTRIBUTE_SYSTEM

A file or directory that the operating system uses a part of or uses exclusively.

FILE_ATTRIBUTE_TEMPORARY

public static final FileAttributes FILE_ATTRIBUTE_TEMPORARY

A file that is being used for temporary storage. The operating system may choose to store this file's data in memory rather than on mass storage, writing the data to mass storage only if data remains in the file when the file is closed.

FILE_ATTRIBUTE_INTEGRITY_STREAM

public static final FileAttributes FILE_ATTRIBUTE_INTEGRITY_STREAM

A file or directory that is configured with integrity support. For a file, all data streams in the file have integrity support. For a directory, integrity support is the default for newly created files and subdirectories, unless the caller specifies otherwise.

FILE_ATTRIBUTE_NO_SCRUB_DATA

public static final FileAttributes FILE_ATTRIBUTE_NO_SCRUB_DATA

A file or directory that is configured to be excluded from the data integrity scan. For a directory configured with FILE_ATTRIBUTE_NO_SCRUB_DATA, the default for newly created files and subdirectories is to inherit the FILE_ATTRIBUTE_NO_SCRUB_DATA attribute.

Method Detail

values

public static FileAttributes[] 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 (FileAttributes c : FileAttributes.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static FileAttributes valueOf(java.lang.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:

java.lang.IllegalArgumentException - if this enum type has no constant with the specified name

java.lang.NullPointerException - if the argument is null

getValue

public long getValue()

Specified by:

getValue in interface EnumWithValue<FileAttributes>