Project CASUAL
API for CASUAL
 All Classes Namespaces Functions Variables
Public Member Functions | Public Attributes | Static Public Attributes | List of all members
CASUAL.archiving.libpit.PitData Class Reference

Public Member Functions

 PitData ()
 
 PitData (PitInputStream PitStream)
 
 PitData (File pit) throws FileNotFoundException
 
final boolean unpack (PitInputStream pitInputStream)
 
boolean pack (DataOutputStream dataOutputStream)
 
boolean matches (PitData otherPitData)
 
void clear ()
 
PitEntry getEntry (int index)
 
PitEntry findEntry (String partitionName)
 
PitEntry findEntryByFilename (String filename)
 
PitEntry findEntry (int partitionIdentifier)
 
void removeEntry (PitEntry entry)
 
void addEntry (PitEntry entry)
 
int getEntryCount ()
 
char[] getFileType ()
 
char[] getPhone ()
 
String getPITFriendlyName ()
 
String getFileTypeFriendlyName ()
 
String toString ()
 
void resizePartition (String partName, int changeToSize) throws ClassNotFoundException
 
void resizePartition (PitEntry entry, int changeToSize) throws ClassNotFoundException
 
PitEntry[] sortEntriesByBlockLocation ()
 
 PitData ()
 
 PitData (PitInputStream PitStream)
 
 PitData (File pit) throws FileNotFoundException
 
final boolean unpack (PitInputStream pitInputStream)
 
boolean pack (DataOutputStream dataOutputStream)
 
boolean matches (PitData otherPitData)
 
void clear ()
 
PitEntry getEntry (int index)
 
PitEntry findEntry (String partitionName)
 
PitEntry findEntryByFilename (String filename)
 
PitEntry findEntry (int partitionIdentifier)
 
void removeEntry (PitEntry entry)
 
void addEntry (PitEntry entry)
 
int getEntryCount ()
 
char[] getFileType ()
 
char[] getPhone ()
 
String getPITFriendlyName ()
 
String getFileTypeFriendlyName ()
 
String toString ()
 
void resizePartition (String partName, int changeToSize) throws ClassNotFoundException
 
void resizePartition (PitEntry entry, int changeToSize) throws ClassNotFoundException
 
PitEntry[] sortEntriesByBlockLocation ()
 
 PitData ()
 
 PitData (PitInputStream PitStream)
 
 PitData (File pit) throws FileNotFoundException
 
final boolean unpack (PitInputStream pitInputStream)
 
boolean pack (DataOutputStream dataOutputStream)
 
boolean matches (PitData otherPitData)
 
void clear ()
 
PitEntry getEntry (int index)
 
PitEntry findEntry (String partitionName)
 
PitEntry findEntryByFilename (String filename)
 
PitEntry findEntry (int partitionIdentifier)
 
void removeEntry (PitEntry entry)
 
void addEntry (PitEntry entry)
 
int getEntryCount ()
 
char[] getFileType ()
 
char[] getPhone ()
 
String getPITFriendlyName ()
 
String getFileTypeFriendlyName ()
 
String toString ()
 
void resizePartition (String partName, int changeToSize) throws ClassNotFoundException
 
void resizePartition (PitEntry entry, int changeToSize) throws ClassNotFoundException
 
PitEntry[] sortEntriesByBlockLocation ()
 

Public Attributes

int entryCount
 

Static Public Attributes

static final int FILE_IDENTIFIER = 0x12349876
 

Detailed Description

Pitdata provides a way to work with the header information of the PIT file Original Files may be found here: https://github.com/Benjamin-Dobell/libpit–Java-/tree/master/libpit/src/au/com/glassechidna/libpit modified by: Adam Outler

Author
Benjamin Dobell

Constructor & Destructor Documentation

CASUAL.archiving.libpit.PitData.PitData ( )

Constructor for new PIT file.

CASUAL.archiving.libpit.PitData.PitData ( PitInputStream  PitStream)

Constructor to grab PIT file from an InputStream

Parameters
PitStreaminputStream containing a PIT file only
CASUAL.archiving.libpit.PitData.PitData ( File  pit) throws FileNotFoundException

