me.lucko.helper.event.functional.merged.MergedSubscriptionBuilder Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of helper Show documentation
Show all versions of helper Show documentation
A utility to reduce boilerplate code in Bukkit plugins.
/*
* This file is part of helper, licensed under the MIT License.
*
* Copyright (c) lucko (Luck)
* Copyright (c) contributors
*
* 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 me.lucko.helper.event.functional.merged;
import com.google.common.base.Preconditions;
import com.google.common.reflect.TypeToken;
import me.lucko.helper.event.MergedSubscription;
import me.lucko.helper.event.functional.ExpiryTestStage;
import me.lucko.helper.event.functional.SubscriptionBuilder;
import me.lucko.helper.utils.Delegates;
import org.bukkit.event.Event;
import org.bukkit.event.EventPriority;
import java.util.concurrent.TimeUnit;
import java.util.function.BiConsumer;
import java.util.function.BiPredicate;
import java.util.function.Consumer;
import java.util.function.Function;
import java.util.function.Predicate;
import javax.annotation.Nonnull;
/**
* Functional builder for {@link MergedSubscription}s.
*
* @param the handled type
*/
public interface MergedSubscriptionBuilder extends SubscriptionBuilder {
/**
* Makes a MergedHandlerBuilder for a given super type
*
* @param handledClass the super type of the event handler
* @param the super type class
* @return a {@link MergedSubscriptionBuilder} to construct the event handler
*/
@Nonnull
static MergedSubscriptionBuilder newBuilder(@Nonnull Class handledClass) {
Preconditions.checkNotNull(handledClass, "handledClass");
return new MergedBuilder<>(TypeToken.of(handledClass));
}
/**
* Makes a MergedHandlerBuilder for a given super type
*
* @param type the super type of the event handler
* @param the super type class
* @return a {@link MergedSubscriptionBuilder} to construct the event handler
*/
@Nonnull
static MergedSubscriptionBuilder newBuilder(@Nonnull TypeToken type) {
Preconditions.checkNotNull(type, "type");
return new MergedBuilder<>(type);
}
/**
* Makes a MergedHandlerBuilder for a super event class
*
* @param superClass the abstract super event class
* @param eventClasses the event classes to be bound to
* @param the super class type
* @return a {@link MergedSubscriptionBuilder} to construct the event handler
*/
@Nonnull
@SafeVarargs
static MergedSubscriptionBuilder newBuilder(@Nonnull Class superClass, @Nonnull Class... eventClasses) {
return newBuilder(superClass, EventPriority.NORMAL, eventClasses);
}
/**
* Makes a MergedHandlerBuilder for a super event class
*
* @param superClass the abstract super event class
* @param priority the priority to listen at
* @param eventClasses the event classes to be bound to
* @param the super class type
* @return a {@link MergedSubscriptionBuilder} to construct the event handler
*/
@Nonnull
@SafeVarargs
static MergedSubscriptionBuilder newBuilder(@Nonnull Class superClass, @Nonnull EventPriority priority, @Nonnull Class... eventClasses) {
Preconditions.checkNotNull(superClass, "superClass");
Preconditions.checkNotNull(eventClasses, "eventClasses");
Preconditions.checkNotNull(priority, "priority");
if (eventClasses.length < 2) {
throw new IllegalArgumentException("merge method used for only one subclass");
}
MergedBuilder h = new MergedBuilder<>(TypeToken.of(superClass));
for (Class clazz : eventClasses) {
h.bindEvent(clazz, priority, e -> e);
}
return h;
}
// override return type - we return MergedSubscriptionBuilder, not SubscriptionBuilder
@Nonnull
@Override
default MergedSubscriptionBuilder expireIf(@Nonnull Predicate predicate) {
return expireIf(Delegates.predicateToBiPredicateSecond(predicate), ExpiryTestStage.PRE, ExpiryTestStage.POST_HANDLE);
}
@Nonnull
@Override
default MergedSubscriptionBuilder expireAfter(long duration, @Nonnull TimeUnit unit) {
Preconditions.checkNotNull(unit, "unit");
Preconditions.checkArgument(duration >= 1, "duration < 1");
long expiry = Math.addExact(System.currentTimeMillis(), unit.toMillis(duration));
return expireIf((handler, event) -> System.currentTimeMillis() > expiry, ExpiryTestStage.PRE);
}
@Nonnull
@Override
default MergedSubscriptionBuilder expireAfter(long maxCalls) {
Preconditions.checkArgument(maxCalls >= 1, "maxCalls < 1");
return expireIf((handler, event) -> handler.getCallCounter() >= maxCalls, ExpiryTestStage.PRE, ExpiryTestStage.POST_HANDLE);
}
@Nonnull
@Override
MergedSubscriptionBuilder filter(@Nonnull Predicate predicate);
/**
* Add a expiry predicate.
*
* @param predicate the expiry test
* @param testPoints when to test the expiry predicate
* @return ths builder instance
*/
@Nonnull
MergedSubscriptionBuilder expireIf(@Nonnull BiPredicate, T> predicate, @Nonnull ExpiryTestStage... testPoints);
/**
* Binds this handler to an event
*
* @param eventClass the event class to bind to
* @param function the function to remap the event
* @param the event class
* @return the builder instance
*/
@Nonnull
MergedSubscriptionBuilder bindEvent(@Nonnull Class eventClass, @Nonnull Function function);
/**
* Binds this handler to an event
*
* @param eventClass the event class to bind to
* @param priority the priority to listen at
* @param function the function to remap the event
* @param the event class
* @return the builder instance
*/
@Nonnull
MergedSubscriptionBuilder bindEvent(@Nonnull Class eventClass, @Nonnull EventPriority priority, @Nonnull Function function);
/**
* Sets the exception consumer for the handler.
*
* If an exception is thrown in the handler, it is passed to this consumer to be swallowed.
*
* @param consumer the consumer
* @return the builder instance
* @throws NullPointerException if the consumer is null
*/
@Nonnull
MergedSubscriptionBuilder exceptionConsumer(@Nonnull BiConsumer consumer);
/**
* Return the handler list builder to append handlers for the event.
*
* @return the handler list
*/
@Nonnull
MergedHandlerList handlers();
/**
* Builds and registers the Handler.
*
* @param handler the consumer responsible for handling the event.
* @return a registered {@link MergedSubscription} instance.
* @throws NullPointerException if the handler is null
* @throws IllegalStateException if no events have been bound to
*/
@Nonnull
default MergedSubscription handler(@Nonnull Consumer handler) {
return handlers().consumer(handler).register();
}
/**
* Builds and registers the Handler.
*
* @param handler the bi-consumer responsible for handling the event.
* @return a registered {@link MergedSubscription} instance.
* @throws NullPointerException if the handler is null
* @throws IllegalStateException if no events have been bound to
*/
@Nonnull
default MergedSubscription biHandler(@Nonnull BiConsumer, ? super T> handler) {
return handlers().biConsumer(handler).register();
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy