flux.file

Enum FtpTransferMode

java.lang.Object

java.lang.Enum<FtpTransferMode>

flux.file.FtpTransferMode

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<FtpTransferMode>

public enum FtpTransferMode
extends java.lang.Enum<FtpTransferMode>

Indicates the transfer mode to use when transferring files using FTP, Secure FTP (SFTP), or FTP-over-SSL (FTPS). With binary mode file transfers, files are copied verbatim. With ASCII mode file transfers, line endings are converted between Unix and DOS.

Author:

Copyright 2000-2025 Flux Corporation. All rights reserved.

Enum Constant Summary

Enum Constants

Enum Constant and Description
ASCII ASCII transfer mode, which converts files accordingly from DOS to Unix and vice-versa.
BINARY Binary transfer mode, which transfers files without modifying them en route.

Method Summary

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

Methods inherited from class java.lang.Enum

compareTo, equals, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

BINARY

public static final FtpTransferMode BINARY

Binary transfer mode, which transfers files without modifying them en route.

ASCII

public static final FtpTransferMode ASCII

ASCII transfer mode, which converts files accordingly from DOS to Unix and vice-versa.

Method Detail

values

public static FtpTransferMode[] 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 (FtpTransferMode c : FtpTransferMode.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static FtpTransferMode 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