net.neoforged.binarypatcher

Class Patch

java.lang.Object

net.neoforged.binarypatcher.Patch

public class Patch
extends java.lang.Object

Represents a single entry in the patch bundle.

Method Summary

Modifier and Type	Method and Description
static long	checksum(byte[] input)
static Patch	createAdd(java.lang.String targetPath, byte[] patchedData, java.util.EnumSet<PatchBase> bases)
static Patch	createModified(java.lang.String targetPath, byte[] baseData, byte[] patchedData, java.util.EnumSet<PatchBase> bases, DiffOptions options)
static Patch	createRemove(java.lang.String targetPath, java.util.EnumSet<PatchBase> bases)
static void	from(java.lang.String targetPath, java.util.EnumMap<PatchBase,byte[]> baseData, byte[] patchedData, DiffOptions options, java.util.function.Consumer<Patch> consumer)
long	getBaseChecksum() Checksum for the base file of the patch.
long	getBaseChecksumUnsigned() Returns the base checksum as an unsigned long value.
java.util.EnumSet<PatchBase>	getBaseTypes()
byte[]	getData() Returns the entry data.
PatchOperation	getOperation()
java.lang.String	getTargetPath()

Methods inherited from class java.lang.Object

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

Method Detail

getOperation

public PatchOperation getOperation()

getTargetPath

public java.lang.String getTargetPath()

getBaseTypes

public java.util.EnumSet<PatchBase> getBaseTypes()

getBaseChecksum

public long getBaseChecksum()

Checksum for the base file of the patch.

Only available for entries where getOperation() is PatchOperation.MODIFY. Otherwise, the value is -1.

Returns:

The base files checksum, or -1 if not available.

getData

public byte[] getData()

Returns the entry data. For CREATE entries, this is the file content. For MODIFY entries, this is the xdelta patch data. For REMOVE entries, this is an empty array.

getBaseChecksumUnsigned

public long getBaseChecksumUnsigned()

Returns the base checksum as an unsigned long value. Only valid for MODIFY entries.

from

public static void from(java.lang.String targetPath,
                        java.util.EnumMap<PatchBase,byte[]> baseData,
                        byte[] patchedData,
                        DiffOptions options,
                        java.util.function.Consumer<Patch> consumer)
                 throws java.io.IOException

Parameters:

baseData - Null values indicate that the patch base did not contain the target path.

patchedData - Null indicates the target path has been removed from the patched jar.

Throws:

java.io.IOException

createAdd

public static Patch createAdd(java.lang.String targetPath,
                              byte[] patchedData,
                              java.util.EnumSet<PatchBase> bases)

createRemove

public static Patch createRemove(java.lang.String targetPath,
                                 java.util.EnumSet<PatchBase> bases)

createModified

public static Patch createModified(java.lang.String targetPath,
                                   byte[] baseData,
                                   byte[] patchedData,
                                   java.util.EnumSet<PatchBase> bases,
                                   DiffOptions options)
                            throws java.io.IOException

Throws:

java.io.IOException

checksum

public static long checksum(byte[] input)