org.symphonyoss.symphony.messageml.elements

Class MessageML

java.lang.Object

org.symphonyoss.symphony.messageml.elements.Element

org.symphonyoss.symphony.messageml.elements.MessageML

public class MessageML
extends Element

Class representing a MessageML document (i.e. a message). A MessageML document tree is constructed through one of parse() methods in MessageMLContext.

Since:

3/27/17

Author:

lukasz

Field Summary

Fields

Modifier and Type	Field and Description
static String	MESSAGEML_TAG
static String	MESSAGEML_VERSION
static String	PRESENTATIONML_TAG

Fields inherited from class org.symphonyoss.symphony.messageml.elements.Element

CLASS_ATTR, format

Constructor Summary

Constructors

Constructor and Description
MessageML(FormatEnum format, String version)

Method Summary

Modifier and Type	Method and Description
com.fasterxml.jackson.databind.node.ObjectNode	asEntityJson(com.fasterxml.jackson.databind.node.ObjectNode parent) Return the EntityJSON representation of the node.
org.commonmark.node.Document	asMarkdown() Return Markdown representation of the element as Node.
void	asPresentationML(XmlPrintStream out) Print a PresentationML representation of the element and its children to the provided PrintStream.
protected void	buildAttribute(Node item) Parse a DOM attribute into MessageML element properties.
boolean	isChime() Return whether this message is a chime.
void	setChime(boolean chime) Return whether this message is a chime.
void	validate() Check the syntax and contents of the element.

Methods inherited from class org.symphonyoss.symphony.messageml.elements.Element

addChild, asText, buildAll, findElements, findElements, findElements, getAttribute, getAttributes, getChild, getChildren, getFormat, getMessageMLTag, getParent, size

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

MESSAGEML_VERSION

public static final String MESSAGEML_VERSION

See Also:

Constant Field Values

MESSAGEML_TAG

public static final String MESSAGEML_TAG

See Also:

Constant Field Values

PRESENTATIONML_TAG

public static final String PRESENTATIONML_TAG

See Also:

Constant Field Values

Constructor Detail

MessageML

public MessageML(FormatEnum format,
                 String version)

Method Detail

buildAttribute

protected void buildAttribute(Node item)
                       throws InvalidInputException

Description copied from class: Element

Parse a DOM attribute into MessageML element properties.

Throws:

InvalidInputException

asMarkdown

public org.commonmark.node.Document asMarkdown()
                                        throws InvalidInputException

Description copied from class: Element

Return Markdown representation of the element as Node.

Throws:

InvalidInputException

asPresentationML

public void asPresentationML(XmlPrintStream out)

Description copied from class: Element

Print a PresentationML representation of the element and its children to the provided PrintStream.

asEntityJson

public com.fasterxml.jackson.databind.node.ObjectNode asEntityJson(com.fasterxml.jackson.databind.node.ObjectNode parent)

Description copied from class: Element

Return the EntityJSON representation of the node.

validate

public void validate()
              throws InvalidInputException

Description copied from class: Element

Check the syntax and contents of the element.

Throws:

InvalidInputException

isChime

public boolean isChime()

Return whether this message is a chime.

setChime

public void setChime(boolean chime)

Return whether this message is a chime.