com.github.robtimus.filesystems.ftp

Enum StandardFTPFileStrategyFactory

java.lang.Object

java.lang.Enum<StandardFTPFileStrategyFactory>

com.github.robtimus.filesystems.ftp.StandardFTPFileStrategyFactory

All Implemented Interfaces:

FTPFileStrategyFactory, Serializable, Comparable<StandardFTPFileStrategyFactory>

public enum StandardFTPFileStrategyFactory
extends Enum<StandardFTPFileStrategyFactory>
implements FTPFileStrategyFactory

Defines the standard FTPFileStrategy factories.

Author:

Rob Spoor

Since:

2.0

Enum Constant Summary

Enum Constants

Enum Constant and Description
AUTO_DETECT An FTPFileStrategy factory that delegates to FTPFileStrategy.autoDetect().
NON_UNIX An FTPFileStrategy factory that delegates to FTPFileStrategy.nonUnix().
UNIX An FTPFileStrategy factory that delegates to FTPFileStrategy.unix().

Method Summary

Modifier and Type	Method and Description
FTPFileStrategy	createFTPFileStrategy() Creates an FTPFileStrategy.
static StandardFTPFileStrategyFactory	valueOf(String name) Returns the enum constant of this type with the specified name.
static StandardFTPFileStrategyFactory[]	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

Enum Constant Detail

UNIX

public static final StandardFTPFileStrategyFactory UNIX

An FTPFileStrategy factory that delegates to FTPFileStrategy.unix().

NON_UNIX

public static final StandardFTPFileStrategyFactory NON_UNIX

An FTPFileStrategy factory that delegates to FTPFileStrategy.nonUnix().

AUTO_DETECT

public static final StandardFTPFileStrategyFactory AUTO_DETECT

An FTPFileStrategy factory that delegates to FTPFileStrategy.autoDetect().

Method Detail

values

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

Returns:

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

valueOf

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

createFTPFileStrategy

public FTPFileStrategy createFTPFileStrategy()

Description copied from interface: FTPFileStrategyFactory

Creates an FTPFileStrategy. This FTPFileStrategy will be tied to a specific FTP file system.

Note: it is allowed to return shared instances if these do not contain any state that is specific to an FTP file system.

Specified by:

createFTPFileStrategy in interface FTPFileStrategyFactory

Returns:

The created FTPFileStrategy.