com.google.gerrit.server.extensions.events.PluginEvent Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of gerrit-plugin-api Show documentation

API for Gerrit Plugins

There is a newer version: 3.11.0-rc3

// Copyright (C) 2015 The Android Open Source Project
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.

package com.google.gerrit.server.extensions.events;

import com.google.gerrit.common.UsedAt;
import com.google.gerrit.extensions.events.PluginEventListener;
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
@UsedAt(UsedAt.Project.PLUGINS_ALL)
public class PluginEvent {
  private final PluginSetContext listeners;

  @Inject
  PluginEvent(PluginSetContext listeners) {
    this.listeners = listeners;
  }

  public void fire(String pluginName, String type, String data) {
    if (!listeners.iterator().hasNext()) {
      return;
    }
    Event e = new Event(pluginName, type, data);
    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;
    private final String data;

    Event(String pluginName, String type, String data) {
      this.pluginName = pluginName;
      this.type = type;
      this.data = data;
    }

    @Override
    public String pluginName() {
      return pluginName;
    }

    @Override
    public String getType() {
      return type;
    }

    @Override
    public String getData() {
      return data;
    }
  }
}