public class

ExcerptHelper

extends Object
java.lang.Object
   ↳ com.atlassian.confluence.util.ExcerptHelper

Class Overview

Defines common functions that obtain excerpts of content (e.g. 'page children' and 'content by label' macros).

Summary

Public Constructors
ExcerptHelper()
Public Methods
String getExcerpt(ContentEntityObject contentEntityObject)
Returns the body of an excerpt macro (including any xhtml tags).
String getExcerptSummary(ContentEntityObject contentEntityObject)
Returns the first line of an excerpt macro as plain text (all xhtml tags will be stripped)
MacroDefinition getMacroDefinition(ContentEntityObject contentEntityObject, String macroName)
Gets the first MacroDefinition in the supplied (@code contentEntityObject}.
String getText(String content)
Returns the text from a fragment of XHTML content.
String getTextSummary(String content, int minLength, int maxLength)
Returns the text from the tag in the content (such as a heading or paragraph), unless its to short in which case text from the following tags are also included.
void setContentTransformerFactory(ContentTransformerFactory contentTransformerFactory)
[Expand]
Inherited Methods
From class java.lang.Object

Public Constructors

public ExcerptHelper ()

Public Methods

public String getExcerpt (ContentEntityObject contentEntityObject)

Returns the body of an excerpt macro (including any xhtml tags).

Parameters
contentEntityObject that contains the excerpt macro.
Returns
  • the body of an excerpt macro or "" if there was no excerpt macro.

public String getExcerptSummary (ContentEntityObject contentEntityObject)

Returns the first line of an excerpt macro as plain text (all xhtml tags will be stripped)

Parameters
contentEntityObject that contains the excerpt macro.
Returns
  • the summary of an excerpt macro or "" if there was no excerpt macro.

public MacroDefinition getMacroDefinition (ContentEntityObject contentEntityObject, String macroName)

Gets the first MacroDefinition in the supplied (@code contentEntityObject}.

Parameters
contentEntityObject (normally a Page) in which to find the macro.
macroName the name of the macro to find.
Returns
  • the MacroDefinition or null if not found, or the content is not XHTML.

public String getText (String content)

Returns the text from a fragment of XHTML content.

Parameters
content the XHTML content.
Returns
  • a value that contains only text.

public String getTextSummary (String content, int minLength, int maxLength)

Returns the text from the tag in the content (such as a heading or paragraph), unless its to short in which case text from the following tags are also included.

Parameters
content the XHTML content.
minLength the minimum length (normally 1) character (if available).
maxLength the maximum length (normally 100) characters.
Returns
  • a value that contains only text.

public void setContentTransformerFactory (ContentTransformerFactory contentTransformerFactory)