Class WadBuffer

java.lang.Object

net.mtrop.doom.WadBuffer

All Implemented Interfaces:

Iterable<WadEntry>, Wad

public class WadBuffer
extends Object
implements Wad

An implementation of Wad where any and all WAD information is manipulated in memory. This loads everything in the WAD into memory as uninterpreted raw bytes.

WadBuffer operations are not thread-safe!

Author:

Matthew Tropiano

Nested Class Summary

Nested classes/interfaces inherited from interface net.mtrop.doom.Wad

Wad.Type

Field Summary

Fields

Modifier and Type	Field	Description
static final int	DEFAULT_CAPACITY	The default internal capacity of the WadBuffer in bytes.
static final int	DEFAULT_CAPACITY_INCREMENT	Default capacity increment for the buffer (doubles every resize).

Fields inherited from interface net.mtrop.doom.Wad

NO_DATA, NO_ENTRIES

Constructor Summary

Constructors

Constructor	Description
WadBuffer()	Creates an empty WadBuffer (as a PWAD).
WadBuffer(int capacity)	Creates an empty WadBuffer (as a PWAD).
WadBuffer(int capacity, int capacityIncrement)	Creates an empty WadBuffer (as a PWAD).
WadBuffer(File f)	Creates a new WadBuffer using the contents of a file.
WadBuffer(InputStream in)	Creates a new WadBuffer.
WadBuffer(String path)	Creates a new WadBuffer using the contents of a file, denoted by the path.
WadBuffer(Wad.Type type)	Creates an empty WadBuffer with a specific type.
WadBuffer(Wad.Type type, int capacity)	Creates an empty WadBuffer with a specific type.
WadBuffer(Wad.Type type, int capacity, int capacityIncrement)	Creates an empty WadBuffer with a specific type.

Method Summary

Modifier and Type	Method	Description
WadEntry	addDataAt(int index, String entryName, InputStream in, int maxLength)	Adds data to this Wad at a particular entry offset, using entryName as the name of the entry.
WadEntry	addEntryAt(int index, WadEntry entry)	Adds a new entry to the Wad.
void	close()	Closes this Wad.
WadEntry	deleteEntry(int n)	Deletes a Wad's entry and its contents.
static WadBuffer	extract(Wad source, int startIndex, int maxLength)	Creates a new WadBuffer from a subset of entries (and their data) from another Wad.
static WadBuffer	extract(Wad source, WadEntry... entries)	Creates a new WadBuffer from a subset of entries (and their data) from another Wad.
void	fetchContent(int offset, int length, byte[] dest, int destOffset)	Fetches a series of bytes from an arbitrary place in the Wad and puts them into a provided array.
int	getCapacity()	Gets the capacity of this buffer.
int	getCapacityIncrement()	Returns the capacity increment value.
int	getContentLength()
WadEntry	getEntry(int n)	Gets the WadEntry at index n.
int	getEntryCount()
InputStream	getInputStream(WadEntry entry)	Retrieves the data of the specified entry from a starting index and returns it as a stream.
final Wad.Type	getType()	Gets the type of WAD that this is.
boolean	isIWAD()	Checks if this WAD is an Internal WAD.
boolean	isPWAD()	Checks if this WAD is a Patch WAD.
Iterator<WadEntry>	iterator()
WadEntry	removeEntry(int n)	Remove a Wad's entry (but not contents).
void	renameEntry(int index, String newName)	Renames the entry at an index in the Wad.
void	replaceEntry(int index, byte[] data)	Replaces the entry at an index in the Wad.
void	setCapacityIncrement(int capacityIncrement)	Sets the capacity increment value.
void	setEntries(WadEntry... entryList)	Completely replaces the list of entries in this Wad with a completely different set of entries.
final void	setType(Wad.Type type)	Sets the type of WAD that this is.
void	unmapEntries(int startIndex, WadEntry... entryList)	Replaces a series of WadEntry objects in this Wad, using the provided list of entries as the replacement list.
final void	writeToFile(File path)	Writes the contents of this buffer out to a file in Wad format.
final void	writeToFile(String path)	Writes the contents of this buffer out to a file in Wad format.
final void	writeToStream(OutputStream out)	Writes the contents of this buffer out to an output stream in Wad format.

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

Methods inherited from interface net.mtrop.doom.Wad

addData, addData, addData, addData, addData, addData, addData, addDataAt, addDataAt, addDataAt, addDataAt, addDataAt, addDataAt, addEntry, addEntry, addEntryAt, addFrom, addFrom, addFromAt, addFromAt, addMarker, addMarkerAt, contains, contains, contains, fetchData, fetchData, fetchData, fetchData, fetchData, getAllEntries, getAllEntries, getAllEntryIndices, getContent, getData, getData, getData, getData, getData, getDataAs, getDataAs, getDataAs, getDataAs, getDataAs, getDataAs, getDataAs, getDataAs, getDataAs, getDataAs, getDataAsList, getDataAsList, getDataAsList, getDataAsList, getDataAsList, getEntry, getEntry, getEntry, getInlineScanner, getInlineScanner, getInlineScanner, getInlineScanner, getInlineScanner, getInputStream, getInputStream, getInputStream, getInputStream, getLastEntry, getNthEntry, getReader, getReader, getReader, getReader, getReader, getScanner, getScanner, getScanner, getScanner, getScanner, getTextData, getTextData, getTextData, getTextData, getTextData, getTextDataAs, getTextDataAs, getTextDataAs, getTextDataAs, getTextDataAs, indexOf, indexOf, indexOf, lastIndexOf, mapEntries, replaceEntry, replaceEntry, replaceEntry, setEntry, transformData, transformData, transformData, transformData, transformData, transformData, transformData, transformData, transformTextData, transformTextData, transformTextData, transformTextData

Field Details

DEFAULT_CAPACITY

public static final int DEFAULT_CAPACITY

The default internal capacity of the WadBuffer in bytes.

See Also:

• Constant Field Values

DEFAULT_CAPACITY_INCREMENT

public static final int DEFAULT_CAPACITY_INCREMENT

Default capacity increment for the buffer (doubles every resize).

See Also:

• Constant Field Values

Constructor Details

WadBuffer

public WadBuffer()

Creates an empty WadBuffer (as a PWAD).

WadBuffer

public WadBuffer(int capacity)

Creates an empty WadBuffer (as a PWAD).

Parameters:

capacity - the initial capacity of the buffer in bytes.

Since:

2.15.0

WadBuffer

public WadBuffer(int capacity,
 int capacityIncrement)

Creates an empty WadBuffer (as a PWAD).

Parameters:

capacity - the initial capacity of the buffer in bytes.

capacityIncrement - the capacity increment in bytes to grow the buffer. 0 or less will double the buffer's size.

Since:

2.15.0

WadBuffer

public WadBuffer(Wad.Type type)

Creates an empty WadBuffer with a specific type.

Parameters:

type - the type to set.

WadBuffer

public WadBuffer(Wad.Type type,
 int capacity)

Creates an empty WadBuffer with a specific type.

Parameters:

type - the type to set.

capacity - the initial capacity of the buffer in bytes.

Since:

2.15.0

WadBuffer

public WadBuffer(Wad.Type type,
 int capacity,
 int capacityIncrement)

Creates an empty WadBuffer with a specific type.

Parameters:

type - the type to set.

capacity - the initial capacity of the buffer in bytes.

capacityIncrement - the capacity increment in bytes to grow the buffer. 0 or less will double the buffer's size.

Since:

2.15.0

WadBuffer

public WadBuffer(String path)
          throws IOException

Creates a new WadBuffer using the contents of a file, denoted by the path.

Parameters:

path - the path to the file to read.

Throws:

IOException - if the file can't be read.

FileNotFoundException - if the file can't be found.

SecurityException - if you don't have permission to access the file.

WadException - if the file isn't a Wad file.

NullPointerException - if path is null.

WadBuffer

public WadBuffer(File f)
          throws IOException

Creates a new WadBuffer using the contents of a file.

Parameters:

f - the file to read.

Throws:

IOException - if the file can't be read.

FileNotFoundException - if the file can't be found.

SecurityException - if you don't have permission to access the file.

WadException - if the file isn't a Wad file.

NullPointerException - if path is null.

WadBuffer

public WadBuffer(InputStream in)
          throws IOException

Creates a new WadBuffer.

Parameters:

in - the input stream.

Throws:

IOException - if the file can't be read.

WadException - if the stream contents are not a Wad file.

NullPointerException - if path is null.

Method Details

extract

