/*
 *
 * Copyright (C) 2007-2015 Licensed to the Comunes Association (CA) under
 * one or more contributor license agreements (see COPYRIGHT for details).
 * The CA licenses this file to you under the GNU Affero General Public
 * License version 3, (the "License"); you may not use this file except in
 * compliance with the License. This file is part of kune.
 *
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Affero General Public License as
 * published by the Free Software Foundation, either version 3 of the
 * License, or (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU Affero General Public License for more details.
 *
 * You should have received a copy of the GNU Affero General Public License
 * along with this program.  If not, see <http://www.gnu.org/licenses/>.
 *
 */
package cc.kune.core.client.events;

import com.google.gwt.event.shared.EventHandler;
import com.google.gwt.event.shared.GwtEvent;
import com.google.gwt.event.shared.HandlerRegistration;
import com.google.gwt.event.shared.HasHandlers;
import com.google.web.bindery.event.shared.EventBus;

// TODO: Auto-generated Javadoc
/**
 * The Class UserMustBeLoggedEvent.
 *
 * @author vjrj@ourproject.org (Vicente J. Ruiz Jurado)
 */
public class UserMustBeLoggedEvent extends GwtEvent<UserMustBeLoggedEvent.UserMustBeLoggedHandler> {

  /**
   * The Interface HasUserMustBeLoggedHandlers.
   *
   * @author vjrj@ourproject.org (Vicente J. Ruiz Jurado)
   */
  public interface HasUserMustBeLoggedHandlers extends HasHandlers {

    /**
     * Adds the user must be logged handler.
     *
     * @param handler
     *          the handler
     * @return the handler registration
     */
    HandlerRegistration addUserMustBeLoggedHandler(UserMustBeLoggedHandler handler);
  }

  /**
   * The Interface UserMustBeLoggedHandler.
   *
   * @author vjrj@ourproject.org (Vicente J. Ruiz Jurado)
   */
  public interface UserMustBeLoggedHandler extends EventHandler {

    /**
     * On user must be logged.
     *
     * @param event
     *          the event
     */
    public void onUserMustBeLogged(UserMustBeLoggedEvent event);
  }

  /** The Constant TYPE. */
  private static final Type<UserMustBeLoggedHandler> TYPE = new Type<UserMustBeLoggedHandler>();

  /**
   * Fire.
   *
   * @param eventBus
   *          the source
   */
  public static void fire(final EventBus eventBus) {
    eventBus.fireEvent(new UserMustBeLoggedEvent());
  }

  /**
   * Gets the type.
   *
   * @return the type
   */
  public static Type<UserMustBeLoggedHandler> getType() {
    return TYPE;
  }

  /**
   * Instantiates a new user must be logged event.
   */
  public UserMustBeLoggedEvent() {
  }

  /*
   * (non-Javadoc)
   *
   * @see
   * com.google.gwt.event.shared.GwtEvent#dispatch(com.google.gwt.event.shared
   * .EventHandler)
   */
  @Override
  protected void dispatch(final UserMustBeLoggedHandler handler) {
    handler.onUserMustBeLogged(this);
  }

  /*
   * (non-Javadoc)
   *
   * @see java.lang.Object#equals(java.lang.Object)
   */
  @Override
  public boolean equals(final Object obj) {
    return super.equals(obj);
  }

  /*
   * (non-Javadoc)
   *
   * @see com.google.gwt.event.shared.GwtEvent#getAssociatedType()
   */
  @Override
  public Type<UserMustBeLoggedHandler> getAssociatedType() {
    return TYPE;
  }

  /*
   * (non-Javadoc)
   *
   * @see java.lang.Object#hashCode()
   */
  @Override
  public int hashCode() {
    return super.hashCode();
  }

  /*
   * (non-Javadoc)
   *
   * @see com.google.web.bindery.event.shared.Event#toString()
   */
  @Override
  public String toString() {
    return "UserMustBeLoggedEvent[" + "]";
  }
}