Constructor to grab PIT file from a File

Parameters
pitPIT file
Exceptions
FileNotFoundException
CASUAL.archiving.libpit.PitData.PitData ( )

Constructor for new PIT file.

CASUAL.archiving.libpit.PitData.PitData ( PitInputStream  PitStream)

Constructor to grab PIT file from an InputStream

Parameters
PitStreaminputStream containing a PIT file only
CASUAL.archiving.libpit.PitData.PitData ( File  pit) throws FileNotFoundException

Constructor to grab PIT file from a File

Parameters
pitPIT file
Exceptions
FileNotFoundException
CASUAL.archiving.libpit.PitData.PitData ( )

Constructor for new PIT file.

CASUAL.archiving.libpit.PitData.PitData ( PitInputStream  PitStream)

Constructor to grab PIT file from an InputStream

Parameters
PitStreaminputStream containing a PIT file only
CASUAL.archiving.libpit.PitData.PitData ( File  pit) throws FileNotFoundException

Constructor to grab PIT file from a File

Parameters
pitPIT file
Exceptions
FileNotFoundException

Member Function Documentation

void CASUAL.archiving.libpit.PitData.addEntry ( PitEntry  entry)

Adds a PitEntry to the list of entries

Parameters
entryentry to be added
void CASUAL.archiving.libpit.PitData.addEntry ( PitEntry  entry)

Adds a PitEntry to the list of entries

Parameters
entryentry to be added
void CASUAL.archiving.libpit.PitData.addEntry ( PitEntry  entry)

Adds a PitEntry to the list of entries

Parameters
entryentry to be added
void CASUAL.archiving.libpit.PitData.clear ( )

clears all data in the pit file.

void CASUAL.archiving.libpit.PitData.clear ( )

clears all data in the pit file.

void CASUAL.archiving.libpit.PitData.clear ( )

clears all data in the pit file.

PitEntry CASUAL.archiving.libpit.PitData.findEntry ( String  partitionName)

gets a PitEntry by Partition name

Parameters
partitionNamepartition name to be matched
Returns
PitEntry matched by name
PitEntry CASUAL.archiving.libpit.PitData.findEntry ( String  partitionName)

gets a PitEntry by Partition name

Parameters
partitionNamepartition name to be matched
Returns
PitEntry matched by name
PitEntry CASUAL.archiving.libpit.PitData.findEntry ( String  partitionName)

gets a PitEntry by Partition name

Parameters
partitionNamepartition name to be matched
Returns
PitEntry matched by name
PitEntry CASUAL.archiving.libpit.PitData.findEntry ( int  partitionIdentifier)

Gets a PitEntry based on partition ID

Parameters
partitionIdentifieridentifier to match
Returns
PitEntry matched on PartitionIdentifier
PitEntry CASUAL.archiving.libpit.PitData.findEntry ( int  partitionIdentifier)

Gets a PitEntry based on partition ID

Parameters
partitionIdentifieridentifier to match
Returns
PitEntry matched on PartitionIdentifier
PitEntry CASUAL.archiving.libpit.PitData.findEntry ( int  partitionIdentifier)

Gets a PitEntry based on partition ID

Parameters
partitionIdentifieridentifier to match
Returns
PitEntry matched on PartitionIdentifier
PitEntry CASUAL.archiving.libpit.PitData.findEntryByFilename ( String  filename)

gets a PitEntry by filename

Parameters
filenamefilename in pit entry
Returns
PitEntry matched on filename
PitEntry CASUAL.archiving.libpit.PitData.findEntryByFilename ( String  filename)

gets a PitEntry by filename

Parameters
filenamefilename in pit entry
Returns
PitEntry matched on filename
PitEntry CASUAL.archiving.libpit.PitData.findEntryByFilename ( String  filename)

gets a PitEntry by filename

Parameters
filenamefilename in pit entry
Returns
PitEntry matched on filename
PitEntry CASUAL.archiving.libpit.PitData.getEntry ( int  index)

Gets a PitEntry by index

Parameters
indexindex of entry
Returns
PitEntry at index
PitEntry CASUAL.archiving.libpit.PitData.getEntry ( int  index)

