Package uk.co.sculptor.kflibjava

Enum Class Server.CopyOption

java.lang.Object

java.lang.Enum<Server.CopyOption>

uk.co.sculptor.kflibjava.Server.CopyOption

All Implemented Interfaces:

Serializable, Comparable<Server.CopyOption>, Constable

Enclosing class:

Server

public static enum Server.CopyOption
extends Enum<Server.CopyOption>

Enumerator flags used to specify the copyFile options.

Nested Class Summary

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

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
BINARY	Copy binary file.
MAKEPATH	Make destination path.
NONE	No flag
TEXT	Copy text file.
TIME	Copy time last updated.
UPDATE	Copy if missing or newer.

Method Summary

Modifier and Type	Method	Description
long	getLong()	Returns the Execution flag as the long value used on KfServer
static int	getScValue(EnumSet<Server.CopyOption> options)	Convert a EnumSet of CopyOption's to the sculptor value used on the server.
static Server.CopyOption	valueOf(String name)	Returns the enum constant of this class with the specified name.
static Server.CopyOption[]	values()	Returns an array containing the constants of this enum class, 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

NONE

public static final Server.CopyOption NONE

No flag

TEXT

public static final Server.CopyOption TEXT

Copy text file.

UPDATE

public static final Server.CopyOption UPDATE

Copy if missing or newer.

BINARY

public static final Server.CopyOption BINARY

Copy binary file.

TIME

public static final Server.CopyOption TIME

Copy time last updated.

MAKEPATH

public static final Server.CopyOption MAKEPATH

Make destination path.

Method Details

values

public static Server.CopyOption[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

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

valueOf

public static Server.CopyOption valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (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 class has no constant with the specified name

NullPointerException - if the argument is null

getScValue

public static int getScValue(EnumSet<Server.CopyOption> options)

Convert a EnumSet of CopyOption's to the sculptor value used on the server.

Parameters:

options - Server.CopyOption Enumerator set

Returns:

the sculptor value used on KfServer.

getLong

public long getLong()

Returns the Execution flag as the long value used on KfServer

Returns:

Execution flag as the long value used on KfServer