com.partnersoft.net.yonder
Enum YonderOp

java.lang.Object
  java.lang.Enum<YonderOp>
      com.partnersoft.net.yonder.YonderOp

All Implemented Interfaces:

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

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

Defined Yonder file operations.

Copyright 2008 Partner Software, Inc.

Version:

$Id$

Author:

Paul Reavis

Enum Constant Summary

CLOSE
Close operator.

CONNECT
Connect operator.

DISCONNECT
Disconnect operator.

EOF
End-of-file operator; intentionally has same code as EOF (-1) returned by Java's InputStream.read() method.

ERROR
Error operator.

GET_LENGTH
Get-length operator.

INFO
File info request operator.

LIST
Directory listing operator.

MAKE_DIRECTORY
Make directory operator.

NOK
Non-confirmation operator.

OK
Confirmation operator.

OPEN
Open operator.

READ
Read operator.

REMOVE
Remove operator.

SET_LENGTH
Set-length operator.

WRITE
Write operator.

Method Summary

static YonderOp	forCode(int code)
static YonderOp	forName(java.lang.String name)
int	getCode() Single-byte code used during transfer.
java.lang.String	getName() Human-readable name for the op.
java.lang.String	toString()
static YonderOp	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static YonderOp[]	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, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

EOF

public static final YonderOp EOF

End-of-file operator; intentionally has same code as EOF (-1) returned by Java's InputStream.read() method.

ERROR

public static final YonderOp ERROR

Error operator.

OK

public static final YonderOp OK

Confirmation operator. Indicates true or successful completion.

NOK

public static final YonderOp NOK

Non-confirmation operator. Indicates false or unsuccessful completion.

CONNECT

public static final YonderOp CONNECT

Connect operator.

DISCONNECT

public static final YonderOp DISCONNECT

Disconnect operator.

INFO

public static final YonderOp INFO

File info request operator.

LIST

public static final YonderOp LIST

Directory listing operator.

OPEN

public static final YonderOp OPEN

Open operator. Opens a remote file for random access I/O.

CLOSE

public static final YonderOp CLOSE

Close operator. Closes a file opened by the OPEN op.

READ

public static final YonderOp READ

Read operator. Reads from a file opened by the OPEN op.

WRITE

public static final YonderOp WRITE

Write operator. Writes to a file opened by the OPEN op.

GET_LENGTH

public static final YonderOp GET_LENGTH

Get-length operator. Refers to a file opened by the OPEN op.

SET_LENGTH

public static final YonderOp SET_LENGTH

Set-length operator. Refers to a file opened by the OPEN op.

MAKE_DIRECTORY

public static final YonderOp MAKE_DIRECTORY

Make directory operator.

REMOVE

public static final YonderOp REMOVE

Remove operator.

Method Detail

values

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

Returns:

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

valueOf

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

forName

public static YonderOp forName(java.lang.String name)

forCode

public static YonderOp forCode(int code)

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Enum<YonderOp>

getName

public java.lang.String getName()

Human-readable name for the op.

getCode

public int getCode()

Single-byte code used during transfer.

Returns: