net.neoforged.binarypatcher

Class PatchBundleReader

java.lang.Object

net.neoforged.binarypatcher.PatchBundleReader

All Implemented Interfaces:

java.lang.AutoCloseable, java.lang.Iterable<Patch>

public class PatchBundleReader
extends java.lang.Object
implements java.lang.Iterable<Patch>, java.lang.AutoCloseable

Reader for binary patch bundle files. Usage: 1. Create reader with input stream 2. Inspect getTargetDistributions() and getEntryCount() 3. Iterate through entries using the iterator

Constructor Summary

Constructors

Constructor and Description
PatchBundleReader(java.io.File file)
PatchBundleReader(java.io.InputStream input)

Method Summary

Modifier and Type	Method and Description
void	close()
int	getEntriesRead() Returns the number of entries that have been read so far.
int	getEntryCount() Returns the total number of entries in the bundle.
java.util.EnumSet<PatchBase>	getSupportedBaseTypes() Returns the target distributions declared in the bundle header.
boolean	hasMoreEntries() Returns true if all entries have been read.
java.util.Iterator<Patch>	iterator()
Patch	readEntry() Read the next entry from the bundle.

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Constructor Detail

PatchBundleReader

public PatchBundleReader(java.io.File file)
                  throws java.io.IOException

Throws:

java.io.IOException

PatchBundleReader

public PatchBundleReader(java.io.InputStream input)
                  throws java.io.IOException

Throws:

java.io.IOException

Method Detail

getSupportedBaseTypes

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

Returns the target distributions declared in the bundle header.

getEntryCount

public int getEntryCount()

Returns the total number of entries in the bundle.

getEntriesRead

public int getEntriesRead()

Returns the number of entries that have been read so far.

hasMoreEntries

public boolean hasMoreEntries()

Returns true if all entries have been read.

iterator

public java.util.Iterator<Patch> iterator()

Specified by:

iterator in interface java.lang.Iterable<Patch>

readEntry

public Patch readEntry()
                throws java.io.IOException

Read the next entry from the bundle.

Returns:

the next entry, or null if all entries have been read

Throws:

java.io.IOException

close

public void close()
           throws java.io.IOException

Specified by:

close in interface java.lang.AutoCloseable

Throws:

java.io.IOException