Package com.atlassian.adf.model.mark

Class Code

  • All Implemented Interfaces:
    Element, Mark, CodeTextMark, TextMark
    @Immutable
@Documentation(state=INCOMPLETE,
               date="2023-07-26",
               comment="should mention \'annotation\' marks")
public class Code
extends Object
implements CodeTextMark
    The code mark sets code styling.

    This mark applies to Text nodes and indicates that they should be displayed in a monospace font and may have other style elements, like a different background color, to help them stand out.

    The code mark can only be combined with other code marks; that is, it cannot be used with pure formatted-text marks like Em.

    Example

    Java

     p(
         text("Hello "),
         text("world").code(),
         text("!")
 );

    ADF

    
   {
     "type": "paragraph",
     "content": [
       {
         "type": "text",
         "text": "Hello "
       },
       {
         "type": "text",
         "text": "world",
         "marks": [
           {
             "type": "code"
           }
         ]
       },
       {
         "type": "text",
         "text": "!"
       }
     ]
   }

    Result

    Hello world!

    See Also:
    Mark - code

    • Method Detail

      • copy

        public Code 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 Mark
        Specified by:
        copy in interface TextMark
        Returns:
        a copy of this element, or this if the element is immutable anyway

      • code

        public static Code code()
        Returns:
        a code mark

      • code

        public static Text code​(String text)
        Convenience method for constructing a text node with a code mark.
        Parameters:
        text - the text to mark
        Returns:
        the resulting marked text node

      • code

        public static Text code​(Text text)
        Convenience method for applying a code mark to an existing text node.
        Parameters:
        text - the text to mark
        Returns:
        the resulting marked text node
        Throws:
        AdfException - if it isn't possible to apply that mark to the existing text node

      • 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

      • mapWithType

        protected FieldMap mapWithType()

      • 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

      • 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