com.github.robtimus.filesystems.ftp

Class FileType

java.lang.Object

com.github.robtimus.filesystems.ftp.FileType

All Implemented Interfaces:

CopyOption, OpenOption

public final class FileType
extends Object
implements OpenOption, CopyOption

Represents FTP file types.

Author:

Rob Spoor

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	FileType.Format The possible FTP text formats.

Method Summary

Modifier and Type	Method and Description
static FileType	ascii() Returns an ASCII file type with an unspecified text format.
static FileType	ascii(FileType.Format format) Returns an ASCII file type with a specific text format.
static FileType	binary() Returns a binary file type with an unspecified text format.
static FileType	ebcdic() Returns an EBCDIC file type with an unspecified text format.
static FileType	ebcdic(FileType.Format format) Returns an EBCDIC file type with a specific text format.
boolean	equals(Object o)
int	hashCode()
static FileType	local() Returns a local file type with an unspecified byte size.
static FileType	local(int byteSize) Returns a local file type with a specific byte size.
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Method Detail

ascii

public static FileType ascii()

Returns an ASCII file type with an unspecified text format.

Returns:

An ASCII file type with an unspecified text format.

ascii

public static FileType ascii(FileType.Format format)

Returns an ASCII file type with a specific text format.

Parameters:

format - The text format for the file type; ignored if null.

Returns:

An ASCII file type with the given text format.

ebcdic

public static FileType ebcdic()

Returns an EBCDIC file type with an unspecified text format.

Returns:

An EBCDIC file type with an unspecified text format.

ebcdic

public static FileType ebcdic(FileType.Format format)

Returns an EBCDIC file type with a specific text format.

Parameters:

format - The text format for the file type; ignored if null.

Returns:

An EBCDIC file type with the given text format.

binary

public static FileType binary()

Returns a binary file type with an unspecified text format.

Returns:

A binary file type with an unspecified text format.

local

public static FileType local()

Returns a local file type with an unspecified byte size.

Returns:

A local file type with an unspecified byte size.

local

public static FileType local(int byteSize)

Returns a local file type with a specific byte size.

Parameters:

byteSize - The byte size for the file type; ignored if not larger than 0.

Returns:

A binary file type with the given text format.

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object