opendev/gerrit
Code Issues Proposed changes

Document classes in c.g.g.server.extensions.events package

Browse Source 
Change-Id: I56100b34701e347f80104bc506d0c4803a701fb1
Signed-off-by: Edwin Kempin <ekempin@google.com>
This commit is contained in:
Edwin Kempin
2019-12-24 10:42:00 +01:00
parent 0b5ab52226
commit 9bcac2946b
21 changed files with 40 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files

1
java/com/google/gerrit/server/extensions/events/AbstractChangeEvent.java
View File

@@ -20,6 +20,7 @@ import com.google.gerrit.extensions.common.ChangeInfo;
import com.google.gerrit.extensions.events.ChangeEvent;
import java.sql.Timestamp;
/** Base class for all change events. */
public abstract class AbstractChangeEvent implements ChangeEvent {
private final ChangeInfo changeInfo;
private final AccountInfo who;

1
java/com/google/gerrit/server/extensions/events/AbstractRevisionEvent.java
View File

@@ -21,6 +21,7 @@ import com.google.gerrit.extensions.common.RevisionInfo;
import com.google.gerrit.extensions.events.RevisionEvent;
import java.sql.Timestamp;
/** Base class for all revision events. */
public abstract class AbstractRevisionEvent extends AbstractChangeEvent implements RevisionEvent {
private final RevisionInfo revisionInfo;

2
java/com/google/gerrit/server/extensions/events/AgreementSignup.java
View File

@@ -21,6 +21,7 @@ import com.google.gerrit.server.plugincontext.PluginSetContext;
import com.google.inject.Inject;
import com.google.inject.Singleton;
/** Helper class to fire an event when a user has signed a contributor agreement. */
@Singleton
public class AgreementSignup {
private final PluginSetContext<AgreementSignupListener> listeners;
@@ -40,6 +41,7 @@ public class AgreementSignup {
listeners.runEach(l -> l.onAgreementSignup(event));
}
/** Event to be fired when a user has signed a contributor agreement. */
private static class Event extends AbstractNoNotifyEvent
implements AgreementSignupListener.Event {
private final AccountInfo account;

2
java/com/google/gerrit/server/extensions/events/AssigneeChanged.java
View File

@@ -27,6 +27,7 @@ import com.google.inject.Inject;
import com.google.inject.Singleton;
import java.sql.Timestamp;
/** Helper class to fire an event when a user has been set as assignee on a change. */
@Singleton
public class AssigneeChanged {
private static final FluentLogger logger = FluentLogger.forEnclosingClass();
@@ -58,6 +59,7 @@ public class AssigneeChanged {
}
}
/** Event to be fired when a user has been set as assignee on a change. */
private static class Event extends AbstractChangeEvent implements AssigneeChangedListener.Event {
private final AccountInfo oldAssignee;

2
java/com/google/gerrit/server/extensions/events/ChangeAbandoned.java
View File

@@ -34,6 +34,7 @@ import com.google.inject.Singleton;
import java.io.IOException;
import java.sql.Timestamp;
/** Helper class to fire an event when a change has been abandoned. */
@Singleton
public class ChangeAbandoned {
private static final FluentLogger logger = FluentLogger.forEnclosingClass();
@@ -78,6 +79,7 @@ public class ChangeAbandoned {
}
}
/** Event to be fired when a change has been abandoned. */
private static class Event extends AbstractRevisionEvent
implements ChangeAbandonedListener.Event {
private final String reason;

2
java/com/google/gerrit/server/extensions/events/ChangeDeleted.java
View File

@@ -27,6 +27,7 @@ import com.google.inject.Inject;
import com.google.inject.Singleton;
import java.sql.Timestamp;
/** Helper class to fire an event when a change has been deleted. */
@Singleton
public class ChangeDeleted {
private static final FluentLogger logger = FluentLogger.forEnclosingClass();
@@ -52,6 +53,7 @@ public class ChangeDeleted {
}
}
/** Event to be fired when a change has been deleted. */
private static class Event extends AbstractChangeEvent implements ChangeDeletedListener.Event {
Event(ChangeInfo change, AccountInfo deleter, Timestamp when) {
super(change, deleter, when, NotifyHandling.ALL);

2
java/com/google/gerrit/server/extensions/events/ChangeMerged.java
View File

@@ -34,6 +34,7 @@ import com.google.inject.Singleton;
import java.io.IOException;
import java.sql.Timestamp;
/** Helper class to fire an event when a change has been merged. */
@Singleton
public class ChangeMerged {
private static final FluentLogger logger = FluentLogger.forEnclosingClass();
@@ -72,6 +73,7 @@ public class ChangeMerged {
}
}
/** Event to be fired when a change has been merged. */
private static class Event extends AbstractRevisionEvent implements ChangeMergedListener.Event {
private final String newRevisionId;

2
java/com/google/gerrit/server/extensions/events/ChangeRestored.java
View File

@@ -34,6 +34,7 @@ import com.google.inject.Singleton;
import java.io.IOException;
import java.sql.Timestamp;
/** Helper class to fire an event when a change has been restored. */
@Singleton
public class ChangeRestored {
private static final FluentLogger logger = FluentLogger.forEnclosingClass();
@@ -72,6 +73,7 @@ public class ChangeRestored {
}
}
/** Event to be fired when a change has been restored. */
private static class Event extends AbstractRevisionEvent implements ChangeRestoredListener.Event {
private String reason;

2
java/com/google/gerrit/server/extensions/events/ChangeReverted.java
View File

@@ -25,6 +25,7 @@ import com.google.inject.Inject;
import com.google.inject.Singleton;
import java.sql.Timestamp;
/** Helper class to fire an event when a change has been reverted. */
@Singleton
public class ChangeReverted {
private static final FluentLogger logger = FluentLogger.forEnclosingClass();
@@ -50,6 +51,7 @@ public class ChangeReverted {
}
}
/** Event to be fired when a change has been reverted. */
private static class Event extends AbstractChangeEvent implements ChangeRevertedListener.Event {
private final ChangeInfo revertChange;

2
java/com/google/gerrit/server/extensions/events/CommentAdded.java
View File

@@ -36,6 +36,7 @@ import java.io.IOException;
import java.sql.Timestamp;
import java.util.Map;
/** Helper class to fire an event when a comment or vote has been added to a change. */
@Singleton
public class CommentAdded {
private static final FluentLogger logger = FluentLogger.forEnclosingClass();
@@ -82,6 +83,7 @@ public class CommentAdded {
}
}
/** Event to be fired when a comment or vote has been added to a change. */
private static class Event extends AbstractRevisionEvent implements CommentAddedListener.Event {
private final String comment;

4
java/com/google/gerrit/server/extensions/events/EventUtil.java
View File

@@ -46,8 +46,8 @@ import org.eclipse.jgit.lib.Config;
/**
* Formats change and revision info objects to serve as payload for Gerrit events.
*
* <p>Uses configurable options ({@code event.payload.listChangeOptions}) to decide which fields to
* populate.
* <p>Uses configurable options ({@code event.payload.listChangeOptions}) to decide which change
* fields to populate.
*/
@Singleton
public class EventUtil {

2
java/com/google/gerrit/server/extensions/events/GitReferenceUpdated.java
View File

@@ -27,6 +27,7 @@ import org.eclipse.jgit.lib.ObjectId;
import org.eclipse.jgit.lib.RefUpdate;
import org.eclipse.jgit.transport.ReceiveCommand;
/** Helper class to fire an event when a Git reference has been updated. */
@Singleton
public class GitReferenceUpdated {
public static final GitReferenceUpdated DISABLED =
@@ -153,6 +154,7 @@ public class GitReferenceUpdated {
listeners.runEach(l -> l.onGitReferenceUpdated(event));
}
/** Event to be fired when a Git reference has been updated. */
public static class Event implements GitReferenceUpdatedListener.Event {
private final String projectName;
private final String ref;

2
java/com/google/gerrit/server/extensions/events/HashtagsEdited.java
View File

@@ -30,6 +30,7 @@ import java.sql.Timestamp;
import java.util.Collection;
import java.util.Set;
/** Helper class to fire an event when the hashtags of a change has been edited. */
@Singleton
public class HashtagsEdited {
private static final FluentLogger logger = FluentLogger.forEnclosingClass();
@@ -63,6 +64,7 @@ public class HashtagsEdited {
}
}
/** Event to be fired when the hashtags of a change has been edited. */
private static class Event extends AbstractChangeEvent implements HashtagsEditedListener.Event {
private Collection<String> updatedHashtags;

2
java/com/google/gerrit/server/extensions/events/PluginEvent.java
View File

@@ -19,6 +19,7 @@ import com.google.gerrit.server.plugincontext.PluginSetContext;
import com.google.inject.Inject;
import com.google.inject.Singleton;
/** Helper class to let plugins fire a plugin-specific event. */
@Singleton
public class PluginEvent {
private final PluginSetContext<PluginEventListener> listeners;
@@ -36,6 +37,7 @@ public class PluginEvent {
listeners.runEach(l -> l.onPluginEvent(e));
}
/** Event to be fired by plugins. */
private static class Event extends AbstractNoNotifyEvent implements PluginEventListener.Event {
private final String pluginName;
private final String type;

2
java/com/google/gerrit/server/extensions/events/PrivateStateChanged.java
View File

@@ -33,6 +33,7 @@ import com.google.inject.Singleton;
import java.io.IOException;
import java.sql.Timestamp;
/** Helper class to fire an event when the private flag of a change has been toggled. */
@Singleton
public class PrivateStateChanged {
private static final FluentLogger logger = FluentLogger.forEnclosingClass();
@@ -67,6 +68,7 @@ public class PrivateStateChanged {
}
}
/** Event to be fired when the private flag of a change has been toggled. */
private static class Event extends AbstractRevisionEvent
implements PrivateStateChangedListener.Event {

2
java/com/google/gerrit/server/extensions/events/ReviewerAdded.java
View File

@@ -36,6 +36,7 @@ import java.io.IOException;
import java.sql.Timestamp;
import java.util.List;
/** Helper class to fire an event when reviewers have been added to a change. */
@Singleton
public class ReviewerAdded {
private static final FluentLogger logger = FluentLogger.forEnclosingClass();
@@ -79,6 +80,7 @@ public class ReviewerAdded {
}
}
/** Event to be fired when reviewers have been added to a change. */
private static class Event extends AbstractRevisionEvent implements ReviewerAddedListener.Event {
private final List<AccountInfo> reviewers;

2
java/com/google/gerrit/server/extensions/events/ReviewerDeleted.java
View File

@@ -36,6 +36,7 @@ import java.io.IOException;
import java.sql.Timestamp;
import java.util.Map;
/** Helper class to fire an event when a reviewer has been deleted from a change. */
@Singleton
public class ReviewerDeleted {
private static final FluentLogger logger = FluentLogger.forEnclosingClass();
@@ -86,6 +87,7 @@ public class ReviewerDeleted {
}
}
/** Event to be fired when a reviewer has been deleted from a change. */
private static class Event extends AbstractRevisionEvent
implements ReviewerDeletedListener.Event {
private final AccountInfo reviewer;

2
java/com/google/gerrit/server/extensions/events/RevisionCreated.java
View File

@@ -35,6 +35,7 @@ import com.google.inject.Singleton;
import java.io.IOException;
import java.sql.Timestamp;
/** Helper class to fire an event when a revision has been created for a change. */
@Singleton
public class RevisionCreated {
private static final FluentLogger logger = FluentLogger.forEnclosingClass();
@@ -93,6 +94,7 @@ public class RevisionCreated {
}
}
/** Event to be fired when a revision has been created for a change. */
private static class Event extends AbstractRevisionEvent
implements RevisionCreatedListener.Event {

2
java/com/google/gerrit/server/extensions/events/TopicEdited.java
View File

@@ -27,6 +27,7 @@ import com.google.inject.Inject;
import com.google.inject.Singleton;
import java.sql.Timestamp;
/** Helper class to fire an event when the topic of a change has been edited. */
@Singleton
public class TopicEdited {
private static final FluentLogger logger = FluentLogger.forEnclosingClass();
@@ -53,6 +54,7 @@ public class TopicEdited {
}
}
/** Event to be fired when the topic of a change has been edited. */
private static class Event extends AbstractChangeEvent implements TopicEditedListener.Event {
private final String oldTopic;

2
java/com/google/gerrit/server/extensions/events/VoteDeleted.java
View File

@@ -36,6 +36,7 @@ import java.io.IOException;
import java.sql.Timestamp;
import java.util.Map;
/** Helper class to fire an event when a vote has been deleted from a change. */
@Singleton
public class VoteDeleted {
private static final FluentLogger logger = FluentLogger.forEnclosingClass();
@@ -86,6 +87,7 @@ public class VoteDeleted {
}
}
/** Event to be fired when a vote has been deleted from a change. */
private static class Event extends AbstractRevisionEvent implements VoteDeletedListener.Event {
private final AccountInfo reviewer;
private final Map<String, ApprovalInfo> approvals;

2
java/com/google/gerrit/server/extensions/events/WorkInProgressStateChanged.java
View File

@@ -33,6 +33,7 @@ import com.google.inject.Singleton;
import java.io.IOException;
import java.sql.Timestamp;
/** Helper class to fire an event when the work-in-progress state of a change has been toggled. */
@Singleton
public class WorkInProgressStateChanged {
private static final FluentLogger logger = FluentLogger.forEnclosingClass();
@@ -68,6 +69,7 @@ public class WorkInProgressStateChanged {
}
}
/** Event to be fired when the work-in-progress state of a change has been toggled. */
private static class Event extends AbstractRevisionEvent
implements WorkInProgressStateChangedListener.Event {