Alert

java.lang.Object

org.commonmark.node.Node

org.commonmark.node.Block

org.commonmark.node.CustomBlock

org.commonmark.ext.gfm.alerts.Alert

public class Alert extends CustomBlock

Alert block for highlighting important information using [!TYPE] syntax.

See Also:

AlertTitle

Field Summary

Fields

Modifier and Type

Field

Description

private final String

type
Constructor Summary

Constructors

Constructor

Description

Alert(String type)
Method Summary

Modifier and Type

Method

Description

String

getType()

boolean

hasBody()

Methods inherited from class org.commonmark.node.CustomBlock
accept

Methods inherited from class org.commonmark.node.Block
getParent, setParent

Methods inherited from class org.commonmark.node.Node
addSourceSpan, appendChild, getFirstChild, getLastChild, getNext, getPrevious, getSourceSpans, insertAfter, insertBefore, prependChild, setSourceSpans, toString, toStringAttributes, unlink

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Details
- type
  
  private final String type
Constructor Details
- Alert
  
  public Alert(String type)
Method Details
- getType
  
  public String getType()
- hasBody
  
  public boolean hasBody()
  Returns:
  
  Whether this alert has any body content (not including the title).
  - Examples where this would be true:
  > [!NOTE] > Body text
  
  > [!NOTE] Custom title > Body text
  - Examples where this would be false:
  > [!NOTE]
  
  > [!NOTE] > >
  
  > [!NOTE] Custom title