Gets a PitEntry by index

Parameters
indexindex of entry
Returns
PitEntry at index
PitEntry CASUAL.archiving.libpit.PitData.getEntry ( int  index)

Gets a PitEntry by index

Parameters
indexindex of entry
Returns
PitEntry at index
int CASUAL.archiving.libpit.PitData.getEntryCount ( )

gets the number of entries

Returns
entry count
int CASUAL.archiving.libpit.PitData.getEntryCount ( )

gets the number of entries

Returns
entry count
int CASUAL.archiving.libpit.PitData.getEntryCount ( )

gets the number of entries

Returns
entry count
char [] CASUAL.archiving.libpit.PitData.getFileType ( )

returns the file type

Returns
file type
char [] CASUAL.archiving.libpit.PitData.getFileType ( )

returns the file type

Returns
file type
char [] CASUAL.archiving.libpit.PitData.getFileType ( )

returns the file type

Returns
file type
String CASUAL.archiving.libpit.PitData.getFileTypeFriendlyName ( )

returns filetype friendly name with parameters

Returns
File Type friendly name with parameters
String CASUAL.archiving.libpit.PitData.getFileTypeFriendlyName ( )

returns filetype friendly name with parameters

Returns
File Type friendly name with parameters
String CASUAL.archiving.libpit.PitData.getFileTypeFriendlyName ( )

returns filetype friendly name with parameters

Returns
File Type friendly name with parameters
char [] CASUAL.archiving.libpit.PitData.getPhone ( )

gets the name of the intended platform

Returns
platform name
char [] CASUAL.archiving.libpit.PitData.getPhone ( )

gets the name of the intended platform

Returns
platform name
char [] CASUAL.archiving.libpit.PitData.getPhone ( )

gets the name of the intended platform

Returns
platform name
String CASUAL.archiving.libpit.PitData.getPITFriendlyName ( )

returns pit name with parameters

Returns
PIT friendly name with parameters
String CASUAL.archiving.libpit.PitData.getPITFriendlyName ( )

returns pit name with parameters

Returns
PIT friendly name with parameters
String CASUAL.archiving.libpit.PitData.getPITFriendlyName ( )

returns pit name with parameters

Returns
PIT friendly name with parameters
boolean CASUAL.archiving.libpit.PitData.matches ( PitData  otherPitData)

tests for a match on a PitData

Parameters
otherPitDatasecond pit data to be ested
Returns
true if match
boolean CASUAL.archiving.libpit.PitData.matches ( PitData  otherPitData)

tests for a match on a PitData

Parameters
otherPitDatasecond pit data to be ested
Returns
true if match
boolean CASUAL.archiving.libpit.PitData.matches ( PitData  otherPitData)

tests for a match on a PitData

Parameters
otherPitDatasecond pit data to be ested
Returns
true if match
boolean CASUAL.archiving.libpit.PitData.pack ( DataOutputStream  dataOutputStream)

Packs current object into a PIT file

Parameters
dataOutputStreamdataoutputstream to write to
Returns
true if sucessful
boolean CASUAL.archiving.libpit.PitData.pack ( DataOutputStream  dataOutputStream)

Packs current object into a PIT file

Parameters
dataOutputStreamdataoutputstream to write to
Returns
true if sucessful
boolean CASUAL.archiving.libpit.PitData.pack ( DataOutputStream  dataOutputStream)

Packs current object into a PIT file

Parameters
dataOutputStreamdataoutputstream to write to
Returns
true if sucessful
void CASUAL.archiving.libpit.PitData.removeEntry ( PitEntry  entry)

Removes a PitEntry from the list of PitEntries

Parameters
entryentry to be removed
void CASUAL.archiving.libpit.PitData.removeEntry ( PitEntry  entry)

Removes a PitEntry from the list of PitEntries

Parameters
entryentry to be removed
void CASUAL.archiving.libpit.PitData.removeEntry ( PitEntry  entry)

Removes a PitEntry from the list of PitEntries

Parameters
entryentry to be removed
void CASUAL.archiving.libpit.PitData.resizePartition ( String  partName,
int  changeToSize 
) throws ClassNotFoundException

