| java.lang.Object | |
| ↳ | com.pspdfkit.annotations.note.AnnotationReviewSummary |
Class Overview
Summarizes the information about an annotation’s review state. It holds the data of currently set states mapped by the author and the author state for the current user.
Summary
| Public Constructors | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
|
AnnotationReviewSummary(Map<AuthorState, List<String>> reviewNames, AuthorState currentUserState)
Creates a new summary for the annotation review state.
| |||||||||||
| Public Methods | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
| AuthorState |
getCurrentUserState()
Returns the state set by the current user, or
NONE if none set. | ||||||||||
| Map<AuthorState, List<String>> |
getReviewNames()
Get's the map between the set state and a list of authors whose last set status is that one.
| ||||||||||
|
[Expand]
Inherited Methods | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
From class
java.lang.Object
| |||||||||||
Public Constructors
public AnnotationReviewSummary (Map<AuthorState, List<String>> reviewNames, AuthorState currentUserState)
Creates a new summary for the annotation review state.
Parameters
| reviewNames | Map between the set state and a list of authors whose last set status is that one. |
|---|---|
| currentUserState | The state set by the current user. |
Public Methods
public AuthorState getCurrentUserState ()
Returns the state set by the current user, or NONE if none set.
Returns
- State set by the current user.
public Map<AuthorState, List<String>> getReviewNames ()
Get's the map between the set state and a list of authors whose last set status is that one.
Returns
- A map that maps currently set author states with the list of authors that have set it.