Enum FtpRemoteFileTemplate.ExistsMode

java.lang.Object
java.lang.Enum<FtpRemoteFileTemplate.ExistsMode>
org.springframework.integration.ftp.session.FtpRemoteFileTemplate.ExistsMode
All Implemented Interfaces:
java.io.Serializable, java.lang.Comparable<FtpRemoteFileTemplate.ExistsMode>, java.lang.constant.Constable
Enclosing class:
FtpRemoteFileTemplate

public static enum FtpRemoteFileTemplate.ExistsMode
extends java.lang.Enum<FtpRemoteFileTemplate.ExistsMode>
Since:
4.1.9
  • Nested Class Summary

    Nested classes/interfaces inherited from class java.lang.Enum

    java.lang.Enum.EnumDesc<E extends java.lang.Enum<E>>
  • Enum Constant Summary

    Enum Constants 
    Enum Constant Description
    NLST
    Perform the NLST FTP command.
    NLST_AND_DIRS
    Perform the NLST FTP command and fall back to FTPClient.changeWorkingDirectory(String).
    STAT
    Perform the STAT FTP command.
  • Method Summary

    Modifier and Type Method Description
    static FtpRemoteFileTemplate.ExistsMode valueOf​(java.lang.String name)
    Returns the enum constant of this type with the specified name.
    static FtpRemoteFileTemplate.ExistsMode[] 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, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

    Methods inherited from class java.lang.Object

    getClass, notify, notifyAll, wait, wait, wait
  • Enum Constant Details

    • STAT

      public static final FtpRemoteFileTemplate.ExistsMode STAT
      Perform the STAT FTP command. Default.
    • NLST

      public static final FtpRemoteFileTemplate.ExistsMode NLST
      Perform the NLST FTP command. Used as default internally by framework components for files only operations.
    • NLST_AND_DIRS

      public static final FtpRemoteFileTemplate.ExistsMode NLST_AND_DIRS
      Perform the NLST FTP command and fall back to FTPClient.changeWorkingDirectory(String).

      This technique is required when you want to check if a directory exists and the server does not support STAT - it requires 4 requests/replies.

      If you are only checking for an existing file, NLST is preferred (unless STAT is supported).

      See Also:
      FtpSession.exists(String)
  • Method Details

    • values

      public static FtpRemoteFileTemplate.ExistsMode[] 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 FtpRemoteFileTemplate.ExistsMode 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