public static WadBuffer extract(Wad source,
 int startIndex,
 int maxLength)
                         throws IOException

Creates a new WadBuffer from a subset of entries (and their data) from another Wad.

Parameters:

source - the the source Wad.

startIndex - the starting entry index.

maxLength - the maximum amount of entries from the starting index to copy.

Returns:

a new WadBuffer that only contains the desired entries, plus their data.

Throws:

IOException - if an error occurs on read from the source Wad.

Since:

2.1.0

extract

public static WadBuffer extract(Wad source,
 WadEntry... entries)
                         throws IOException

Creates a new WadBuffer from a subset of entries (and their data) from another Wad.

Parameters:

source - the the source Wad.

entries - the entries to copy over.

Returns:

a new WadBuffer that only contains the desired entries, plus their data.

Throws:

IOException - if an error occurs on read from the source Wad.

Since:

2.1.0

setType

public final void setType(Wad.Type type)

Sets the type of WAD that this is.

Parameters:

type - the new type.

getType

public final Wad.Type getType()

Gets the type of WAD that this is.

Returns:

the wad type.

getCapacity

public int getCapacity()

Gets the capacity of this buffer.

Returns:

the current capacity in bytes.

Since:

2.15.0

getCapacityIncrement

public int getCapacityIncrement()

Returns the capacity increment value.

Returns:

the current capacity increment in bytes (or a value of 0 or less if it doubles).

Since:

2.15.0

setCapacityIncrement

public void setCapacityIncrement(int capacityIncrement)

Sets the capacity increment value.

Parameters:

capacityIncrement - what to increase the capacity of this buffer by (in bytes) if this reaches the max. if 0 or less, it will double.

Since:

2.15.0

writeToFile

public final void writeToFile(String path)
                       throws IOException

Writes the contents of this buffer out to a file in Wad format. The target file will be overwritten.

Parameters:

path - the file path to write to.

Throws:

IOException - if a problem occurs during the write.

SecurityException - if you don't have permission to write the file.

NullPointerException - if out is null.

Since:

2.6.0

writeToFile

public final void writeToFile(File path)
                       throws IOException

Writes the contents of this buffer out to a file in Wad format. The target file will be overwritten.

Parameters:

path - the file to write to.

Throws:

IOException - if a problem occurs during the write.

SecurityException - if you don't have permission to write the file.

NullPointerException - if out is null.

writeToStream

public final void writeToStream(OutputStream out)
                         throws IOException

Writes the contents of this buffer out to an output stream in Wad format. Does not close the stream.

Parameters:

out - the output stream to write to.

Throws:

IOException - if a problem occurs during the write.

NullPointerException - if out is null.

getContentLength

public int getContentLength()

Specified by:

getContentLength in interface Wad

Returns:

the amount of content data in this Wad in bytes.

isIWAD

public boolean isIWAD()

Description copied from interface: Wad

Checks if this WAD is an Internal WAD.

Specified by:

isIWAD in interface Wad

Returns:

true if so, false if not.

isPWAD

public boolean isPWAD()

Description copied from interface: Wad

Checks if this WAD is a Patch WAD.

Specified by:

isPWAD in interface Wad

Returns:

true if so, false if not.

getEntryCount

public int getEntryCount()

Specified by:

getEntryCount in interface Wad

Returns:

the number of entries in this Wad.

getEntry

public WadEntry getEntry(int n)

Description copied from interface: Wad

Gets the WadEntry at index n.

Specified by:

getEntry in interface Wad

Parameters:

n - the index of the entry in the entry list.

Returns:

the entry at n.

fetchContent

public void fetchContent(int offset,
 int length,
 byte[] dest,
 int destOffset)
                  throws IOException

Description copied from interface: Wad

Fetches a series of bytes from an arbitrary place in the Wad and puts them into a provided array. This is will attempt to get the full provided length, throwing an exception if it does not.

Specified by:

fetchContent in interface Wad

Parameters:

offset - the offset byte into that data to start at.

length - the amount of bytes to fetch.

dest - the destination array of bytes.

destOffset - the offset into the destination array to put the bytes into.

Throws:

IOException - if an error occurs during read.

getInputStream

public InputStream getInputStream(WadEntry entry)
                           throws IOException

Description copied from interface: Wad

Retrieves the data of the specified entry from a starting index and returns it as a stream.

