org.neociclo.odetteftp.protocol.v20
Enum ReleaseFormatVer20

java.lang.Object
  extended by java.lang.Enum<ReleaseFormatVer20>
      extended by org.neociclo.odetteftp.protocol.v20.ReleaseFormatVer20
All Implemented Interfaces:
Serializable, Comparable<ReleaseFormatVer20>, CommandFormat

public enum ReleaseFormatVer20
extends Enum<ReleaseFormatVer20>
implements CommandFormat

Version:
$Rev: 767 $ $Date: 2010-10-06 17:40:59 -0300 (Wed, 06 Oct 2010) $
Author:
Rafael Marins

Nested Class Summary
 
Nested classes/interfaces inherited from interface org.neociclo.odetteftp.protocol.CommandFormat
CommandFormat.Field
 
Enum Constant Summary
AUCH_V20
          Authentication Challenge.
AURP_V20
          Authentication Response.
CD_V20
          Change Direction command format.
CDT_V20
          Set Credit command format.
EERP_V20
          End-to-End Response command format.
EFID_V20
          End File command format.
EFNA_V20
          End File Negative Answer command format.
EFPA_V20
          End File Positive Answer command format.
ESID_V20
          End Session command format.
NERP_V20
          Negative End Response command format.
RTR_V20
          Ready To Receive command format.
SECD_V20
          Security Change Direction.
SFID_V20
          Start File command format.
SFNA_V20
          Start File Negative Answer command format.
SFPA_V20
          Start File Positive Answer command format.
SSID_V20
          Start Session command format.
SSRM_V20
          Start Session Ready Message command format.
 
Method Summary
 CommandFormat.Field getField(String name)
          Return a Command Format field definition by its key name.
 String[] getFieldNames()
           
static CommandFormat getFormat(CommandIdentifier identifier)
          Return the Command Format definition given a specific Command identifier code of ODETTE-FTP version 2.0.
 CommandIdentifier getIdentifier()
           
 int getSize()
          On protocol version 2.0 implementation the command size must be computed dynamically based on 'dynamic fields' definition.
static ReleaseFormatVer20 valueOf(String name)
          Returns the enum constant of this type with the specified name.
static ReleaseFormatVer20[] 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

CD_V20

public static final ReleaseFormatVer20 CD_V20
Change Direction command format.


CDT_V20

public static final ReleaseFormatVer20 CDT_V20
Set Credit command format.


EERP_V20

public static final ReleaseFormatVer20 EERP_V20
End-to-End Response command format.


EFID_V20

public static final ReleaseFormatVer20 EFID_V20
End File command format.


EFNA_V20

public static final ReleaseFormatVer20 EFNA_V20
End File Negative Answer command format.


EFPA_V20

public static final ReleaseFormatVer20 EFPA_V20
End File Positive Answer command format.


ESID_V20

public static final ReleaseFormatVer20 ESID_V20
End Session command format.


NERP_V20

public static final ReleaseFormatVer20 NERP_V20
Negative End Response command format.


RTR_V20

public static final ReleaseFormatVer20 RTR_V20
Ready To Receive command format.


SFID_V20

public static final ReleaseFormatVer20 SFID_V20
Start File command format.


SFNA_V20

public static final ReleaseFormatVer20 SFNA_V20
Start File Negative Answer command format.


SFPA_V20

public static final ReleaseFormatVer20 SFPA_V20
Start File Positive Answer command format.


SSID_V20

public static final ReleaseFormatVer20 SSID_V20
Start Session command format.


SSRM_V20

public static final ReleaseFormatVer20 SSRM_V20
Start Session Ready Message command format.


SECD_V20

public static final ReleaseFormatVer20 SECD_V20
Security Change Direction.


AUCH_V20

public static final ReleaseFormatVer20 AUCH_V20
Authentication Challenge.


AURP_V20

public static final ReleaseFormatVer20 AURP_V20
Authentication Response.

Method Detail

values

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

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

valueOf

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

getFormat

public static CommandFormat getFormat(CommandIdentifier identifier)
Return the Command Format definition given a specific Command identifier code of ODETTE-FTP version 2.0.

Parameters:
identifier - One of the CommandIdentifier static attribute.
Returns:
The corresponding Command Format definition.

getField

public CommandFormat.Field getField(String name)
Description copied from interface: CommandFormat
Return a Command Format field definition by its key name.

Specified by:
getField in interface CommandFormat
Parameters:
name - Field key name within Command Format.
Returns:
Field definition, or null if it does not exist.

getFieldNames

public String[] getFieldNames()
Specified by:
getFieldNames in interface CommandFormat

getIdentifier

public CommandIdentifier getIdentifier()
Specified by:
getIdentifier in interface CommandFormat

getSize

public int getSize()
On protocol version 2.0 implementation the command size must be computed dynamically based on 'dynamic fields' definition.

Specified by:
getSize in interface CommandFormat
Returns:
Return -1 as it shouldn't be used on v2.0


ACCORD