io.github.portlek.observer.Source Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of SmartInventory Show documentation

An API for creating unique inventories for Bukkit servers.

There is a newer version: 4.3.3

/*
 * MIT License
 *
 * Copyright (c) 2020 Hasan Demirtaş
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to deal
 * in the Software without restriction, including without limitation the rights
 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 * copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in all
 * copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 * SOFTWARE.
 *
 */

package io.github.portlek.observer;

import org.jetbrains.annotations.NotNull;

/**
 * a class that is the observer's source.
 *
 * @param  type of the arguments.
 */
public interface Source {

  /**
   * subscribes the given {@link Target} into the source.
   *
   * @param target the target to subscribe.
   */
  void subscribe(@NotNull Target target);

  /**
   * remove the given {@link Target} from the subscriptions of the source.
   *
   * @param target the target to remove.
   */
  void unsubscribe(@NotNull Target target);

  /**
   * notifies {@link Target#update(Object)} method all of the subscribes.
   *
   * @param argument the argument to notify.
   */
  void notifyTargets(@NotNull T argument);
}