Package org.spongepowered.gradle.vanilla.internal.bundler

Class BundlerMetadata

java.lang.Object

org.spongepowered.gradle.vanilla.internal.bundler.BundlerMetadata

@Immutable
public abstract class BundlerMetadata
extends java.lang.Object

Constructor Summary

Constructors

Constructor	Description
BundlerMetadata()

Method Summary

Modifier and Type	Method	Description
abstract java.util.Set<BundleElement>	libraries()	Libraries packed in the jar as dependencies for the server.
abstract @Nullable java.lang.String	mainClass()	The main class to execute.
static BundlerMetadata	of(FormatVersion version, java.util.Set<BundleElement> libraries, BundleElement server, @Nullable java.lang.String mainClass)
static java.util.Optional<BundlerMetadata>	read(java.nio.file.Path jar)	Attempt to read bundler metadata from a jar.
static java.util.Optional<BundlerMetadata>	read(java.util.jar.JarFile file)	Attempt to read bundler metadata from a jar.
abstract BundleElement	server()	Get a bundle element describing the server itself.
abstract FormatVersion	version()	The bundler format used by this jar.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

BundlerMetadata

public BundlerMetadata()

Method Detail

read

public static java.util.Optional<BundlerMetadata> read(java.nio.file.Path jar)
                                                throws java.io.IOException

Attempt to read bundler metadata from a jar.

If the jar is not a Minecraft bundler jar, an empty Optional will be returned.

Parameters:

jar - the jar to read

Returns:

parsed metadata

Throws:

java.io.IOException - if an error occurs while trying to read from the jar

read

public static java.util.Optional<BundlerMetadata> read(java.util.jar.JarFile file)
                                                throws java.io.IOException

Attempt to read bundler metadata from a jar.

If the jar is not a Minecraft bundler jar, an empty Optional will be returned.

Parameters:

file - the jar to read

Returns:

parsed metadata

Throws:

java.io.IOException - if an error occurs while trying to read from the jar

of

public static BundlerMetadata of(FormatVersion version,
                                 java.util.Set<BundleElement> libraries,
                                 BundleElement server,
                                 @Nullable java.lang.String mainClass)

version

@Parameter
public abstract FormatVersion version()

The bundler format used by this jar.

While VanillaGradle only knows about versions that existed at the time of its release, we will attempt to read future versions as well.

Returns:

the format version

libraries

@Parameter
public abstract java.util.Set<BundleElement> libraries()

Libraries packed in the jar as dependencies for the server.

Returns:

the library elements

server

@Parameter
public abstract BundleElement server()

Get a bundle element describing the server itself.

Returns:

an index entry describing the server

mainClass

@Parameter
public abstract @Nullable java.lang.String mainClass()

The main class to execute.

Returns:

the main class