systems.crigges.jmpq3

Class JMpqEditor

java.lang.Object

systems.crigges.jmpq3.JMpqEditor

All Implemented Interfaces:

java.lang.AutoCloseable

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

The Class JMpqEditor.

Constructor Summary

Constructors

Constructor and Description
JMpqEditor(java.io.File mpqW) Creates a new editor by parsing an exisiting mpq.

Method Summary

Modifier and Type	Method and Description
void	close()
void	deleteFile(java.lang.String name) Deletes the specified file out of the mpq once you rebuild the mpq.
void	extractAllFiles(java.io.File dest) Extract all files.
void	extractFile(java.lang.String name, java.io.File dest) Extracts the specified file out of the mpq to the target location.
void	extractFile(java.lang.String name, java.io.OutputStream dest) Extracts the specified file out of the mpq and writes it to the target outputstream.
java.util.List<java.lang.String>	getFileNames() Gets the file names.
MpqFile	getMpqFile(java.lang.String name) Gets the mpq file.
int	getTotalFileCount() Gets the total file count.
boolean	hasFile(java.lang.String name) Checks for file.
void	insertFile(java.lang.String name, java.io.File f, boolean backupFile) Inserts the specified file into the mpq once you close the editor.
void	printHeader() Prints the header.
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

JMpqEditor

public JMpqEditor(java.io.File mpqW)
           throws JMpqException

Creates a new editor by parsing an exisiting mpq.

Parameters:

mpqW - the mpq w

Throws:

JMpqException - if mpq is damaged or not supported

Method Detail

printHeader

public void printHeader()

Prints the header.

extractAllFiles

public void extractAllFiles(java.io.File dest)
                     throws JMpqException

Extract all files.

Parameters:

dest - the dest

Throws:

JMpqException - the j mpq exception

getTotalFileCount

public int getTotalFileCount()
                      throws JMpqException

Gets the total file count.

Returns:

the total file count

Throws:

JMpqException - the j mpq exception

extractFile

public void extractFile(java.lang.String name,
                        java.io.File dest)
                 throws JMpqException

Extracts the specified file out of the mpq to the target location.

Parameters:

name - name of the file

dest - destination to that the files content is written

Throws:

JMpqException - if file is not found or access errors occur

hasFile

public boolean hasFile(java.lang.String name)

Checks for file.

Parameters:

name - the name

Returns:

true, if successful

getFileNames

public java.util.List<java.lang.String> getFileNames()

Gets the file names.

Returns:

the file names

extractFile

public void extractFile(java.lang.String name,
                        java.io.OutputStream dest)
                 throws JMpqException

Extracts the specified file out of the mpq and writes it to the target outputstream.

Parameters:

name - name of the file

dest - the outputstream where the file's content is written

Throws:

JMpqException - if file is not found or access errors occur

getMpqFile

public MpqFile getMpqFile(java.lang.String name)
                   throws java.io.IOException

Gets the mpq file.

Parameters:

name - the name

Returns:

the mpq file

Throws:

java.io.IOException - Signals that an I/O exception has occurred.

deleteFile

public void deleteFile(java.lang.String name)
                throws JMpqException

Deletes the specified file out of the mpq once you rebuild the mpq.

Parameters:

name - of the file

Throws:

JMpqException - if file is not found or access errors occur

insertFile

public void insertFile(java.lang.String name,
                       java.io.File f,
                       boolean backupFile)
                throws JMpqException

Inserts the specified file into the mpq once you close the editor.

Parameters:

name - of the file

f - the f

backupFile - if true the editors creates a copy of the file to add, so further changes won't affect the resulting mpq

Throws:

JMpqException - if file is not found or access errors occur

close

public void close()
           throws java.io.IOException

Specified by:

close in interface java.lang.AutoCloseable

Throws:

java.io.IOException

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object