001/*
002 * PlotSquared, a land and world management plugin for Minecraft.
003 * Copyright (C) IntellectualSites <https://intellectualsites.com>
004 * Copyright (C) IntellectualSites team and contributors
005 *
006 * This program is free software: you can redistribute it and/or modify
007 * it under the terms of the GNU General Public License as published by
008 * the Free Software Foundation, either version 3 of the License, or
009 * (at your option) any later version.
010 *
011 * This program is distributed in the hope that it will be useful,
012 * but WITHOUT ANY WARRANTY; without even the implied warranty of
013 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
014 * GNU General Public License for more details.
015 *
016 * You should have received a copy of the GNU General Public License
017 * along with this program.  If not, see <https://www.gnu.org/licenses/>.
018 */
019package com.plotsquared.core.inject.factory;
020
021import com.google.inject.assistedinject.Assisted;
022import com.plotsquared.core.configuration.caption.Caption;
023import com.plotsquared.core.player.PlotPlayer;
024import com.plotsquared.core.queue.subscriber.ProgressSubscriber;
025import org.checkerframework.checker.nullness.qual.NonNull;
026
027import javax.annotation.Nullable;
028
029public interface ProgressSubscriberFactory {
030
031    @NonNull ProgressSubscriber create();
032
033    @NonNull ProgressSubscriber createWithActor(@Nullable @Assisted("subscriber") PlotPlayer<?> actor);
034
035    @NonNull ProgressSubscriber createFull(
036            @Nullable @Assisted("subscriber") PlotPlayer<?> actor,
037            @Assisted("progressInterval") final long interval,
038            @Assisted("waitBeforeStarting") final long wait,
039            @Nullable @Assisted("caption") Caption caption
040    );
041
042}