Package com.atlassian.adf.model.mark

Class Annotation

  • All Implemented Interfaces:
    Element, Mark, CodeTextMark, FormattedTextMark, TextMark
    @Immutable
@Documentation(state=UNDOCUMENTED,
               date="2023-07-26")
public class Annotation
extends Object
implements CodeTextMark, FormattedTextMark
    The annotation mark shows the presence of an annotation or comment on a node. This mark applies to text nodes.

    Annotation marks are used in Confluence to provide links to inline comments. It does not seem to be used by any other products at this time.

    Example

    Java

         p(
         text("hello "),
         text("there")
                 .mark(inlineComment("123456"))
     );

    ADF

    
  {
    "type": "paragraph",
    "content": [
      {
        "type": "text",
        "text": "hello "
      },
      {
        "type": "text",
        "text": "there",
        "marks": [
          {
            "type": "annotation",
            "attrs": {
              "id": "123456",
              "annotationType": "inlineComment"
            }
          }
        ]
      }
    ]
  }

    Result

    hello there
    Note: This example output is not using AtlasKit to render the link, so while it gives a vague impression of what an annotation is, it does not faithfully reproduce the actual presentation in Atlassian products.

    • Method Detail

      • copy

        public Annotation copy()
        Description copied from interface: Element
        Returns a deep copy of this element, including copies of any nodes or marks that it contains. The copy will not necessarily be in exactly the same state as the original in some cases. For example, a text node that is used inside a codeBlock will have the ability to use marks on it disabled, but a copy made of the text node using this method will not similarly disallow marks unless it is also added to a content node with those same restrictions.

        Implementations notes:

        • Implementations should narrow the return type.
        • Implementations should return this if the element is immutable. The @Immutable annotation should be used on the class to offer additional confirmation of this intent.
        • Implementations should return parse(toMap()) if they have state.
        • While there may be cases where it is worthwhile to do something more efficient than the conversion to a map and back, this is discouraged because it would add yet another fragile piece of code that breaks when new data is added to the node. The parse and toMap methods already have to be updated in these circumstances, so it makes sense to take advantage of that.
        Specified by:
        copy in interface CodeTextMark
        Specified by:
        copy in interface Element
        Specified by:
        copy in interface FormattedTextMark
        Specified by:
        copy in interface Mark
        Specified by:
        copy in interface TextMark
        Returns:
        a copy of this element, or this if the element is immutable anyway

      • elementType

        public String elementType()
        Description copied from interface: Element
        The type value that identifies this element, such as "paragraph" or "strong".
        Specified by:
        elementType in interface Element

      • toMap

        public Map<String,​?> toMap()
        Description copied from interface: Element
        Transforms this element to a map of String values to various basic object types suitable for direct rendering as JSON content.
        Specified by:
        toMap in interface Element
        Returns:
        the map representation of this ADF element

      • toString

        public String toString()

      • equals

        public boolean equals​(@Nullable
                      Object o)
        Overrides:
        equals in class Object

      • hashCode

        public int hashCode()
        Overrides:
        hashCode in class Object

      • mapWithType

        protected FieldMap mapWithType()

      • isSupported

        public boolean isSupported()
        Description copied from interface: Element
        Indicates whether this element is fully supported by this library. This library includes a small amount of support for preserving new, unrecognized node types during a round trip. These are represented by immutable placeholder objects that return false for this value.
        Specified by:
        isSupported in interface Element
        Returns:
        true for fully supported elements; false for immutable placeholders

      • validate

        public void validate()
        Description copied from interface: Element
        Verifies that the node is well-formed (including the state of any descendents that it has).
        Specified by:
        validate in interface Element