Enum SftpClient.OpenMode

    • Constructor Summary

      Constructors 
      Modifier Constructor Description
      private OpenMode()  
    • Method Summary

      All Methods Static Methods Concrete Methods 
      Modifier and Type Method Description
      static java.util.Set<SftpClient.OpenMode> fromOpenOptions​(java.util.Collection<? extends java.nio.file.OpenOption> options)
      Converts StandardOpenOption-s into SftpClient.OpenMode-s
      static SftpClient.OpenMode valueOf​(java.lang.String name)
      Returns the enum constant of this type with the specified name.
      static SftpClient.OpenMode[] 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
    • Field Detail

      • SUPPORTED_OPTIONS

        public static final java.util.Set<java.nio.file.OpenOption> SUPPORTED_OPTIONS
        The Set of OpenOption-s supported by fromOpenOptions(Collection)
    • Constructor Detail

      • OpenMode

        private OpenMode()
    • Method Detail

      • values

        public static SftpClient.OpenMode[] 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 (SftpClient.OpenMode c : SftpClient.OpenMode.values())
            System.out.println(c);
        
        Returns:
        an array containing the constants of this enum type, in the order they are declared
      • valueOf

        public static SftpClient.OpenMode 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
      • fromOpenOptions

        public static java.util.Set<SftpClient.OpenMode> fromOpenOptions​(java.util.Collection<? extends java.nio.file.OpenOption> options)
        Converts StandardOpenOption-s into SftpClient.OpenMode-s
        Parameters:
        options - The original options - ignored if null/empty
        Returns:
        A modifiable Set of the equivalent modes
        Throws:
        java.lang.IllegalArgumentException - If an unsupported option is requested
        See Also:
        SUPPORTED_OPTIONS