jnetpcap.capture.file
Enum Record.Capability

java.lang.Object
  java.lang.Enum<Record.Capability>
      jnetpcap.capture.file.Record.Capability

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<Record.Capability>

Enclosing interface:

Record

public static enum Record.Capability
extends java.lang.Enum<Record.Capability>

Enum constants that describe certain capabilities and thus information a particular type of record may contain. Some implementations may contain additional capabilities not defined by these constants.

Author:

Mark Bednarczyk, Sly Technologies, Inc.

Enum Constant Summary

AnalyzerStatistics
Record contains analyzer produced statistics

CaptureTimestampMicros
Record contains capture a timestamps of fraction of a seconds in micros.

CaptureTimestampNanos
Record contains capture a timestamps of fraction of a seconds in nanos.

CaptureTimestampSeconds
Record contains capture a timestamps in seconds

EntityTimezone
Timezone information about the capture entity or capture system is known.

FileCompression
Record contains a compression algorithm information to compress the files content

FileEncryption
Record contains information about file encryption algorithm.

FileMagicNumber
Record contains a MAGIC number specific for this file type.

FilePaceholder

FilePassword
Record contains a password to protect the file

FileVersion
Record contains version information about the file or block within the file.

InPlaceMutableBlock
Block contents can be mutated in place without file copies (size and content can change)

InterfaceCounterDrops
Record contains interface packet drops counter

InterfaceCounterInOctects
Record contains interface ingres octets counters.

InterfaceCounterInPackets
Record contains interface ingres packet counter

InterfaceCounterOutOctects
Record contains interface egress octet counter.

InterfaceCounterOutPackets
Record contains interface egress packet counter

PacketBuffer
Record contains a packet buffer with packet data.

PacketProtocol
Record contains information about PacketProtocol, the first protocol, usually linktype, within the PacketBuffer.

UserProperties
Record contains user properties in AV pair format "property = value"

Method Summary

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

Methods inherited from class java.lang.Enum

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

PacketBuffer

public static final Record.Capability PacketBuffer

Record contains a packet buffer with packet data.

PacketProtocol

public static final Record.Capability PacketProtocol

Record contains information about PacketProtocol, the first protocol, usually linktype, within the PacketBuffer.

CaptureTimestampSeconds

public static final Record.Capability CaptureTimestampSeconds

Record contains capture a timestamps in seconds

CaptureTimestampMicros

public static final Record.Capability CaptureTimestampMicros

Record contains capture a timestamps of fraction of a seconds in micros. Legal value is between 0 and 999,999 inclusive

CaptureTimestampNanos

public static final Record.Capability CaptureTimestampNanos

Record contains capture a timestamps of fraction of a seconds in nanos. Legal value is between 0 and 999,999,999 inclusive

EntityTimezone

public static final Record.Capability EntityTimezone

Timezone information about the capture entity or capture system is known. For remote capture systems, the timezone may be different.

InterfaceCounterDrops

public static final Record.Capability InterfaceCounterDrops

Record contains interface packet drops counter

InterfaceCounterInPackets

public static final Record.Capability InterfaceCounterInPackets

Record contains interface ingres packet counter

InterfaceCounterInOctects

public static final Record.Capability InterfaceCounterInOctects

Record contains interface ingres octets counters. Bytes received.

InterfaceCounterOutPackets

public static final Record.Capability InterfaceCounterOutPackets

Record contains interface egress packet counter

InterfaceCounterOutOctects

public static final Record.Capability InterfaceCounterOutOctects

Record contains interface egress octet counter. Bytes sent.

FilePassword

public static final Record.Capability FilePassword

Record contains a password to protect the file

FileCompression

public static final Record.Capability FileCompression

Record contains a compression algorithm information to compress the files content

FileEncryption

public static final Record.Capability FileEncryption

Record contains information about file encryption algorithm.

UserProperties

public static final Record.Capability UserProperties

Record contains user properties in AV pair format "property = value"

FileVersion

public static final Record.Capability FileVersion

Record contains version information about the file or block within the file.

FileMagicNumber

public static final Record.Capability FileMagicNumber

Record contains a MAGIC number specific for this file type.

AnalyzerStatistics

public static final Record.Capability AnalyzerStatistics

Record contains analyzer produced statistics

InPlaceMutableBlock

public static final Record.Capability InPlaceMutableBlock

Block contents can be mutated in place without file copies (size and content can change)

FilePaceholder

public static final Record.Capability FilePaceholder

Method Detail

values

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

Returns:

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

valueOf

public static Record.Capability 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