NullMessage (cat-client 3.0.1 API)

java.lang.Object
- java.lang.Enum<NullMessage>
- - com.dianping.cat.message.internal.NullMessage

所有已实现的接口:: Event, ForkedTransaction, Heartbeat, Message, Metric, TaggedTransaction, Trace, Transaction, Serializable, Comparable<NullMessage>

public enum NullMessage
extends Enum<NullMessage>
implements Transaction, Event, Metric, Trace, Heartbeat, ForkedTransaction, TaggedTransaction

枚举常量概要

枚举常量
枚举常量和说明

EVENT

HEARTBEAT

METRIC

TRACE

TRANSACTION

枚举常量
枚举常量和说明
`EVENT`
`HEARTBEAT`
`METRIC`
`TRACE`
`TRANSACTION`

字段概要
- 从接口继承的字段 com.dianping.cat.message.Message
  SUCCESS

方法概要

所有方法静态方法实例方法具体方法
限定符和类型	方法和说明
`Transaction`	`addChild(Message message)` Add one nested child message to current transaction.
`void`	`addData(String keyValuePairs)` add one or multiple key-value pairs to the message.
`void`	`addData(String key, Object value)` add one key-value pair to the message.
`void`	`bind(String tag, String childMessageId, String title)`
`void`	`complete()` Complete the message construction.
`void`	`fork()`
`List<Message>`	`getChildren()` Get all children message within current transaction.
`Object`	`getData()`
`long`	`getDurationInMicros()` How long the transaction took from construction to complete.
`long`	`getDurationInMillis()` How long the transaction took from construction to complete.
`String`	`getForkedMessageId()`
`String`	`getName()` Message name.
`String`	`getParentMessageId()`
`String`	`getRootMessageId()`
`String`	`getStatus()` Get the message status.
`String`	`getTag()`
`long`	`getTimestamp()` The time stamp the message was created.
`String`	`getType()` Message type.
`boolean`	`hasChildren()` Has children or not.
`boolean`	`isCompleted()` If the complete() method was called or not.
`boolean`	`isStandalone()` Check if the transaction is stand-alone or belongs to another one.
`boolean`	`isSuccess()`
`void`	`setDurationInMillis(long durationInMills)` set duration in millisecond.
`void`	`setStatus(String status)` Set the message status.
`void`	`setStatus(Throwable e)` Set the message status with exception class name.
`void`	`setSuccessStatus()`
`void`	`setTimestamp(long timestamp)`
`void`	`start()`
`static NullMessage`	`valueOf(String name)` 返回带有指定名称的该类型的枚举常量。
`static NullMessage[]`	`values()` 按照声明该枚举类型的常量的顺序, 返回包含这些常量的数组。

从类继承的方法 java.lang.Enum
clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

从类继承的方法 java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- 枚举常量详细资料
  - TRANSACTION
```
public static final NullMessage TRANSACTION
```
  - EVENT
```
public static final NullMessage EVENT
```
  - METRIC
```
public static final NullMessage METRIC
```
  - TRACE
```
public static final NullMessage TRACE
```
  - HEARTBEAT
```
public static final NullMessage HEARTBEAT
```
- 方法详细资料
  - values
```
public static NullMessage[] values()
```
    按照声明该枚举类型的常量的顺序, 返回包含这些常量的数组。该方法可用于迭代常量, 如下所示:
```
for (NullMessage c : NullMessage.values())
    System.out.println(c);
```
    返回:
    
    按照声明该枚举类型的常量的顺序返回的包含这些常量的数组
  - valueOf
```
public static NullMessage valueOf(String name)
```
    返回带有指定名称的该类型的枚举常量。字符串必须与用于声明该类型的枚举常量的标识符完全匹配。(不允许有多余的空格字符。)
    
    参数:
    
    name - 要返回的枚举常量的名称。
    
    返回:
    
    返回带有指定名称的枚举常量
    
    抛出:
    
    IllegalArgumentException - 如果该枚举类型没有带有指定名称的常量
    
    NullPointerException - 如果参数为空值
  - addChild
```
public Transaction addChild(Message message)
```
    从接口复制的说明: Transaction
    
    Add one nested child message to current transaction.
    
    指定者:
    
    addChild 在接口中 Transaction
    
    参数:
    
    message - to be added
  - addData
```
public void addData(String keyValuePairs)
```
    从接口复制的说明: Message
    
    add one or multiple key-value pairs to the message.
    
    指定者:
    
    addData 在接口中 Message
    
    参数:
    
    keyValuePairs - key-value pairs like 'a=1&b=2&...'
  - addData
```
public void addData(String key,
                    Object value)
```
    从接口复制的说明: Message
    
    add one key-value pair to the message.
    
    指定者:
    
    addData 在接口中 Message
  - bind
```
public void bind(String tag,
                 String childMessageId,
                 String title)
```
    指定者:
    
    bind 在接口中 TaggedTransaction
  - complete
```
public void complete()
```
    从接口复制的说明: Message
    
    Complete the message construction.
    
    指定者:
    
    complete 在接口中 Message
  - fork
```
public void fork()
```
    指定者:
    
    fork 在接口中 ForkedTransaction
  - getChildren
