jnetpcap.capture.file.nap
Enum NAPFlag

java.lang.Object
  extended by java.lang.Enum<NAPFlag>
      extended by jnetpcap.capture.file.nap.NAPFlag
All Implemented Interfaces:
java.io.Serializable, java.lang.Comparable<NAPFlag>

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

Flags that are set within the packet header. The flags are used to mark the packet data to contain certain specific aspects or user defined significance.

Author:
Mark Bednarczyk, Sly Technologies, Inc. {@see

Enum Constant Summary
FrameCRC
          Packet data contains CRC
FramePreamble
          Packet data contains frame pre-amble octets
Imported
          Packet was imported from another file or format
MarkedForDeletion
          Packet is marked for deletion by the user
ProtocolError
          Packet data is marked to contain Protocol error when packet content is decoded.
StructuralError
          Packet data is marked to contain structural errors, that is invalid CRC, corrupt headers or other such errors.
UserCustom
          A custom flag that is user defined and has no other special meaning.
UserHidden
          User has marked the packet to be hidden, that it should not be reported to the user, although the packet is still contained within the file.
UserMark
          The user has marked the packet.
UserNoDecode
          Decoding of this packet should be skipped.
 
Method Summary
 int getFlag()
           
static NAPFlag valueOf(java.lang.String name)
          Returns the enum constant of this type with the specified name.
static NAPFlag[] 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

Imported

public static final NAPFlag Imported
Packet was imported from another file or format


MarkedForDeletion

public static final NAPFlag MarkedForDeletion
Packet is marked for deletion by the user


FramePreamble

public static final NAPFlag FramePreamble
Packet data contains frame pre-amble octets


FrameCRC

public static final NAPFlag FrameCRC
Packet data contains CRC


ProtocolError

public static final NAPFlag ProtocolError
Packet data is marked to contain Protocol error when packet content is decoded.


StructuralError

public static final NAPFlag StructuralError
Packet data is marked to contain structural errors, that is invalid CRC, corrupt headers or other such errors.


UserMark

public static final NAPFlag UserMark
The user has marked the packet. This information may be used to report on only packets marked by the user.


UserHidden

public static final NAPFlag UserHidden
User has marked the packet to be hidden, that it should not be reported to the user, although the packet is still contained within the file.


UserNoDecode

public static final NAPFlag UserNoDecode
Decoding of this packet should be skipped.


UserCustom

public static final NAPFlag UserCustom
A custom flag that is user defined and has no other special meaning.

Method Detail

values

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

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

valueOf

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

getFlag

public int getFlag()
Returns:
Returns the flag.