net.sf.freecol.common.io
Class FreeColModFile
java.lang.Object
net.sf.freecol.common.io.FreeColDataFile
net.sf.freecol.common.io.FreeColModFile
- Direct Known Subclasses:
- FreeColTcFile
public class FreeColModFile
- extends FreeColDataFile
A modification.
Methods inherited from class java.lang.Object |
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
FILE_ENDINGS
public static final java.lang.String[] FILE_ENDINGS
FreeColModFile
public FreeColModFile(java.lang.String id)
- Opens the given file for reading.
- Parameters:
id
- The id of the mod to load.
- Throws:
java.io.IOException
- if thrown while opening the file.
FreeColModFile
public FreeColModFile(FreeColModFile.ModInfo mi)
- Opens the given file for reading.
- Parameters:
mi
- An id object.
- Throws:
java.io.IOException
- if thrown while opening the file.
getSpecificationInputStream
public java.io.InputStream getSpecificationInputStream()
throws java.io.IOException
- Gets the input stream to the specification.
- Returns:
- An
InputStream
to the file
"specification.xml" within this data file.
- Throws:
java.io.IOException
- if thrown while opening the
input stream.
getId
public java.lang.String getId()
- Gets the ID of this mod.
- Returns:
- The ID of the mod.
getModInfo
public FreeColModFile.ModInfo getModInfo()