Package 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	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, ID_ATTR, ID_MAX_LENGTH, MAPPER, STYLE_ATTR

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
com.fasterxml.jackson.databind.node.ObjectNode	asEntityJson(com.fasterxml.jackson.databind.node.ObjectNode parent)
org.commonmark.node.Node	asMarkdown()
void	asPresentationML(XmlPrintStream out, MessageMLContext context)
String	asText()	Return a text representation of the element, descending into its children.
protected void	buildAttribute(MessageMLParser parser, Node item)
protected String	getEntityIdPrefix()
protected String	getEntitySubType()
protected String	getEntityType()
protected String	getEntityValue()
protected String	getEntityVersion()
IUserPresentation	getUserPresentation()
String	toString()
void	updateBiContext(BiContext context)
void	validate()

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, checkIntegerAttribute, countChildrenOfType, countNonTextNodesInNodeList, findElements, findElements, findElements, getAttribute, getAttributes, getChild, getChildren, getFormat, getMessageMLTag, getParent, getStringAttribute, hasExactNumberOfChildren, hasIdAttribute, putIntegerIfPresent, putOneIfPresent, putStringIfPresent, size, throwInvalidInputException

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(MessageMLParser parser,
                              Node item)
                       throws InvalidInputException

Overrides:

buildAttribute in class Entity

Throws:

InvalidInputException

asPresentationML

public void asPresentationML(XmlPrintStream out,
                             MessageMLContext context)

asMarkdown

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

Throws:

InvalidInputException

asEntityJson

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

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

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

updateBiContext

public void updateBiContext(BiContext context)