Package com.adobe.granite.comments
Class CommentingEvent
- java.lang.Object
 - 
- com.adobe.granite.comments.CommentingEvent
 
 
- 
public final class CommentingEvent extends java.lang.ObjectTheCommentingEventrepresents events occurred during commenting 
- 
- 
Nested Class Summary
Nested Classes Modifier and Type Class Description static classCommentingEvent.Typetypes of commenting events 
- 
Field Summary
Fields Modifier and Type Field Description static java.lang.StringEVENT_TOPIC_BASEBase Event Topic for Commenting Events. 
- 
Constructor Summary
Constructors Constructor Description CommentingEvent(CommentingEvent.Type eventTopic, java.lang.String commentPath) 
- 
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static CommentingEventcommented(java.lang.String commentPath)creates an event for Type.COMMENTEDstatic CommentingEventfromEvent(org.osgi.service.event.Event event)convert OSGI event toCommentingEventjava.lang.StringgetCommentPath()java.lang.StringgetEventTopic()org.osgi.service.event.EventtoEvent()Create a distributable event. 
 - 
 
- 
- 
Field Detail
- 
EVENT_TOPIC_BASE
public static final java.lang.String EVENT_TOPIC_BASE
Base Event Topic for Commenting Events. EVENT_TOPIC will be formed by appending types to it.- See Also:
 - Constant Field Values
 
 
 - 
 
- 
Constructor Detail
- 
CommentingEvent
public CommentingEvent(CommentingEvent.Type eventTopic, java.lang.String commentPath)
 
 - 
 
- 
Method Detail
- 
fromEvent
public static CommentingEvent fromEvent(org.osgi.service.event.Event event)
convert OSGI event toCommentingEvent- Parameters:
 event- OSGI event- Returns:
 - CommentingEvent. null if it can't be converted to CommentingEvent.
 
 
- 
getCommentPath
public java.lang.String getCommentPath()
- Returns:
 - the path of the comment created.
 
 
- 
getEventTopic
public java.lang.String getEventTopic()
- Returns:
 - event topic of the event
 
 
- 
commented
public static CommentingEvent commented(java.lang.String commentPath)
creates an event for Type.COMMENTED- Parameters:
 commentPath- path of the comment node- Returns:
 - CommentingEvent Object
 
 
- 
toEvent
public org.osgi.service.event.Event toEvent()
Create a distributable event.- Returns:
 - An event.
 
 
 - 
 
 -