@Version("2.1.9")
Package com.adobe.granite.comments
Provides a commenting API.
-
Interface Summary Interface Description Comment AComment
represents an annotation created by a user (author) on a specific target (e.g.CommentCollection<C extends Comment> ACommentCollection
represents a collection ofComment
s.CommentingProvider ACommentingProvider
represents a "configuration" used by theCommentManager
service to create and storeComment
s andCommentCollection
s.CommentManager TheCommentManager
provides facilities to manage (create, get or remove)CommentCollection
s. -
Class Summary Class Description AbstractComment TheAbstractComment
implementsComment
and provides the API implementation, at the same time offering abstract methods with which concrete implementations can control retrieval and storage of resources.AbstractCommentCollection<C extends Comment> TheAbstractCommentCollection
implements aCommentCollection
and provides basic implementation of the API, providing abstract methods so that concrete implementations can control storage and retrieval of resources.AbstractCommentingProvider TheAbstractCommentingProvider
provides a default implementation for storingComment
s andCommentCollection
s.CommentingEvent TheCommentingEvent
represents events occurred during commentingCommentingOperationHandler -
Enum Summary Enum Description CommentingEvent.Type types of commenting events -
Exception Summary Exception Description CommentException TheCommentException
applies to exceptions occurring in commenting.