LinkOption (Java SE 13 & JDK 13 )
Description: declaration: module: java.base, package: java.nio.file, enum: LinkOption
Keywords: java.nio.file.LinkOption class

Module java.base
Package java.nio.file

# Enum LinkOption

java.lang.Object
java.lang.Enum<LinkOption>
java.nio.file.LinkOption

All Implemented Interfaces:
  `Serializable`, `Comparable<LinkOption>`, `Constable`, `CopyOption`, `OpenOption`

    public enum LinkOption
    extends Enum<LinkOption>
    implements OpenOption, CopyOption

Defines the options as to how symbolic links are handled.

Since:
  1.7

- ## Nested Class Summary

  ## Nested classes/interfaces declared in class java.lang.Enum

  `Enum.EnumDesc<E extends Enum<E>>`

- ## Enum Constant Summary

  Enum Constants
  Enum Constant | Description
  --- | ---
  `NOFOLLOW_LINKS` | Do not follow symbolic links.

- ## Method Summary

  Modifier and Type | Method | Description
  --- | --- | ---
  `static LinkOption` | `valueOf​(String name)` | Returns the enum constant of this type with the specified name.
  `static LinkOption[]` | `values()` | Returns an array containing the constants of this enum type, in the order they are declared.

  ### Methods declared in class java.lang.Enum

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

  ### Methods declared in class java.lang.Object

  `getClass, notify, notifyAll, wait, wait, wait`

- ## Enum Constant Details

  - ### NOFOLLOW_LINKS

    public static final LinkOption NOFOLLOW_LINKS
    Do not follow symbolic links.
    See Also:
      `Files.getFileAttributeView(Path,Class,LinkOption[])`, `Files.copy(java.nio.file.Path, java.nio.file.Path, java.nio.file.CopyOption...)`, `SecureDirectoryStream.newByteChannel(T, java.util.Set<? extends java.nio.file.OpenOption>, java.nio.file.attribute.FileAttribute<?>...)`

- ## Method Details

  - ### values

    public static LinkOption[] values()
    Returns an array containing the constants of this enum type, in the order they are declared.
    Returns:
      an array containing the constants of this enum type, in the order they are declared

  - ### valueOf

    public static LinkOption 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 name
      `NullPointerException` - if the argument is null