Resizes a pitentry and adjusts starting blocks of all successive pitentries.

Parameters
partNamename of partition to be resized
changeToSizethe amount to change the entry This can be positive or negative and will change the size relatively.
Exceptions
java.lang.ClassNotFoundException
See Also
resizePartition(CASUAL.archiving.libpit.PitEntry, int)
void CASUAL.archiving.libpit.PitData.resizePartition ( String  partName,
int  changeToSize 
) throws ClassNotFoundException

Resizes a pitentry and adjusts starting blocks of all successive pitentries.

Parameters
partNamename of partition to be resized
changeToSizethe amount to change the entry This can be positive or negative and will change the size relatively.
Exceptions
java.lang.ClassNotFoundException
See Also
resizePartition(CASUAL.archiving.libpit.PitEntry, int)
void CASUAL.archiving.libpit.PitData.resizePartition ( String  partName,
int  changeToSize 
) throws ClassNotFoundException

Resizes a pitentry and adjusts starting blocks of all successive pitentries.

Parameters
partNamename of partition to be resized
changeToSizethe amount to change the entry This can be positive or negative and will change the size relatively.
Exceptions
java.lang.ClassNotFoundException
See Also
resizePartition(CASUAL.archiving.libpit.PitEntry, int)
void CASUAL.archiving.libpit.PitData.resizePartition ( PitEntry  entry,
int  changeToSize 
) throws ClassNotFoundException

Resizes a pitentry and adjusts starting blocks of all successive pitentries.

Parameters
entryThe entry to be resized
changeToSizethe amount to change the entry This can be positive or negative and will change the size relatively.
Exceptions
java.lang.ClassNotFoundException
void CASUAL.archiving.libpit.PitData.resizePartition ( PitEntry  entry,
int  changeToSize 
) throws ClassNotFoundException

Resizes a pitentry and adjusts starting blocks of all successive pitentries.

Parameters
entryThe entry to be resized
changeToSizethe amount to change the entry This can be positive or negative and will change the size relatively.
Exceptions
java.lang.ClassNotFoundException
void CASUAL.archiving.libpit.PitData.resizePartition ( PitEntry  entry,
int  changeToSize 
) throws ClassNotFoundException

Resizes a pitentry and adjusts starting blocks of all successive pitentries.

Parameters
entryThe entry to be resized
changeToSizethe amount to change the entry This can be positive or negative and will change the size relatively.
Exceptions
java.lang.ClassNotFoundException
PitEntry [] CASUAL.archiving.libpit.PitData.sortEntriesByBlockLocation ( )

returns an array of the PitEntries sorted by block location

Returns
sorted PitEntries
PitEntry [] CASUAL.archiving.libpit.PitData.sortEntriesByBlockLocation ( )

returns an array of the PitEntries sorted by block location

Returns
sorted PitEntries
PitEntry [] CASUAL.archiving.libpit.PitData.sortEntriesByBlockLocation ( )

returns an array of the PitEntries sorted by block location

Returns
sorted PitEntries
final boolean CASUAL.archiving.libpit.PitData.unpack ( PitInputStream  pitInputStream)

unpacks a PIT into the PitData and its PitEntry classes

Parameters
pitInputStreamInputStream containing only a Pit FIle
Returns
true if unpack was performed
final boolean CASUAL.archiving.libpit.PitData.unpack ( PitInputStream  pitInputStream)

unpacks a PIT into the PitData and its PitEntry classes

Parameters
pitInputStreamInputStream containing only a Pit FIle
Returns
true if unpack was performed
final boolean CASUAL.archiving.libpit.PitData.unpack ( PitInputStream  pitInputStream)

unpacks a PIT into the PitData and its PitEntry classes

Parameters
pitInputStreamInputStream containing only a Pit FIle
Returns
true if unpack was performed

Member Data Documentation

int CASUAL.archiving.libpit.PitData.entryCount

number of entries available to be read.

static final int CASUAL.archiving.libpit.PitData.FILE_IDENTIFIER = 0x12349876
static

Magic Number to identify an Odin File.


The documentation for this class was generated from the following file: