註解類型 ToString

@Target(TYPE) @Retention(SOURCE) public @interface ToString
為所有物件繼承的 toString 方法產生實作，包含印出相關欄位的值。

完整文件請見 @ToString 的 project lombok 功能頁面。

  • 巢狀類別摘要

    巢狀類別
    修飾詞與類型
    類別
    描述
    static @interface 
    ToString.Exclude
    如果存在，則不要在產生的 toString 中包含此欄位。
    static @interface 
    ToString.Include
    設定此成員在 toString 中呈現方式的行為；如果在方法上，則在輸出中包含方法的傳回值。

  • 可選元素摘要

    可選元素
    修飾詞與類型
    可選元素
    描述
    boolean
    callSuper
    在輸出中包含父類別 toString 實作的結果。
    boolean
    doNotUseGetters
    通常，如果 getter 可用，則會呼叫這些 getter。
    String[]
    exclude
    此處列出的任何欄位都不會印在產生的 toString 實作中。
    boolean
    includeFieldNames
    印出時包含每個欄位的名稱。
    String[]
    of
    如果存在，則明確列出要印出的欄位。
    boolean
    onlyExplicitlyIncluded
    僅包含明確標記為 @ToString.Include 的欄位和方法。

  • 元素詳細資訊

    • includeFieldNames

      boolean includeFieldNames
      印出時包含每個欄位的名稱。 預設值：true
      返回
      是否在產生的 toString() 字串中包含欄位名稱。
      預設值
      true

    • exclude

      String[] exclude
      此處列出的任何欄位都不會印在產生的 toString 實作中。與 of() 互斥。

      即將標記為 @Deprecated；請改用 @ToString.Exclude 註解。

      返回
      要排除的欄位列表。
      預設值
      {}

    • of

      String[] of
      如果存在，則明確列出要印出的欄位。通常，會印出所有非靜態欄位。

      與 exclude() 互斥。

      即將標記為 @Deprecated；請搭配 @ToString(onlyExplicitlyIncluded = true) 使用 @ToString.Include 註解。

      返回
      要使用的欄位列表 (預設：全部)。
      預設值
      {}

    • callSuper

      boolean callSuper
      在輸出中包含父類別 toString 實作的結果。預設值：false
      返回
      是否在產生的 toString 演算法中呼叫父類別的 toString 實作。
      預設值
      false

    • doNotUseGetters

      boolean doNotUseGetters
      通常，如果 getter 可用，則會呼叫這些 getter。若要禁止此行為並讓產生的程式碼直接使用欄位，請將此項設定為 true。預設值：false
      返回
      如果為 true，則始終使用直接欄位存取，而不是呼叫 getter 方法。
      預設值
      false

    • onlyExplicitlyIncluded

      boolean onlyExplicitlyIncluded
      僅包含明確標記為 @ToString.Include 的欄位和方法。通常，預設會包含所有 (非靜態) 欄位。
      返回
      如果為 true，則不要自動包含非靜態欄位 (預設值：false)。
      預設值
      false