Package io.github.henryssondaniel.teacup.protocol.ftp.client

Enum Factory

java.lang.Object

java.lang.Enum<Factory>

io.github.henryssondaniel.teacup.protocol.ftp.client.Factory

All Implemented Interfaces:

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

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

Factory class for the client package.

Since:

1.0

Method Summary

Modifier and Type	Method	Description
static Client	createClient()	Creates a new Client.
static ConfigurationBuilder	createConfigurationBuilder(java.lang.String systemKey)	Creates a new ConfigurationBuilder.
static SecureClient	createSecureClient(boolean isImplicit)	Creates a new SecureClient.
static SecureClient	createSecureClient(boolean isImplicit, java.lang.String protocol)	Creates a new SecureClient.
static SecureClient	createSecureClient(boolean isImplicit, javax.net.ssl.SSLContext sslContext)	Creates a new SecureClient.
static Factory	valueOf(java.lang.String name)	Returns the enum constant of this type with the specified name.
static Factory[]	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

Method Detail

values

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

Returns:

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

valueOf

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

createClient

public static Client createClient()

Creates a new Client.

Returns:

the client

Since:

1.0

createConfigurationBuilder

public static ConfigurationBuilder createConfigurationBuilder(java.lang.String systemKey)

Creates a new ConfigurationBuilder.

Parameters:

systemKey - the system key

Returns:

the configuration builder

Since:

1.0

createSecureClient

public static SecureClient createSecureClient(boolean isImplicit)

Creates a new SecureClient.

Parameters:

isImplicit - whether the client is implicit

Returns:

the secure client

Since:

1.0

createSecureClient

public static SecureClient createSecureClient(boolean isImplicit,
                                              java.lang.String protocol)

Creates a new SecureClient.

Parameters:

isImplicit - whether the client is implicit

protocol - the protocol

Returns:

the secure client

Since:

1.0

createSecureClient

public static SecureClient createSecureClient(boolean isImplicit,
                                              javax.net.ssl.SSLContext sslContext)

Creates a new SecureClient.

Parameters:

isImplicit - whether the client is implicit

sslContext - the SSL context

Returns:

the secure client

Since:

1.0