org.symphonyoss.symphony.messageml.elements

Class Mention

java.lang.Object

org.symphonyoss.symphony.messageml.elements.Element

org.symphonyoss.symphony.messageml.elements.Entity

org.symphonyoss.symphony.messageml.elements.Mention

public class Mention
extends Entity

Class representing a convenience element for a user mention. Translated to an anchor element.

Since:

3/27/17

Author:

lukasz

Field Summary

Fields

Modifier and Type	Field and Description
static String	ENTITY_TYPE
static String	MESSAGEML_TAG

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

ENTITY_ID_ATTR, ID_FIELD, PRESENTATIONML_CLASS, TYPE_FIELD, VALUE_FIELD

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

CLASS_ATTR, format, STYLE_ATTR

Constructor Summary

Constructors

Constructor and Description
Mention(Element parent, int entityIndex, IDataProvider dataProvider)
Mention(Element parent, int entityIndex, Long uid, IDataProvider dataProvider)
Mention(Element parent, String presentationMlTag, Long uid, IDataProvider dataProvider)

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.Node	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.
String	asText() Return a text representation of the element, descending into its children.
protected void	buildAttribute(Node item) Parse a DOM attribute into MessageML element properties.
protected String	getEntityIdPrefix()
protected String	getEntitySubType()
protected String	getEntityType()
protected String	getEntityValue()
protected String	getEntityVersion()
IUserPresentation	getUserPresentation()
String	toString()
void	validate() Check the syntax and contents of the element.

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

getPresentationMLTag

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

addChild, areNestedElementsAllowed, buildAll, buildNode, countNonTextNodesInNodeList, findElements, findElements, findElements, getAttribute, getAttributes, getChild, getChildren, getFormat, getMessageMLTag, getParent, hasExactNumberOfChildren, hasIdAttribute, size

Methods inherited from class java.lang.Object

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

Field Detail

MESSAGEML_TAG

public static final String MESSAGEML_TAG

See Also:

Constant Field Values

ENTITY_TYPE

public static final String ENTITY_TYPE

See Also:

Constant Field Values

Constructor Detail

Mention

public Mention(Element parent,
               int entityIndex,
               IDataProvider dataProvider)

Mention

public Mention(Element parent,
               int entityIndex,
               Long uid,
               IDataProvider dataProvider)

Mention

public Mention(Element parent,
               String presentationMlTag,
               Long uid,
               IDataProvider dataProvider)

Method Detail

buildAttribute

protected void buildAttribute(Node item)
                       throws InvalidInputException

Description copied from class: Element

Parse a DOM attribute into MessageML element properties.

Overrides:

buildAttribute in class Entity

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.

asMarkdown

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

Description copied from class: Element

Return Markdown representation of the element as Node.

Throws:

InvalidInputException

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.

Overrides:

asEntityJson in class Entity

asText

public String asText()

Description copied from class: Element

Return a text representation of the element, descending into its children.

Overrides:

asText in class Element

toString

public String toString()

Overrides:

toString in class Object

validate

public void validate()
              throws InvalidInputException

Description copied from class: Element

Check the syntax and contents of the element.

Overrides:

validate in class Entity

Throws:

InvalidInputException

getUserPresentation

public IUserPresentation getUserPresentation()

getEntityIdPrefix

protected String getEntityIdPrefix()

Specified by:

getEntityIdPrefix in class Entity

getEntityValue

protected String getEntityValue()

Specified by:

getEntityValue in class Entity

getEntitySubType

protected String getEntitySubType()

Specified by:

getEntitySubType in class Entity

getEntityVersion

protected String getEntityVersion()

Specified by:

getEntityVersion in class Entity

getEntityType

protected String getEntityType()

Specified by:

getEntityType in class Entity