Interface Marker

public interface Marker
Marker Interface - Log Event Marker 标记接口 - 日志事件标记

Markers are named objects used to enrich log statements. A marker can reference other markers, creating a hierarchy of markers.

标记是用于丰富日志语句的命名对象。标记可以引用其他标记，创建标记层次结构。

Example | 示例:

// Create and use a marker
Marker security = Markers.getMarker("SECURITY");
OpenLog.info(security, "User {} authenticated", userId);

// Create a marker with references
Marker audit = Markers.getMarker("AUDIT", security);

Features | 主要功能:

  • Named marker for log event categorization - 用于日志事件分类的命名标记
  • Hierarchical marker references - 分层标记引用
  • Contains check by marker or name - 按标记或名称检查包含关系

Security | 安全性:

  • Thread-safe: Implementation-dependent - 线程安全: 取决于实现
  • Null-safe: No (throws on null reference) - 空值安全: 否（null 引用抛异常）
Since:
JDK 25, opencode-base-log V1.0.0
Author:
Leon Soo www.LeonSoo.com
See Also:

  • Method Summary

    Modifier and Type
    Method
    Description
    void
    add(Marker reference)
    Adds a reference to another marker.
    boolean
    contains(Marker other)
    Checks if this marker contains the specified marker.
    boolean
    contains(String name)
    Checks if this marker contains a marker with the specified name.
    boolean
    equals(Object other)
    Checks if this marker is equal to the specified marker.
    String
    getName()
    Returns the name of this marker.
    int
    hashCode()
    Returns the hash code of this marker.
    boolean
    hasReferences()
    Checks if this marker has any references.
    Iterator<Marker>
    iterator()
    Returns an iterator over the referenced markers.
    boolean
    remove(Marker reference)
    Removes a reference to another marker.

  • Method Details

    • getName

      String getName()
      Returns the name of this marker. 返回此标记的名称。
      Returns:
      the marker name - 标记名称

    • add

      void add(Marker reference)
      Adds a reference to another marker. 添加对另一个标记的引用。
      Parameters:
      reference - the marker to reference - 要引用的标记

    • remove

      boolean remove(Marker reference)
      Removes a reference to another marker. 移除对另一个标记的引用。
      Parameters:
      reference - the marker reference to remove - 要移除的标记引用
      Returns:
      true if the reference was removed - 如果移除成功返回 true

    • hasReferences

      boolean hasReferences()
      Checks if this marker has any references. 检查此标记是否有任何引用。
      Returns:
      true if this marker has references - 如果有引用返回 true

    • iterator

      Iterator<Marker> iterator()
      Returns an iterator over the referenced markers. 返回引用标记的迭代器。
      Returns:
      iterator of referenced markers - 引用标记的迭代器

    • contains

      boolean contains(Marker other)
      Checks if this marker contains the specified marker. 检查此标记是否包含指定的标记。
      Parameters:
      other - the marker to check - 要检查的标记
      Returns:
      true if this marker contains the other marker - 如果包含返回 true

    • contains

      boolean contains(String name)
      Checks if this marker contains a marker with the specified name. 检查此标记是否包含具有指定名称的标记。
      Parameters:
      name - the marker name to check - 要检查的标记名称
      Returns:
      true if this marker contains a marker with the name - 如果包含返回 true

    • equals

      boolean equals(Object other)
      Checks if this marker is equal to the specified marker. 检查此标记是否等于指定的标记。

      Two markers are equal if they have the same name.

      如果两个标记具有相同的名称，则它们相等。

      Overrides:
      equals in class Object
      Parameters:
      other - the object to compare - 要比较的对象
      Returns:
      true if equal - 如果相等返回 true

    • hashCode

      int hashCode()
      Returns the hash code of this marker. 返回此标记的哈希码。
      Overrides:
      hashCode in class Object
      Returns:
      the hash code - 哈希码