public class

ParagraphFragment

extends Object
implements Fragment
java.lang.Object
   ↳ com.atlassian.confluence.content.render.xhtml.storage.macro.inlinebody.ParagraphFragment

Class Overview

Represents a paragraph fragment.

You can add InlineMacroFragments to this fragment as well as merge other paragraph fragments into it under certain conditions (see canMerge(ParagraphFragment).

Summary

Public Constructors
ParagraphFragment(XMLEventFactory xmlEventFactory)
ParagraphFragment(XMLEventReader xmlEventReader)
Public Methods
void add(Fragment fragment)
Add a fragment to this paragraph fragment.
Set<Attribute> attributes()
List<XMLEvent> bodyEvents()
boolean canMerge(ParagraphFragment paragraphFragment)
True if the specified paragraph fragment can be merged into the current paragraph fragment.
List<XMLEvent> events()
[Expand]
Inherited Methods
From class java.lang.Object
From interface com.atlassian.confluence.content.render.xhtml.storage.macro.inlinebody.Fragment

Public Constructors

public ParagraphFragment (XMLEventFactory xmlEventFactory)

public ParagraphFragment (XMLEventReader xmlEventReader)

Throws
XMLStreamException

Public Methods

public void add (Fragment fragment)

Add a fragment to this paragraph fragment.

Parameters
fragment the fragment to add.

public Set<Attribute> attributes ()

Returns
  • a read-only set of attributes on this paragraph fragment

public List<XMLEvent> bodyEvents ()

Returns
  • a read-only list of xml events constituting the body of the paragraph fragment (i.e. excluding the start and end paragraph events)

public boolean canMerge (ParagraphFragment paragraphFragment)

True if the specified paragraph fragment can be merged into the current paragraph fragment. This will only be possible if: (a) the last fragment added to the paragraph is an inline macro fragment AND (b) the attributes of the specified paragraph and this paragraph are equal

Parameters
paragraphFragment the paragraph fragment to merge
Returns
  • True if the specified paragraph fragment can be merged, false otherwise.

public List<XMLEvent> events ()

Returns
  • a read-only list of xml events representing this paragraph fragment.