frogmc/FrogLoader
6
0
Fork 0
Code Issues Pull requests Actions Packages Projects Releases Wiki Activity

Cleanup dependency docs
Some checks failed
Publish to snapshot maven / build (push) Failing after 18s
Details

Browse source
This commit is contained in:
TheKodeToad 2024-09-04 19:26:29 +01:00
parent c6b4185b06
commit 1ef8b24764
2 changed files with 1 additions and 37 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

2
src/main/java/dev/frogmc/frogloader/api/mod/ModDependencies.java
View file

@ -12,7 +12,7 @@ import org.jetbrains.annotations.Nullable;
public interface ModDependencies { public interface ModDependencies {
/** /**
* Get dependencies of a specific mod for a specific type * Get dependencies for a specific type
* *
* @param type the dependency type to query for * @param type the dependency type to query for
* @return a collection of dependency entries * @return a collection of dependency entries

36
src/main/java/dev/frogmc/frogloader/impl/mod/ModDependenciesImpl.java
View file

@ -3,35 +3,11 @@ package dev.frogmc.frogloader.impl.mod;
import java.util.*; import java.util.*;
import dev.frogmc.frogloader.api.mod.ModDependencies; import dev.frogmc.frogloader.api.mod.ModDependencies;
import dev.frogmc.frogloader.api.mod.ModProperties;
import dev.frogmc.frogloader.api.mod.SemVer;
/**
* A mod's dependencies.
*
* <p>Mod dependencies are declared in four types:</p>
* <code>Type.DEPEND</code>, <code>Type.BREAK</code>, <code>Type.SUGGEST</code> and <code>Type.PROVIDE</code>
*
* <p>Note: The <code>Type.PROVIDE</code> is a bit of a special case in the way that it only supports a single SemVer version instead of a full version range.</p>
*
* @see ModDependenciesImpl.Type
* @see ModDependenciesImpl.Entry
* @see ModProperties
* @see SemVer
*/
public final class ModDependenciesImpl implements ModDependencies { public final class ModDependenciesImpl implements ModDependencies {
private final Map<Type, Collection<ModDependencies.Entry>> entries = new HashMap<>(); private final Map<Type, Collection<ModDependencies.Entry>> entries = new HashMap<>();
/**
* Construct new mod dependencies for a mod.
* <p><strong>Internal use only.</strong></p>
*
* @param depends <code>Type.DEPEND</code> entries
* @param breaks <code>Type.BREAK</code> entries
* @param suggests <code>Type.SUGGEST</code> entries
* @param provides <code>Type.PROVIDE</code> entries
*/
public ModDependenciesImpl(Collection<ModDependencies.Entry> depends, Collection<ModDependencies.Entry> breaks, Collection<ModDependencies.Entry> suggests, Collection<ModDependencies.Entry> provides) { public ModDependenciesImpl(Collection<ModDependencies.Entry> depends, Collection<ModDependencies.Entry> breaks, Collection<ModDependencies.Entry> suggests, Collection<ModDependencies.Entry> provides) {
entries.put(Type.DEPEND, depends); entries.put(Type.DEPEND, depends);
entries.put(Type.BREAK, breaks); entries.put(Type.BREAK, breaks);
@ -39,23 +15,11 @@ public final class ModDependenciesImpl implements ModDependencies {
entries.put(Type.PROVIDE, provides); entries.put(Type.PROVIDE, provides);
} }
/**
* Get dependencies of a specific mod for a specific type
*
* @param type the dependency type to query for
* @return a collection of dependency entries
*/
@Override @Override
public Collection<ModDependencies.Entry> getForType(Type type) { public Collection<ModDependencies.Entry> getForType(Type type) {
return entries.get(type); return entries.get(type);
} }
/**
* Get entries that depend on a specific mod's id
*
* @param id the mod id to find dependency entries for
* @return a collection of entries that depend on the given mod id
*/
@Override @Override
public Collection<ModDependencies.Entry> getForModId(String id) { public Collection<ModDependencies.Entry> getForModId(String id) {
List<ModDependencies.Entry> entries = new ArrayList<>(); List<ModDependencies.Entry> entries = new ArrayList<>();