Add javadocs to DB hook interfaces.

This commit is contained in:
akwizgran
2019-04-26 16:42:36 +01:00
parent 56fbc93962
commit 891c82b2e5
8 changed files with 52 additions and 3 deletions

View File

@@ -124,6 +124,12 @@ public interface BlogManager {
void registerRemoveBlogHook(RemoveBlogHook hook);
interface RemoveBlogHook {
/**
* Called when a blog is being removed.
*
* @param txn A read-write transaction
* @param b The blog that is being removed
*/
void removingBlog(Transaction txn, Blog b) throws DbException;
}

View File

@@ -100,6 +100,12 @@ public interface ForumManager {
void setReadFlag(GroupId g, MessageId m, boolean read) throws DbException;
interface RemoveForumHook {
/**
* Called when a forum is being removed.
*
* @param txn A read-write transaction
* @param f The forum that is being removed
*/
void removingForum(Transaction txn, Forum f) throws DbException;
}
}

View File

@@ -140,9 +140,22 @@ public interface PrivateGroupManager {
@NotNullByDefault
interface PrivateGroupHook {
/**
* Called when a member is being added to a private group.
*
* @param txn A read-write transaction
* @param g The ID of the private group
* @param a The member that is being added
*/
void addingMember(Transaction txn, GroupId g, Author a)
throws DbException;
/**
* Called when a private group is being removed.
*
* @param txn A read-write transaction
* @param g The ID of the private group that is being removed
*/
void removingGroup(Transaction txn, GroupId g) throws DbException;
}