public static class

RenderContext.Builder

extends Object
java.lang.Object
   ↳ com.atlassian.bitbucket.markup.RenderContext.Builder

Summary

Public Constructors
Builder()
Builder(RenderContext context)
Public Methods
@Nonnull RenderContext build()
@Nonnull RenderContext.Builder clearData()
Clears any provided data.
@Nonnull RenderContext.Builder data(Map<String, Object> value)
@Nonnull RenderContext.Builder hardwrap(Boolean value)
@Nonnull RenderContext.Builder hardwrap(boolean value)
@Nonnull RenderContext.Builder htmlEscape(Boolean value)
@Nonnull RenderContext.Builder htmlEscape(boolean value)
@Nonnull RenderContext.Builder includeHeadingId(Boolean value)
@Nonnull RenderContext.Builder includeHeadingId(boolean value)
@Nonnull RenderContext.Builder urlMode(UrlMode value)
[Expand]
Inherited Methods
From class java.lang.Object

Public Constructors

public Builder ()

public Builder (RenderContext context)

Public Methods

@Nonnull public RenderContext build ()

Returns
  • the built context

@Nonnull public RenderContext.Builder clearData ()

Clears any provided data.

Returns
  • this

@Nonnull public RenderContext.Builder data (Map<String, Object> value)

Parameters
value a map containing additional data to make available when rendering, which is appended to any existing data
Returns
  • this

@Nonnull public RenderContext.Builder hardwrap (Boolean value)

Parameters
value TRUE to convert newlines to breaks; FALSE to leave them intact; or null to use the system-configured default
Returns
  • this

@Nonnull public RenderContext.Builder hardwrap (boolean value)

Parameters
value true to convert newlines to breaks; otherwise, false to leave them intact
Returns
  • this

@Nonnull public RenderContext.Builder htmlEscape (Boolean value)

Parameters
value TRUE if HTML should be escaped in the input markup; FALSE to retain HTML; or null to use the system-configured default
Returns
  • this

@Nonnull public RenderContext.Builder htmlEscape (boolean value)

Parameters
value true if HTML should be escaped in the input markup; otherwise, false to retain HTML
Returns
  • this

@Nonnull public RenderContext.Builder includeHeadingId (Boolean value)

Parameters
value TRUE if an ID should be added for each rendered header rendered; FALSE to render headers without IDs; or null to use the system-configured default
Returns
  • this

@Nonnull public RenderContext.Builder includeHeadingId (boolean value)

Parameters
value true if an ID should be added for each rendered header rendered; otherwise, false to render headers without IDs
Returns
  • this

@Nonnull public RenderContext.Builder urlMode (UrlMode value)

Parameters
value the mode to use when rendering URLs
Returns
  • this