Package com.atlassian.adf.model.node

Class OrderedList

    • Method Detail

      • ol

        public static OrderedList ol()
        Returns:
        a new, empty ordered list. At least one list item must be added before it will be valid.

      • ol

        public static OrderedList ol​(ListItem... content)
        Returns:
        a new ordered list with the given contents

      • ol

        public static OrderedList ol​(Stream<? extends ListItem> content)
        Returns:
        a new ordered list with the given contents

      • ol

        public static OrderedList ol​(int order)
        Returns:
        a new, empty ordered list with the specified initial order. At least one list item must be added before it will be valid.

      • ol

        public static OrderedList ol​(int order,
                             ListItem... content)
        Returns:
        a new ordered list with the specified initial order and contents.

      • ol

        public static OrderedList ol​(int order,
                             Iterable<? extends ListItem> content)
        Returns:
        a new ordered list with the specified initial order and contents.

      • ol

        public static OrderedList ol​(int order,
                             Stream<? extends ListItem> content)
        Returns:
        a new ordered list with the specified initial order and contents.

      • order

        public Optional<Integer> order()
        Returns the ordinal of the initial value in the list, if set.
        Returns:
        the ordinal of the initial value in the list, or empty() if not set.

      • order

        public OrderedList order​(@Nullable
                         Integer order)
        Changes the starting value for the list, which otherwise defaults to starting at 1.
        Parameters:
        order - the positive integer to use as the starting point when numbering the list items
        Returns:
        this

      • copy

        public OrderedList 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.
        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".

      • 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.
        Returns:
        the map representation of this ADF element

      • appendPlainText

        public void appendPlainText​(StringBuilder sb)
        Description copied from interface: Node
        Renders this node as plain-text suitable for viewing by end users. This is equivalent to calling Node.toPlainText() and appending the result to the given buffer, except that it may be slightly more efficient, since it will write directly to the existing buffer instead of using a temporary buffer and having to make a copy of the result.
        Specified by:
        appendPlainText in interface Node
        Overrides:
        appendPlainText in class AbstractContentNode<OrderedList,​ListItem>
        Parameters:
        sb - where to write the result