org.jnetstream.capture.file
Enum RecordType

java.lang.Object
  java.lang.Enum<RecordType>
      org.jnetstream.capture.file.RecordType

All Implemented Interfaces:

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

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

Generic record types found within capture files.

Author:

Mark Bednarczyk, Sly Technologies, Inc.

Enum Constant Summary

BlockRecord
Defines global properties for entire block of records.

MetaRecord
A data record within a block record that contain meta information about the block and about packet records.

PacketRecord
A data record within a block record that contains packet data.

Method Summary

static RecordType	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static RecordType[]	values() Returns an array containing the constants of this enum type, in the order they're declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

BlockRecord

public static final RecordType BlockRecord

Defines global properties for entire block of records. Also known as file header in single block record formats such as Pcap and Snoop. Other formats may contain more than one single block record within a file and thus it is not appropriate to call this type of record a file header its not strictly that alone.

PacketRecord

public static final RecordType PacketRecord

A data record within a block record that contains packet data.

MetaRecord

public static final RecordType MetaRecord

A data record within a block record that contain meta information about the block and about packet records. Certain file formats use additional records within a file to store additional or meta information besides the basic packet data.

Method Detail

values

public static final RecordType[] values()

Returns an array containing the constants of this enum type, in the order they're declared. This method may be used to iterate over the constants as follows:

for(RecordType c : RecordType.values())
        System.out.println(c);

Returns:

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

valueOf

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