com.github.nalukit.nalu.client.component.event.HideBlockComponentEvent Maven / Gradle / Ivy

Go to download
package com.github.nalukit.nalu.client.component.event;

import org.gwtproject.event.shared.Event;

import java.util.HashMap;
import java.util.Map;

/**
 * Hides a BlockComponent.
 */
public class HideBlockComponentEvent
    extends Event {

  public final static Type TYPE = new Type<>();

  private final Map commandStore;
  private final Map                                            dataStore;
  private final Map                                            dataObjectStore;
  private final String                                                         name;

  @SuppressWarnings("unused")
  private HideBlockComponentEvent() {
    this("");
  }

  private HideBlockComponentEvent(String name) {
    super();
    this.name            = name;
    this.commandStore    = new HashMap<>();
    this.dataStore       = new HashMap<>();
    this.dataObjectStore = new HashMap<>();
  }

  public static HideBlockComponentEvent hide(String name) {
    return new HideBlockComponentEvent(name);
  }

  @Override
  public Type getAssociatedType() {
    return TYPE;
  }

  @Override
  protected void dispatch(HideBlockComponentEvent.HideBlockComponentHandler handler) {
    handler.onHideBlockComponent(this);
  }

  public String getName() {
    return name;
  }

  /**
   * Returns the command store
   *
   * @return the store containing key-value-pairs where value is a command
   */
  public Map getCommandStore() {
    return commandStore;
  }

  /**
   * Returns the data store where all String are stored.
   *
   * @return the store containing key-value-pairs where value is a String
   */
  public Map getDataStore() {
    return dataStore;
  }

  /**
   * Returns the data object store where all object are stored.
   *
   * @return the store containing key-value-pairs where value is an Object that needs to be cast
   */
  public Map getDataObjectStore() {
    return dataObjectStore;
  }

  /**
   * Adds String-data to the String-data store.
   *
   * @param key   key of the parameter
   * @param value value of the parameter
   * @return instance of the event
   */
  public HideBlockComponentEvent using(String key,
                                       String value) {
    this.dataStore.put(key,
                       value);
    return this;
  }

  /**
   * Adds data to the data store.
   *
   * Keep in mind, all parameters will be stored as objects!
   *
   * @param key   key of the parameter
   * @param value value of the parameter
   * @return instance of the event
   */
  public HideBlockComponentEvent usingObject(String key,
                                             Object value) {
    this.dataObjectStore.put(key,
                             value);
    return this;
  }

  /**
   * Adds a command to the command store.
   *
   * @param key     key of the parameter
   * @param command command to store
   * @return instance of the event
   */
  public HideBlockComponentEvent add(String key,
                                     HideBlockComponentEvent.HideBlockComponentCommand command) {
    this.commandStore.put(key,
                          command);
    return this;
  }

  @FunctionalInterface
  public interface HideBlockComponentHandler {

    void onHideBlockComponent(HideBlockComponentEvent event);

  }



  @FunctionalInterface
  public interface HideBlockComponentCommand {

    void execute();

  }

}