Package io.github.smootheez.curseforge

Enum Class RelationType

java.lang.Object

java.lang.Enum<RelationType>

io.github.smootheez.curseforge.RelationType

All Implemented Interfaces:

Serializable, Comparable<RelationType>, Constable

public enum RelationType
extends Enum<RelationType>

Defines the possible relationship types between a project and another referenced project or resource. These values are typically used when declaring dependencies or associations in metadata structures.

Each enum constant is annotated with SerializedName to ensure correct JSON mapping when serializing or deserializing metadata.

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
EMBEDDED_LIBRARY	Indicates that the referenced project is bundled directly inside this project as an embedded library.
INCOMPATIBLE	Indicates that the referenced project conflicts with this one.
OPTIONAL_DEPENDENCY	Indicates that the referenced project is an optional dependency.
REQUIRED_DEPENDENCY	Indicates that the referenced project is a required dependency.
TOOL	Indicates that the referenced project is a tool or utility associated with this project, typically not a runtime dependency.

Method Summary

Modifier and Type	Method	Description
static RelationType	valueOf(String name)	Returns the enum constant of this class with the specified name.
static RelationType[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

EMBEDDED_LIBRARY

@SerializedName("embeddedLibrary")
public static final RelationType EMBEDDED_LIBRARY

Indicates that the referenced project is bundled directly inside this project as an embedded library. It is not downloaded separately.

INCOMPATIBLE

@SerializedName("incompatible")
public static final RelationType INCOMPATIBLE

Indicates that the referenced project conflicts with this one. Both cannot be installed or used together.

OPTIONAL_DEPENDENCY

@SerializedName("optionalDependency")
public static final RelationType OPTIONAL_DEPENDENCY

Indicates that the referenced project is an optional dependency. The project can function without it, but may provide additional features when present.

REQUIRED_DEPENDENCY

@SerializedName("requiredDependency")
public static final RelationType REQUIRED_DEPENDENCY

Indicates that the referenced project is a required dependency. This project cannot function without it.

TOOL

@SerializedName("tool")
public static final RelationType TOOL

Indicates that the referenced project is a tool or utility associated with this project, typically not a runtime dependency.

Method Details

values

public static RelationType[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

an array containing the constants of this enum class, in the order they are declared

valueOf

public static RelationType valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum class has no constant with the specified name

NullPointerException - if the argument is null