personthecat.catlib.data.ModDescriptor Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of catlib-quilt Show documentation
Utilities for serialization, commands, noise generation, IO, and some new data types.
The newest version!
package personthecat.catlib.data;

import lombok.Builder;
import lombok.Value;
import net.minecraft.class_2960;
import org.jetbrains.annotations.Nullable;
import personthecat.catlib.util.McUtils;
import personthecat.catlib.linting.SyntaxLinter;
import personthecat.catlib.versioning.Version;

import java.io.File;
import java.util.Objects;

/**
 * A platform-agnostic DTO containing information about a given mod's
 * ID, name, and folder layout. This will be used by the library for
 * generating commands and command arguments, but it may provide
 * additional functionalities in the future.
 * 
 *   Ideally, this object would not be constructed more than once.
 *   Consider creating this object in a static context and not allowing
 *   the reference to be modified at any point.
 * 

 *   This object makes use of {@link Builder} to provide a convenient
 *   builder API so that any number of arguments can be neatly applied.
 *   Consider adding a Lombok plugin to your build environment to avoid
 *   any generated code-related issues in your IDE.
 * 
 *   public static final ModDescriptor MOD_DESCRIPTOR =
 *       ModDescriptor.builder()
 *           .name("Formatted Name")
 *           .modId("mod_id")
 *           .build();
 * 

 *   Note that name and modId are the only
 *   required parameters. The others can be inferred if needed.
 * 
 */
@Value
@Builder
@SuppressWarnings("unused")
public class ModDescriptor {
    String name;
    String modId;
    Version version;
    String commandPrefix;
    File configFolder;
    File backupFolder;
    @Nullable File preferredDirectory;

    SyntaxLinter defaultLinter;

    public class_2960 id(final String path) {
        return new class_2960(this.modId, path);
    }

    @Override
    public boolean equals(final Object o) {
        return o instanceof ModDescriptor && this.modId.equals(((ModDescriptor) o).getModId());
    }

    @Override
    public int hashCode() {
        return this.modId.hashCode();
    }

    public static class ModDescriptorBuilder {
        public ModDescriptor build() {
            Objects.requireNonNull(this.name, "name must not be null");
            Objects.requireNonNull(this.modId, "modId must not be null");
            if (this.version == null) this.version = Version.ZERO;
            if (this.commandPrefix == null) this.commandPrefix = this.modId;
            if (this.configFolder == null) this.configFolder = new File(McUtils.getConfigDir(), this.modId);
            if (this.backupFolder == null) this.backupFolder = new File(this.configFolder, "backups");
            if (this.defaultLinter == null) this.defaultLinter = SyntaxLinter.DEFAULT_LINTER;

            return new ModDescriptor(name, modId, version, commandPrefix, configFolder, backupFolder, preferredDirectory, defaultLinter);
        }
    }
}