Specified by:

getInputStream in interface Wad

Parameters:

entry - the entry to use.

Returns:

an open input stream of the data.

Throws:

IOException - if the data couldn't be retrieved or the entry's offsets breach the file extents.

removeEntry

public WadEntry removeEntry(int n)
                     throws IOException

Description copied from interface: Wad

Remove a Wad's entry (but not contents). This will leave abandoned, un-addressed data in a Wad file and will not be removed until the data is purged.

Specified by:

removeEntry in interface Wad

Parameters:

n - the index of the entry to delete.

Returns:

the entry removed from the Wad.

Throws:

IOException - if the entry cannot be removed.

deleteEntry

public WadEntry deleteEntry(int n)
                     throws IOException

Description copied from interface: Wad

Deletes a Wad's entry and its contents. The overhead for multiple deletions may be expensive I/O-wise.

Specified by:

deleteEntry in interface Wad

Parameters:

n - the index of the entry to delete.

Returns:

the entry deleted.

Throws:

IOException - if the entry cannot be deleted.

renameEntry

public void renameEntry(int index,
 String newName)
                 throws IOException

Description copied from interface: Wad

Renames the entry at an index in the Wad.

Specified by:

renameEntry in interface Wad

Parameters:

index - the index of the entry to rename.

newName - the new name of the entry.

Throws:

IOException - if the entry cannot be renamed.

replaceEntry

public void replaceEntry(int index,
 byte[] data)
                  throws IOException

Description copied from interface: Wad

Replaces the entry at an index in the Wad. If the incoming data is the same size as the entry at the index, this will change the data in-place without deleting and adding.

Specified by:

replaceEntry in interface Wad

Parameters:

index - the index of the entry to replace.

data - the data to replace the entry with.

Throws:

IOException - if the entry cannot be replaced.

unmapEntries

public void unmapEntries(int startIndex,
 WadEntry... entryList)
                  throws IOException

Description copied from interface: Wad

Replaces a series of WadEntry objects in this Wad, using the provided list of entries as the replacement list. If the list of entries plus the starting index would breach the original list of entries, the excess is appended to the Wad.

Specified by:

unmapEntries in interface Wad

Parameters:

startIndex - the starting index to replace from (inclusive).

entryList - the set of entries to replace (in order) from the starting index.

Throws:

IOException - if the entries could not be written.

setEntries

public void setEntries(WadEntry... entryList)
                throws IOException

Description copied from interface: Wad

Completely replaces the list of entries in this Wad with a completely different set of entries.

Specified by:

setEntries in interface Wad

Parameters:

entryList - the set of entries that will make up this Wad.

Throws:

IOException - if the entries could not be written.

addEntryAt

public WadEntry addEntryAt(int index,
 WadEntry entry)
                    throws IOException

Description copied from interface: Wad

Adds a new entry to the Wad. Exercise caution with this method, as this entry is added as-is, and an entry can reference anywhere in the Wad!

Specified by:

addEntryAt in interface Wad

Parameters:

index - the index at which to add the entry.

entry - the entry to add.

Returns:

the entry added.

Throws:

IOException - if the entry cannot be written.

addDataAt

public WadEntry addDataAt(int index,
 String entryName,
 InputStream in,
 int maxLength)
                   throws IOException

Description copied from interface: Wad

Adds data to this Wad at a particular entry offset, using entryName as the name of the entry. The provided input stream is read until the end of the stream is reached or maxLength bytes are read. The input stream is NOT CLOSED, afterward. The rest of the entries in the wad are shifted down one index. The overhead for multiple individual additions may be expensive I/O-wise depending on the Wad implementation.

Specified by:

addDataAt in interface Wad

Parameters:

index - the index at which to add the entry.

entryName - the name of the entry to add this as.

in - the input stream to read.

maxLength - the maximum amount of bytes to read from the InputStream, or a value < 0 to keep reading until end-of-stream.

Returns:

a WadEntry that describes the added data.

Throws:

IOException - if the data cannot be written or the stream could not be read.

iterator

public Iterator<WadEntry> iterator()

Specified by:

iterator in interface Iterable<WadEntry>

close

public void close()
           throws IOException

Description copied from interface: Wad

Closes this Wad. Does nothing on some implementations.

Specified by:

close in interface Wad

Throws:

IOException - if an error occurred during close.