mirror of https://github.com/GeyserMC/Geyser.git
115 lines
4.2 KiB
Java
115 lines
4.2 KiB
Java
/*
|
|
* Copyright (c) 2019-2022 GeyserMC. http://geysermc.org
|
|
*
|
|
* 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.
|
|
*
|
|
* @author GeyserMC
|
|
* @link https://github.com/GeyserMC/Geyser
|
|
*/
|
|
|
|
package org.geysermc.geyser.registry;
|
|
|
|
import org.cloudburstmc.nbt.NbtMap;
|
|
import org.geysermc.geyser.registry.loader.RegistryLoader;
|
|
|
|
import java.util.function.Consumer;
|
|
|
|
/**
|
|
* A wrapper around a value which is loaded based on the output from the provided
|
|
* {@link RegistryLoader}. This class is primarily designed to hold a registration
|
|
* of some kind, however no limits are set on what it can hold, as long as the
|
|
* specified RegistryLoader returns the same value type that is specified in the
|
|
* generic.
|
|
*
|
|
* <p>
|
|
* Below, a RegistryLoader is taken in the constructor. RegistryLoaders have two
|
|
* generic types: the input, and the output. The input is what it takes in, whether
|
|
* it be a string which references to a file, or nothing more than an integer. The
|
|
* output is what it generates based on the input, and should be the same type as
|
|
* the {@link M} generic specified in the registry.
|
|
*
|
|
* <p>
|
|
* Registries can be very simple to create. Here is an example that simply parses a
|
|
* number given a string:
|
|
*
|
|
* <pre>
|
|
* {@code
|
|
* public static final SimpleRegistry<Integer> STRING_TO_INT = SimpleRegistry.create("5", Integer::parseInt);
|
|
* }
|
|
* </pre>
|
|
*
|
|
* <p>
|
|
* This is a simple example which really wouldn't have much of a practical use,
|
|
* however it demonstrates a fairly basic use case of how this system works. Typically
|
|
* though, the first parameter would be a location of some sort, such as a file path
|
|
* where the loader will load the mappings from. The NBT registry is a good reference
|
|
* point for something both simple and practical. See {@link Registries#BIOMES_NBT} and
|
|
* {@link org.geysermc.geyser.registry.loader.NbtRegistryLoader}.
|
|
*
|
|
* @param <M> the value being held by the registry
|
|
*/
|
|
public abstract class Registry<M> implements IRegistry<M> {
|
|
protected M mappings;
|
|
|
|
/**
|
|
* Creates a new instance of this class with the given input and
|
|
* {@link RegistryLoader}. The input specified is what the registry
|
|
* loader needs to take in.
|
|
*
|
|
* @param input the input
|
|
* @param registryLoader the registry loader
|
|
* @param <I> the input type
|
|
*/
|
|
protected <I> Registry(I input, RegistryLoader<I, M> registryLoader) {
|
|
this.mappings = registryLoader.load(input);
|
|
}
|
|
|
|
/**
|
|
* Gets the underlying value held by this registry.
|
|
*
|
|
* @return the underlying value held by this registry.
|
|
*/
|
|
@Override
|
|
public M get() {
|
|
return this.mappings;
|
|
}
|
|
|
|
/**
|
|
* Sets the underlying value held by this registry.
|
|
* Clears any existing data associated with the previous
|
|
* value.
|
|
*
|
|
* @param mappings the underlying value held by this registry
|
|
*/
|
|
@Override
|
|
public void set(M mappings) {
|
|
this.mappings = mappings;
|
|
}
|
|
|
|
/**
|
|
* Registers what is specified in the given
|
|
* {@link Consumer} into the underlying value.
|
|
*
|
|
* @param consumer the consumer
|
|
*/
|
|
@Override
|
|
public void register(Consumer<M> consumer) {
|
|
consumer.accept(this.mappings);
|
|
}
|
|
} |