/**
 * Copyright Microsoft Corporation
 * 
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 * http://www.apache.org/licenses/LICENSE-2.0
 * 
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
/**
 * 
 */
package com.microsoft.azure.storage.file;

import com.microsoft.azure.storage.Constants;

import java.util.EnumSet;

Specifies options for NTFS Attributes.
/**
 * Specifies options for NTFS Attributes.
 */
public enum NtfsAttributes {

    
The file is read-only.
/**
     * The file is read-only.
     */
    READ_ONLY,

    
The file is hidden, and thus is not included in ordinary directory listing.
/**
     * The file is hidden, and thus is not included in ordinary directory listing.
     */
    HIDDEN,

    
The file is a system file. That is, the file is part of the operating system
or is used exclusively by the operating 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.
     */
    SYSTEM,

    
The file is a standard file that has no special attributes.
/**
     * The file is a standard file that has no special attributes.
     */
    NORMAL,

    
The file is a directory.
/**
     * The file is a directory.
     */
    DIRECTORY,

    
The file is a candidate for backup or removal.
/**
     * The file is a candidate for backup or removal.
     */
    ARCHIVE,

    
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.
/**
     * 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.
     */
    TEMPORARY,

    
The file is offline. The data of the file is not immediately available.
/**
     * The file is offline. The data of the file is not immediately available.
     */
    OFFLINE,

    
The file will not be indexed by the operating system's content indexing service.
/**
     * The file will not be indexed by the operating system's content indexing service.
     */
    NOT_CONTENT_INDEXED,

    
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.
/**
     * 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.
     */
    NO_SCRUB_DATA;

    
Converts an enum set of NtfsAttributes to a string. 
Returns:
A String that represents the NTFS Attributes in the correct format delimited by | which is described at toAttributes(String)./**
     * Converts an enum set of {@code NtfsAttributes} to a string.
     *
     * @return A <code>String</code> that represents the NTFS Attributes in the correct format delimited by |
     *         which is described at {@link #toAttributes(String)}.
     */
    public static String toString(EnumSet<NtfsAttributes> ntfsAttributes) {
        if (ntfsAttributes == null) {
            return Constants.EMPTY_STRING;
        }

        final StringBuilder builder = new StringBuilder();

        if (ntfsAttributes.contains(NtfsAttributes.READ_ONLY)) {
            builder.append("ReadOnly|");
        }

        if (ntfsAttributes.contains(NtfsAttributes.HIDDEN)) {
            builder.append("Hidden|");
        }

        if (ntfsAttributes.contains(NtfsAttributes.SYSTEM)) {
            builder.append("System|");
        }

        if (ntfsAttributes.contains(NtfsAttributes.NORMAL)) {
            builder.append("None|");
        }

        if (ntfsAttributes.contains(NtfsAttributes.DIRECTORY)) {
            builder.append("Directory|");
        }

        if (ntfsAttributes.contains(NtfsAttributes.ARCHIVE)) {
            builder.append("Archive|");
        }

        if (ntfsAttributes.contains(NtfsAttributes.TEMPORARY)) {
            builder.append("Temporary|");
        }

        if (ntfsAttributes.contains(NtfsAttributes.OFFLINE)) {
            builder.append("Offline|");
        }

        if (ntfsAttributes.contains(NtfsAttributes.NOT_CONTENT_INDEXED)) {
            builder.append("NotContentIndexed|");
        }

        if (ntfsAttributes.contains(NtfsAttributes.NO_SCRUB_DATA)) {
            builder.append("NoScrubData|");
        }

        builder.deleteCharAt(builder.lastIndexOf("|"));

        return builder.toString();
    }

    
Creates an enum set of NtfsAttributes from a valid String . 
Params:
ntfsAttributes – 
           A String 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
           /**
     * Creates an enum set of {@code NtfsAttributes} from a valid String .
     *
     * @param ntfsAttributes
     *            A <code>String</code> that represents the ntfs attributes. The string must contain one or
     *            more of the following values delimited by a |. Note they are case sensitive.
     *            <ul>
     *            <li><code>ReadOnly</code></li>
     *            <li><code>Hidden</code></li>
     *            <li><code>System</code></li>
     *            <li><code>None</code></li>
     *            <li><code>Directory</code></li>
     *            <li><code>Archive</code></li>
     *            <li><code>Temporary</code></li>
     *            <li><code>Offline</code></li>
     *            <li><code>NotContentIndexed</code></li>
     *            <li><code>NoScrubData</code></li>
     *            </ul>
     */
    public static EnumSet<NtfsAttributes> toAttributes(String ntfsAttributes) {
        EnumSet<NtfsAttributes> attributes = EnumSet.noneOf(NtfsAttributes.class);
        String[] splitAttributes = ntfsAttributes.split("\\|");

        for(String sa: splitAttributes) {
            if (sa.equals("ReadOnly")) {
                attributes.add(NtfsAttributes.READ_ONLY);
            } else if (sa.equals("Hidden")) {
                attributes.add(NtfsAttributes.HIDDEN);
            } else if (sa.equals("System")) {
                attributes.add(NtfsAttributes.SYSTEM);
            } else if (sa.equals("None")) {
                attributes.add(NtfsAttributes.NORMAL);
            } else if (sa.equals("Directory")) {
                attributes.add(NtfsAttributes.DIRECTORY);
            } else if (sa.equals("Archive")) {
                attributes.add(NtfsAttributes.ARCHIVE);
            } else if (sa.equals("Temporary")) {
                attributes.add(NtfsAttributes.TEMPORARY);
            } else if (sa.equals("Offline")) {
                attributes.add(NtfsAttributes.OFFLINE);
            } else if (sa.equals("NotContentIndexed")) {
                attributes.add(NtfsAttributes.NOT_CONTENT_INDEXED);
            } else if (sa.equals("NoScrubData")) {
                attributes.add(NtfsAttributes.NO_SCRUB_DATA);
            } else {
                throw new IllegalArgumentException("value");
            }
        }

        return attributes;
    }

}