org.anvilpowered.anvil.api.registry.Registry Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of anvil-api Show documentation
Show all versions of anvil-api Show documentation
A cross-platform database API / ORM / entity framework with useful services for minecraft plugins
The newest version!
/*
* Anvil - AnvilPowered
* Copyright (C) 2020
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU Lesser 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 Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public License
* along with this program. If not, see The value type of the provided {@link Key}
* @param key The {@link Key} to get the value for
* @return This registry's value for the provided {@link Key}
* @throws NoSuchElementException If this registry has no value defined
* for the provided {@link Key}
*/
@RegistryScoped
T getUnsafe(Key key);
/**
* Gets this registry's value for the provided {@link Key}
* or {@link Optional#empty()} if it is not present.
*
* @param The value type of the provided {@link Key}
* @param key The {@link Key} to get the value for
* @return This registry's value for the provided {@link Key} or {@link Optional#empty()}
*/
@RegistryScoped
Optional get(Key key);
/**
* Gets this registry's default value for the provided {@link Key}
* or the fallback value if it is not present.
*
* @param The value type of the provided {@link Key}
* @param key The {@link Key} to get the default value for
* @return This registry's default value for the provided {@link Key} or the fallback value
*/
@RegistryScoped
default T getDefault(Key key) {
return key.getFallbackValue();
}
/**
* Gets this registry's value for the provided {@link Key}
* or the default value if it is not present.
*
* @param The value type of the provided {@link Key}
* @param key The {@link Key} to get the value or (if not present) the default value for
* @return This registry's value for the provided {@link Key} or the default value
*/
@RegistryScoped
default T getOrDefault(Key key) {
return get(key).orElse(getDefault(key));
}
/**
* Similar to {@link #getOrDefault(Key)}, but performs additional (implementation specific)
* checks that could potentially check other registries if certain requirements are met.
* Use {@link #getOrDefault(Key)} unless you are sure you need this.
*
* @param The value type of the provided {@link Key}
* @param key The {@link Key} to get the value for
* @return The value for the provided {@link Key} as defined by the additional checks
*/
@RegistryScoped
default T getExtraSafe(Key key) {
return getOrDefault(key);
}
/**
* Sets this registry's value for the provided {@link Key}
*
* @param The value type of the provided {@link Key}
* @param key The {@link Key} to set the value for
* @param value The value to set
*/
@RegistryScoped
void set(Key key, T value);
/**
* Removes this registry's value for the provided {@link Key}
*
* @param The value type of the provided {@link Key}
* @param key The {@link Key} to set the value for
*/
@RegistryScoped
void remove(Key key);
/**
* Applies the provided transformation to this registry's
* value for the provided {@link Key}
*
* @param The value type of the provided {@link Key}
* @param key The {@link Key} to transform the value for
* @param transformer The transformation to apply
*/
@RegistryScoped
void transform(Key key, BiFunction, ? super T, ? extends T> transformer);
/**
* Applies the provided transformation to this registry's
* value for the provided {@link Key}
*
* @param The value type of the provided {@link Key}
* @param key The {@link Key} to transform the value for
* @param transformer The transformation to apply
*/
@RegistryScoped
void transform(Key key, Function transformer);
/**
* Adds the provided value to this registry's
* {@link Collection} value for the provided {@link Key}
*
* @param The value type of the provided {@link Key}
* @param key The {@link Key} of the collection
* to add the provided value to
* @param value The value to add
*/
@RegistryScoped
void addToCollection(Key> key, T value);
/**
* Removes the provided value from this registry's
* {@link Collection} value for the provided {@link Key}
*
* @param The value type of the provided {@link Key}
* @param key The {@link Key} of the collection
* to add the provided value to
* @param value The value to add
*/
@RegistryScoped
void removeFromCollection(Key> key, T value);
/**
* Puts the provided key and value pair to this registry's
* {@link Map} value for the provided {@link Key}
*
* @param The key type of the map value for the provided key
* @param The value type of the map value for the provided key
* @param key The {@link Key} of the map to add the
* provided key and value pair to
* @param mapKey The map key to add
* @param mapValue The map value to add
*/
@RegistryScoped
void putInMap(Key> key, K mapKey, T mapValue);
/**
* Removes the provided key from this registry's
* {@link Map} value for the provided {@link Key}
*
* @param The key type of the map value for the provided key
* @param The value type of the map value for the provided key
* @param key The {@link Key} of the map to remove the provided mapKey from
* @param mapKey The map key to remove
*/
@RegistryScoped
void removeFromMap(Key> key, K mapKey);
/**
* Runs all {@link Runnable listeners} that were
* added before this call in the provided registryScope.
*
* @param registryScope The {@link RegistryScope} to load
* @see Environment#reload()
* @see #whenLoaded(Runnable)
*/
@RegistryScoped
void load(RegistryScope registryScope);
/**
* Runs all {@link Runnable listeners} that were
* added before this call in the {@link RegistryScope#DEFAULT default scope}.
*
* @see Environment#reload()
* @see #whenLoaded(Runnable)
*/
@RegistryScoped
default void load() {
load(RegistryScope.DEFAULT);
}
/**
* Adds a {@link Runnable} to be loaded on {@link #load()}.
*
*
* Listeners are grouped by order. Smaller orders run before larger ones.
* The execution order within one order group is not guaranteed.
*
*
* Please note that {@link ListenerRegistrationEnd#register()} must be invoked to
* complete the registration.
*
*
* @param listener Listener to add
* @return A {@link ListenerRegistrationEnd} for specifying additional parameters and
* completing the registration.
* @see #load()
*/
ListenerRegistrationEnd whenLoaded(Runnable listener);
interface ListenerRegistrationEnd {
/**
* Sets the order for the listener.
* The default order is 0.
*
* @param order The order to run this listener in. Smaller is earlier.
* @return {@code this}
*/
ListenerRegistrationEnd order(int order);
/**
* Sets the scope for the listener.
* The default scope is {@link RegistryScope#DEFAULT}.
*
* @param scope The scope to run this listener in.
* @return {@code this}
* @see RegistryScope
* @see RegistryScoped
*/
ListenerRegistrationEnd scope(RegistryScope scope);
/**
* Completes the listener registration.
*/
void register();
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy