LogField (ACS-2016.6)

java.lang.Object
- java.lang.Enum<LogField>
- - com.cosylab.logging.engine.log.LogField

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<LogField>
```
public enum LogField
extends java.lang.Enum<LogField>
```
An enumerated describing each field of the log. This allows to have all the attributes describing the fields written together limiting the chance of typos, errors and so on. NOTE: before introducing this enum each filed had an integer, the entryType. This integer can be obtained with the ordinal() method of enum.

Author:

acaproni

Enum Constant Summary

Enum Constants
Enum Constant and Description
`ANTENNA`
`ARRAY`
`AUDIENCE`
`CONTEXT`
`ENTRYTYPE`
`FILE`
`HOST`
`LINE`
`LOGID`
`LOGMESSAGE`
`PRIORITY`
`PROCESS`
`ROUTINE`
`SOURCEOBJECT`
`STACKID`
`STACKLEVEL`
`THREAD`
`TIMESTAMP`
`URI`

Field Summary

Fields
Modifier and Type	Field and Description
`java.lang.Class`	`fieldClass` The class of the field
`char`	`id` An identifier of the field used by converter tools like the acsLogAssistant
`java.lang.String`	`name` The name of the field
`java.lang.String`	`tagAttribute` The name of the XML attribute containing this field It is null for non attribute fields (like the entry type or the log message)

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static LogField`	`fromID(char id)` Return a `LogField` from its id
`static LogField`	`fromName(java.lang.String fieldName)` Return a `LogField` from its name
`java.lang.String`	`getName()` Getter
`java.lang.String`	`getTagAttribute()` Getter
`java.lang.Class<?>`	`getType()` Getter
`static LogField`	`valueOf(java.lang.String name)` Returns the enum constant of this type with the specified name.
`static LogField[]`	`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
  - TIMESTAMP
```
public static final LogField TIMESTAMP
```
  - ENTRYTYPE
```
public static final LogField ENTRYTYPE
```
  - SOURCEOBJECT
```
public static final LogField SOURCEOBJECT
```
  - FILE
```
public static final LogField FILE
```
  - LINE
```
public static final LogField LINE
```
  - ROUTINE
```
public static final LogField ROUTINE
```
  - HOST
```
public static final LogField HOST
```
  - PROCESS
```
public static final LogField PROCESS
```
  - CONTEXT
```
public static final LogField CONTEXT
```
  - THREAD
```
public static final LogField THREAD
```
  - LOGID
```
public static final LogField LOGID
```
  - PRIORITY
```
public static final LogField PRIORITY
```
  - URI
```
public static final LogField URI
```
  - STACKID
```
public static final LogField STACKID
```
  - STACKLEVEL
```
public static final LogField STACKLEVEL
```
  - LOGMESSAGE
```
public static final LogField LOGMESSAGE
```
  - AUDIENCE
```
public static final LogField AUDIENCE
```
  - ARRAY
```
public static final LogField ARRAY
```
  - ANTENNA
```
public static final LogField ANTENNA
```
- Field Detail
  - name
```
public final java.lang.String name
```
    The name of the field
  - fieldClass
```
public final java.lang.Class fieldClass
```
    The class of the field
  - tagAttribute
```
public final java.lang.String tagAttribute
```
    The name of the XML attribute containing this field It is null for non attribute fields (like the entry type or the log message)
  - id
```
public final char id
```
    An identifier of the field used by converter tools like the acsLogAssistant
- Method Detail
  - values
```
public static LogField[] 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 (LogField c : LogField.values())
    System.out.println(c);
```
    Returns:
    
    an array containing the constants of this enum type, in the order they are declared
  - valueOf
```
public static LogField 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
  - getName
```
public java.lang.String getName()
```
    Getter
    
    Returns:
    
    The name of the field
  - getType
```
public java.lang.Class<?> getType()
```
    Getter
    
    Returns:
    
    The class of the field
  - getTagAttribute
```
public java.lang.String getTagAttribute()
```
    Getter
    
    Returns:
    
    The XML tag name of the field
  - fromName
```
public static LogField fromName(java.lang.String fieldName)
```
    Return a LogField from its name
    
    Returns:
    
    The field with the given name or null if a field with that name does not exist
  - fromID
```
public static LogField fromID(char id)
```
    Return a LogField from its id
    
    Returns:
    
    The field with the given id

Enum LogField

Enum Constant Summary

Field Summary

Method Summary

Methods inherited from class java.lang.Enum

Methods inherited from class java.lang.Object

Enum Constant Detail

TIMESTAMP

ENTRYTYPE

SOURCEOBJECT

FILE

LINE

ROUTINE

HOST

PROCESS

CONTEXT

THREAD

LOGID

PRIORITY

URI

STACKID

STACKLEVEL

LOGMESSAGE

AUDIENCE

ARRAY

ANTENNA

Field Detail

name

fieldClass

tagAttribute

id

Method Detail

values

valueOf

getName

getType

getTagAttribute

fromName

fromID