/*
 * Copyright (c) 2007, 2018, Oracle and/or its affiliates. All rights reserved.
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
 *
 * This code is free software; you can redistribute it and/or modify it
 * under the terms of the GNU General Public License version 2 only, as
 * published by the Free Software Foundation.  Oracle designates this
 * particular file as subject to the "Classpath" exception as provided
 * by Oracle in the LICENSE file that accompanied this code.
 *
 * This code is distributed in the hope that it will be useful, but WITHOUT
 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
 * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
 * version 2 for more details (a copy is included in the LICENSE file that
 * accompanied this code).
 *
 * You should have received a copy of the GNU General Public License version
 * 2 along with this work; if not, write to the Free Software Foundation,
 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
 *
 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
 * or visit www.oracle.com if you need additional information or have any
 * questions.
 */

package com.sun.nio.file;

import java.nio.file.OpenOption;
import jdk.internal.misc.FileSystemOption;

Defines extended open options supported on some platforms
by Sun's provider implementation.
Since:
1.7/**
 * Defines <em>extended</em> open options supported on some platforms
 * by Sun's provider implementation.
 *
 * @since 1.7
 */

public enum ExtendedOpenOption implements OpenOption {
    
Prevent operations on the file that request read access.
/**
     * Prevent operations on the file that request read access.
     */
    NOSHARE_READ(FileSystemOption.NOSHARE_READ),
    
Prevent operations on the file that request write access.
/**
     * Prevent operations on the file that request write access.
     */
    NOSHARE_WRITE(FileSystemOption.NOSHARE_WRITE),
    
Prevent operations on the file that request delete access.
/**
     * Prevent operations on the file that request delete access.
     */
    NOSHARE_DELETE(FileSystemOption.NOSHARE_DELETE),

    
Requires that direct I/O be used for read or write access. Attempting to open a file with this option set will result in an UnsupportedOperationException if the operating system or file system does not support Direct I/O or a sufficient equivalent. 
API Note:

The DIRECT option enables performing file I/O directly between user
buffers and the file thereby circumventing the operating system page
cache and possibly avoiding the thrashing which could otherwise occur
in I/O-intensive applications. This option may be of benefit to
applications which do their own caching or do random I/O operations
on large data sets. It is likely to provide the most benefit when
the file is stored on a device which has high I/O throughput capacity.
The option should be used with caution however as in general it is
likely to degrade performance. The performance effects of using it
should be evaluated in each particular circumstance.
Since:
10/**
     * Requires that direct I/O be used for read or write access.
     * Attempting to open a file with this option set will result in
     * an {@code UnsupportedOperationException} if the operating system or
     * file system does not support Direct I/O or a sufficient equivalent.
     *
     * @apiNote
     * The DIRECT option enables performing file I/O directly between user
     * buffers and the file thereby circumventing the operating system page
     * cache and possibly avoiding the thrashing which could otherwise occur
     * in I/O-intensive applications. This option may be of benefit to
     * applications which do their own caching or do random I/O operations
     * on large data sets. It is likely to provide the most benefit when
     * the file is stored on a device which has high I/O throughput capacity.
     * The option should be used with caution however as in general it is
     * likely to degrade performance. The performance effects of using it
     * should be evaluated in each particular circumstance.
     *
     * @since 10
     */
    DIRECT(FileSystemOption.DIRECT);

    ExtendedOpenOption(FileSystemOption<Void> option) {
        option.register(this);
    }
}