org.bouncycastle.bcpg

Enum PacketFormat

java.lang.Object

java.lang.Enum<PacketFormat>

org.bouncycastle.bcpg.PacketFormat

All Implemented Interfaces:

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

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

OpenPGP Packet Header Length Format.

See Also:

OpenPGP Packet Headers

Enum Constant Summary

Enum Constants

Enum Constant and Description
CURRENT Always use the current (new) packet format.
LEGACY Always use the old (legacy) packet format.
ROUNDTRIP Let the individual packet decide the format (see Packet.hasNewPacketFormat()).

Method Summary

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

LEGACY

public static final PacketFormat LEGACY

Always use the old (legacy) packet format.

CURRENT

public static final PacketFormat CURRENT

Always use the current (new) packet format.

ROUNDTRIP

public static final PacketFormat ROUNDTRIP

Let the individual packet decide the format (see Packet.hasNewPacketFormat()). This allows to round-trip packets without changing the packet format.

Method Detail

values

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

Returns:

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

valueOf

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