Entity (MessageML Utils 0.9.67 API)

java.lang.Object
- org.symphonyoss.symphony.messageml.elements.Element
- - org.symphonyoss.symphony.messageml.elements.Entity

Direct Known Subclasses:

CashTag, Emoji, HashTag, Mention
```
public abstract class Entity
extends Element
```
Since:

4/19/17

Author:

lukasz

Field Summary

Fields
Modifier and Type	Field	Description
`static String`	`ENTITY_ID_ATTR`
`static String`	`ID_FIELD`
`static String`	`PRESENTATIONML_CLASS`
`static String`	`TYPE_FIELD`
`static String`	`VALUE_FIELD`

Fields inherited from class org.symphonyoss.symphony.messageml.elements.Element
CLASS_ATTR, format, ID_ATTR, STYLE_ATTR

Method Summary

All Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method	Description
`com.fasterxml.jackson.databind.node.ObjectNode`	`asEntityJson(com.fasterxml.jackson.databind.node.ObjectNode parent)`
`protected void`	`buildAttribute(MessageMLParser parser, Node item)`
`protected abstract String`	`getEntityIdPrefix()`
`protected abstract String`	`getEntitySubType()`
`protected abstract String`	`getEntityType()`
`protected abstract String`	`getEntityValue()`
`protected abstract String`	`getEntityVersion()`
`String`	`getPresentationMLTag()`	Return the element's PresentationML tag.
`void`	`validate()`

Methods inherited from class org.symphonyoss.symphony.messageml.elements.Element
addChild, areNestedElementsAllowed, asText, buildAll, buildNode, countNonTextNodesInNodeList, findElements, findElements, findElements, getAttribute, getAttributes, getChild, getChildren, getFormat, getMessageMLTag, getParent, getStringAttribute, hasExactNumberOfChildren, hasIdAttribute, size, throwInvalidInputException

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

Field Detail
- PRESENTATIONML_CLASS
```
public static final String PRESENTATIONML_CLASS
```
  See Also:
  
  Constant Field Values
- ENTITY_ID_ATTR
```
public static final String ENTITY_ID_ATTR
```
  See Also:
  
  Constant Field Values
- TYPE_FIELD
```
public static final String TYPE_FIELD
```
  See Also:
  
  Constant Field Values
- VALUE_FIELD
```
public static final String VALUE_FIELD
```
  See Also:
  
  Constant Field Values
- ID_FIELD
```
public static final String ID_FIELD
```
  See Also:
  
  Constant Field Values

Method Detail

buildAttribute

protected void buildAttribute(MessageMLParser parser,
                              Node item)
                       throws InvalidInputException

Throws:: InvalidInputException

asEntityJson

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

validate

public void validate()
              throws InvalidInputException

Throws:: InvalidInputException

getPresentationMLTag
```
public String getPresentationMLTag()
```
Description copied from class: Element

Return the element's PresentationML tag. By default is equals to MessageML tag, override when needed

Overrides:

getPresentationMLTag in class Element

getEntityValue

protected abstract String getEntityValue()

getEntitySubType

protected abstract String getEntitySubType()

getEntityVersion

protected abstract String getEntityVersion()

getEntityType

protected abstract String getEntityType()

getEntityIdPrefix

protected abstract String getEntityIdPrefix()