jnetpcap.capture.file
Enum SuppliedFileTypes

java.lang.Object
  java.lang.Enum<SuppliedFileTypes>
      jnetpcap.capture.file.SuppliedFileTypes

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<SuppliedFileTypes>, FileType

public enum SuppliedFileTypes
extends java.lang.Enum<SuppliedFileTypes>
implements FileType

Defines enum constants for all the currently supported capture file types by the jNetPCAP capture framework.

Author:

Mark Bednarczyk, Sly Technologies, Inc.

Enum Constant Summary

Nap
jNetPCAP defined Network cAPture file format with many advanced features not available in the other file formats.

Pcap
Libpcap file format for capture/trace files.

Snoop
Sun Microsystems capture file format (RFC 1761)

Method Summary

java.lang.String	getBootstrap() A helper method that is used to bootstrap the file format, preload certain classes and resources.
java.lang.String	getDescription() Returns a short description of the file format.
boolean	isIndexable() Flag which defines if the native file format is indexable, that is you can use packet indexes to index packets out of the capture file using random access IO.
static SuppliedFileTypes	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static SuppliedFileTypes[]	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

Nap

public static final SuppliedFileTypes Nap

jNetPCAP defined Network cAPture file format with many advanced features not available in the other file formats.

Pcap

public static final SuppliedFileTypes Pcap

Libpcap file format for capture/trace files.

Snoop

public static final SuppliedFileTypes Snoop

Sun Microsystems capture file format (RFC 1761)

Method Detail

values

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

Returns:

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

valueOf

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

getDescription

public java.lang.String getDescription()

Returns a short description of the file format.

Specified by:

getDescription in interface FileType

Returns:

Returns the description.

isIndexable

public boolean isIndexable()

Flag which defines if the native file format is indexable, that is you can use packet indexes to index packets out of the capture file using random access IO. Currently only the NAP file is indexable, the other formats are not and you must use the standard iterative access methods.

Specified by:

isIndexable in interface FileType

Returns:

true if file is easily indexible otherwise false.

getBootstrap

public final java.lang.String getBootstrap()

A helper method that is used to bootstrap the file format, preload certain classes and resources.

Specified by:

getBootstrap in interface FileType

Returns: