net.neoforged.binarypatcher

Class PatchBundleWriter

java.lang.Object

net.neoforged.binarypatcher.PatchBundleWriter

All Implemented Interfaces:

java.lang.AutoCloseable

public class PatchBundleWriter
extends java.lang.Object
implements java.lang.AutoCloseable

Writer for binary patch bundle files. Usage: 1. Create writer with output stream and target distributions 2. Write entries using writeCreateEntry, writeModifyEntry, or writeRemoveEntry 3. Call finish() to finalize the bundle

Constructor Summary

Constructors

Constructor and Description
PatchBundleWriter(java.io.OutputStream output, java.util.Set<PatchBase> bundleDistributions)

Method Summary

Modifier and Type	Method and Description
void	close()
void	write(Patch patch)
void	writeCreateEntry(java.lang.String targetPath, byte[] fileContent, java.util.EnumSet<PatchBase> entryDistributions) Write an entry that creates a new file.
void	writeModifyEntry(java.lang.String targetPath, long baseChecksum, byte[] patchData, java.util.EnumSet<PatchBase> entryDistributions) Write an entry that modifies an existing file using a patch.
void	writeRemoveEntry(java.lang.String targetPath, java.util.EnumSet<PatchBase> entryDistributions) Write an entry that removes a file.

Methods inherited from class java.lang.Object

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

Constructor Detail

PatchBundleWriter

public PatchBundleWriter(java.io.OutputStream output,
                         java.util.Set<PatchBase> bundleDistributions)

Method Detail

writeCreateEntry

public void writeCreateEntry(java.lang.String targetPath,
                             byte[] fileContent,
                             java.util.EnumSet<PatchBase> entryDistributions)
                      throws java.io.IOException

Write an entry that creates a new file.

Throws:

java.io.IOException

writeModifyEntry

public void writeModifyEntry(java.lang.String targetPath,
                             long baseChecksum,
                             byte[] patchData,
                             java.util.EnumSet<PatchBase> entryDistributions)
                      throws java.io.IOException

Write an entry that modifies an existing file using a patch.

Throws:

java.io.IOException

writeRemoveEntry

public void writeRemoveEntry(java.lang.String targetPath,
                             java.util.EnumSet<PatchBase> entryDistributions)
                      throws java.io.IOException

Write an entry that removes a file.

Throws:

java.io.IOException

write

public void write(Patch patch)
           throws java.io.IOException

Throws:

java.io.IOException

close

public void close()
           throws java.io.IOException

Specified by:

close in interface java.lang.AutoCloseable

Throws:

java.io.IOException