net.digger.protocol.xymodem

Enum XYModem.OverrunOption

java.lang.Object

java.lang.Enum<XYModem.OverrunOption>

net.digger.protocol.xymodem.XYModem.OverrunOption

All Implemented Interfaces:

Serializable, Comparable<XYModem.OverrunOption>

Enclosing class:

XYModem

public static enum XYModem.OverrunOption
extends Enum<XYModem.OverrunOption>

Behavior options for data received past the end of a downloaded file, when file length is provided by sender in YModem protocol.

Enum Constant Summary

Enum Constants

Enum Constant and Description
ACCEPT Accept all extra data in file.
ERROR If downloaded file ends on the expected packet, length will be enforced as in OverrunOption.IGNORE.
IGNORE Ignore the extra data, and limit the file to the declared size.
MIXED Default setting.

Method Summary

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

IGNORE

public static final XYModem.OverrunOption IGNORE

Ignore the extra data, and limit the file to the declared size. When sender provides file length, the resulting file will always match that length. This is what the YModem spec calls for, but can result in data loss if for some reason the file is longer than the sender reported.

ERROR

public static final XYModem.OverrunOption ERROR

If downloaded file ends on the expected packet, length will be enforced as in OverrunOption.IGNORE. If downloaded file continues with additional packets, trigger an error and cancel the download.

ACCEPT

public static final XYModem.OverrunOption ACCEPT

Accept all extra data in file. All downloaded files will be padded to the packet size. This makes YModem behave the same as XModem in that regard.

MIXED

public static final XYModem.OverrunOption MIXED

Default setting. If downloaded file ends on the expected packet, length will be enforced as in OverrunOption.IGNORE. If downloaded file continues with additional packets, they will be kept as in OverrunOption.ACCEPT.

Method Detail

values

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

Returns:

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

valueOf

public static XYModem.OverrunOption 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