```
public List<Message> getChildren()
```
    从接口复制的说明: Transaction
    
    Get all children message within current transaction.
    
    Typically, a Transaction can nest other Transactions, Events and Heartbeat s, while an Event or Heartbeat can't nest other messages.
    
    指定者:
    
    getChildren 在接口中 Transaction
    
    返回:
    
    all children messages, empty if there is no nested children.
  - getData
```
public Object getData()
```
    指定者:
    
    getData 在接口中 Message
    
    返回:
    
    key value pairs data
  - getDurationInMicros
```
public long getDurationInMicros()
```
    从接口复制的说明: Transaction
    
    How long the transaction took from construction to complete. Time unit is microsecond.
    
    指定者:
    
    getDurationInMicros 在接口中 Transaction
    
    返回:
    
    duration time in microsecond
  - getDurationInMillis
```
public long getDurationInMillis()
```
    从接口复制的说明: Transaction
    
    How long the transaction took from construction to complete. Time unit is millisecond.
    
    指定者:
    
    getDurationInMillis 在接口中 Transaction
    
    返回:
    
    duration time in millisecond
  - setDurationInMillis
```
public void setDurationInMillis(long durationInMills)
```
    从接口复制的说明: Transaction
    
    set duration in millisecond.
    
    指定者:
    
    setDurationInMillis 在接口中 Transaction
  - getForkedMessageId
```
public String getForkedMessageId()
```
    指定者:
    
    getForkedMessageId 在接口中 ForkedTransaction
  - getName
```
public String getName()
```
    从接口复制的说明: Message
    
    Message name.
    
    指定者:
    
    getName 在接口中 Message
    
    返回:
    
    message name
  - getParentMessageId
```
public String getParentMessageId()
```
    指定者:
    
    getParentMessageId 在接口中 TaggedTransaction
  - getRootMessageId
```
public String getRootMessageId()
```
    指定者:
    
    getRootMessageId 在接口中 TaggedTransaction
  - getStatus
```
public String getStatus()
```
    从接口复制的说明: Message
    
    Get the message status.
    
    指定者:
    
    getStatus 在接口中 Message
    
    返回:
    
    message status. "0" means success, otherwise error code.
  - setStatus
```
public void setStatus(Throwable e)
```
    从接口复制的说明: Message
    
    Set the message status with exception class name.
    
    指定者:
    
    setStatus 在接口中 Message
    
    参数:
    
    e - exception.
  - getTag
```
public String getTag()
```
    指定者:
    
    getTag 在接口中 TaggedTransaction
  - getTimestamp
```
public long getTimestamp()
```
    从接口复制的说明: Message
    
    The time stamp the message was created.
    
    指定者:
    
    getTimestamp 在接口中 Message
    
    返回:
    
    message creation time stamp in milliseconds
  - setTimestamp
```
public void setTimestamp(long timestamp)
```
    指定者:
    
    setTimestamp 在接口中 Message
  - getType
```
public String getType()
```
    从接口复制的说明: Message
    Message type.
    
    Typical message types are:
    - URL: maps to one method of an action
    - Service: maps to one method of service call
    - Search: maps to one method of search call
    - SQL: maps to one SQL statement
    - Cache: maps to one cache access
    - Error: maps to java.lang.Throwable (java.lang.Exception and java.lang.Error)
    指定者:
    
    getType 在接口中 Message
    
    返回:
    
    message type
  - hasChildren
```
public boolean hasChildren()
```
    从接口复制的说明: Transaction
    
    Has children or not. An atomic transaction does not have any children message.
    
    指定者:
    
    hasChildren 在接口中 Transaction
    
    返回:
    
    true if child exists, else false.
  - isCompleted
```
public boolean isCompleted()
```
    从接口复制的说明: Message
    
    If the complete() method was called or not.
    
    指定者:
    
    isCompleted 在接口中 Message
    
    返回:
    
    true means the complete() method was called, false otherwise.
  - isStandalone
```
public boolean isStandalone()
```
    从接口复制的说明: Transaction
    
    Check if the transaction is stand-alone or belongs to another one.
    
    指定者:
    
    isStandalone 在接口中 Transaction
    
    返回:
    
    true if it's an root transaction.
  - isSuccess
```
public boolean isSuccess()
```
    指定者:
    
    isSuccess 在接口中 Message
    
    返回:
  - setStatus
```
public void setStatus(String status)
```
    从接口复制的说明: Message
    
    Set the message status.
    
    指定者:
    
    setStatus 在接口中 Message
    
    参数:
    
    status - message status. "0" means success, otherwise error code.
  - start
```
public void start()
```
    指定者:
    
    start 在接口中 TaggedTransaction
  - setSuccessStatus
```
public void setSuccessStatus()
```
    指定者:
    
    setSuccessStatus 在接口中 Message

枚举 NullMessage

枚举常量概要

字段概要

从接口继承的字段 com.dianping.cat.message.Message

方法概要

从类继承的方法 java.lang.Enum

从类继承的方法 java.lang.Object

枚举常量详细资料

TRANSACTION

EVENT

METRIC

TRACE

HEARTBEAT

方法详细资料

values

valueOf

addChild

addData

addData

bind

complete

fork

getChildren

getData

getDurationInMicros

getDurationInMillis

setDurationInMillis

getForkedMessageId

getName

getParentMessageId

getRootMessageId

getStatus

setStatus

getTag

getTimestamp

setTimestamp

getType

hasChildren

isCompleted

isStandalone

isSuccess

setStatus

start

setSuccessStatus