diff --git a/docs/allclasses-index.html b/docs/allclasses-index.html index 35fb53f..b4eafb7 100644 --- a/docs/allclasses-index.html +++ b/docs/allclasses-index.html @@ -2,7 +2,7 @@ - + All Classes @@ -95,7 +95,7 @@ $('.navPadding').css('padding-top', $('.fixedNav').css("height")); ChopJob -
A Job that converts regular files into chopped (*.chp + *.cXX) files.
+
A Job to convert a file into one or more chopped (*.chp + *.cXX) files.
@@ -107,7 +107,7 @@ $('.navPadding').css('padding-top', $('.fixedNav').css("height")); ChpFileError -
An error in the parsing of the .chp file occoured.
+
An error occoured during the parsing of a .chp file.
@@ -189,7 +189,7 @@ $('.navPadding').css('padding-top', $('.fixedNav').css("height")); DeflateConfig -
A IConfig for compressing a file with the Deflate algorithm.
+
A ICompressConfig requesting a compression with the Deflate algorithm.
@@ -225,31 +225,32 @@ $('.navPadding').css('padding-top', $('.fixedNav').css("height")); ICompressConfig -
A IConfig for the Compress step of the Chop/Stitch process.
+
A IConfig generated by a CompressRow.
IConfig -
An interface for the configuration of a step of a Job.
+
A configuration generated by a OptionRow to configure a step of a + ChopJob.
ICryptConfig -
A IConfig for the Crypt step of the Chop/Stitch process.
+
A IConfig generated by a CryptRow.
ISplitConfig -
A IConfig for the Split step of the Chop/Stitch process.
+
A IConfig generated by a SplitRow.
Job -
A Thread that allows access to the basic .
+
A task that can be executed by Cleaver in a separate Thread, and that keeps track of its progress and can display progress updates on a Swing GUI.
@@ -291,19 +292,19 @@ $('.navPadding').css('padding-top', $('.fixedNav').css("height")); PartsConfig -
A IConfig for splitting a file in a specific number of parts.
+
A ISplitConfig requesting the split of a file in a specific number of PartsConfig.parts.
PasswordConfig -
A config for encrypting a file with an arbitrary length password.
+
A ICryptConfig requesting the encryption of a file using a specific PasswordConfig.password.
ProgrammingError -
An exception that should never be thrown during the execution of the program.
+
An exception that is never supposed to happen during the execution of the program.
@@ -325,7 +326,7 @@ $('.navPadding').css('padding-top', $('.fixedNav').css("height")); SizeConfig -
A IConfig for splitting a file in parts of a specific part size.
+
A ISplitConfig requesting the split of a file in parts of a specific size.
diff --git a/docs/allpackages-index.html b/docs/allpackages-index.html index 596b3eb..5d0632f 100644 --- a/docs/allpackages-index.html +++ b/docs/allpackages-index.html @@ -2,7 +2,7 @@ - + All Packages @@ -88,7 +88,7 @@ $('.navPadding').css('padding-top', $('.fixedNav').css("height")); eu.steffo.cleaver.errors -
A package containing all possible exceptions thrown by Cleaver.
+
A package containing all possible Errors and Exceptions thrown by Cleaver.
@@ -117,7 +117,10 @@ $('.navPadding').css('padding-top', $('.fixedNav').css("height")); eu.steffo.cleaver.logic.config -  + +
A package containing all possible IConfigs used to configure + ChopJobs.
+ eu.steffo.cleaver.logic.job diff --git a/docs/constant-values.html b/docs/constant-values.html index 52e90ff..bc08416 100644 --- a/docs/constant-values.html +++ b/docs/constant-values.html @@ -2,7 +2,7 @@ - + Constant Field Values diff --git a/docs/eu.steffo.cleaver/eu/steffo/cleaver/Main.html b/docs/eu.steffo.cleaver/eu/steffo/cleaver/Main.html index 79ba52e..b942de8 100644 --- a/docs/eu.steffo.cleaver/eu/steffo/cleaver/Main.html +++ b/docs/eu.steffo.cleaver/eu/steffo/cleaver/Main.html @@ -2,10 +2,10 @@ - + Main - + @@ -122,10 +122,10 @@ extends -protected static ArrayList<Job> +protected static ArrayList<Job> jobs -
The ArrayList of Jobs that the CleaverFrame will manipulate.
+
The ArrayList of Jobs that the CleaverFrame will manipulate.
@@ -208,8 +208,8 @@ extends

jobs

-
protected static ArrayList<Job> jobs
-
The ArrayList of Jobs that the CleaverFrame will manipulate.
+
protected static ArrayList<Job> jobs
+
The ArrayList of Jobs that the CleaverFrame will manipulate.
See Also:
main(String[])
diff --git a/docs/eu.steffo.cleaver/eu/steffo/cleaver/errors/ChpFileError.html b/docs/eu.steffo.cleaver/eu/steffo/cleaver/errors/ChpFileError.html index a0a50bd..14aa764 100644 --- a/docs/eu.steffo.cleaver/eu/steffo/cleaver/errors/ChpFileError.html +++ b/docs/eu.steffo.cleaver/eu/steffo/cleaver/errors/ChpFileError.html @@ -2,10 +2,10 @@ - + ChpFileError - + @@ -102,7 +102,7 @@ $('.navPadding').css('padding-top', $('.fixedNav').css("height"));
public class ChpFileError
 extends Exception
-
An error in the parsing of the .chp file occoured.
+
An error occoured during the parsing of a .chp file.
See Also:
Serialized Form
diff --git a/docs/eu.steffo.cleaver/eu/steffo/cleaver/errors/ProgrammingError.html b/docs/eu.steffo.cleaver/eu/steffo/cleaver/errors/ProgrammingError.html index 587eb5a..e5ccf53 100644 --- a/docs/eu.steffo.cleaver/eu/steffo/cleaver/errors/ProgrammingError.html +++ b/docs/eu.steffo.cleaver/eu/steffo/cleaver/errors/ProgrammingError.html @@ -2,10 +2,10 @@ - + ProgrammingError - + @@ -90,10 +90,12 @@ $('.navPadding').css('padding-top', $('.fixedNav').css("height"));
All Implemented Interfaces:
@@ -101,10 +103,12 @@ $('.navPadding').css('padding-top', $('.fixedNav').css("height"));

public class ProgrammingError
-extends Exception
-
An exception that should never be thrown during the execution of the program. +extends RuntimeException +
An exception that is never supposed to happen during the execution of the program. - It is thrown when an exception that should never be thrown is caught, such as ParserConfigurationException.
+ It is thrown when an exception that should never be thrown is caught, such as ParserConfigurationException. + + As they are never supposed to happen, they don't need to be caught, therefore they extend RuntimeException.
See Also:
Serialized Form
@@ -129,7 +133,7 @@ extends -ProgrammingError() +ProgrammingError​(String s)   @@ -168,8 +172,8 @@ extends
  • -

    ProgrammingError

    -
    public ProgrammingError()
    +

    ProgrammingError

    +
    public ProgrammingError​(String s)
  • diff --git a/docs/eu.steffo.cleaver/eu/steffo/cleaver/errors/package-summary.html b/docs/eu.steffo.cleaver/eu/steffo/cleaver/errors/package-summary.html index c0251f9..a52b056 100644 --- a/docs/eu.steffo.cleaver/eu/steffo/cleaver/errors/package-summary.html +++ b/docs/eu.steffo.cleaver/eu/steffo/cleaver/errors/package-summary.html @@ -2,10 +2,10 @@ - + eu.steffo.cleaver.errors - + @@ -73,7 +73,7 @@ $('.navPadding').css('padding-top', $('.fixedNav').css("height"));
    -
    A package containing all possible exceptions thrown by Cleaver.
    +
    A package containing all possible Errors and Exceptions thrown by Cleaver.
      @@ -91,13 +91,13 @@ $('.navPadding').css('padding-top', $('.fixedNav').css("height")); ChpFileError -
      An error in the parsing of the .chp file occoured.
      +
      An error occoured during the parsing of a .chp file.
      ProgrammingError -
      An exception that should never be thrown during the execution of the program.
      +
      An exception that is never supposed to happen during the execution of the program.
      diff --git a/docs/eu.steffo.cleaver/eu/steffo/cleaver/errors/package-tree.html b/docs/eu.steffo.cleaver/eu/steffo/cleaver/errors/package-tree.html index 8f503f1..31ad656 100644 --- a/docs/eu.steffo.cleaver/eu/steffo/cleaver/errors/package-tree.html +++ b/docs/eu.steffo.cleaver/eu/steffo/cleaver/errors/package-tree.html @@ -2,10 +2,10 @@ - + eu.steffo.cleaver.errors Class Hierarchy - + @@ -83,6 +83,8 @@ $('.navPadding').css('padding-top', $('.fixedNav').css("height"));
    • java.lang.Exception
    + +
    diff --git a/docs/eu.steffo.cleaver/eu/steffo/cleaver/gui/CleaverFrame.html b/docs/eu.steffo.cleaver/eu/steffo/cleaver/gui/CleaverFrame.html index 83ed5e0..fa63313 100644 --- a/docs/eu.steffo.cleaver/eu/steffo/cleaver/gui/CleaverFrame.html +++ b/docs/eu.steffo.cleaver/eu/steffo/cleaver/gui/CleaverFrame.html @@ -2,10 +2,10 @@ - + CleaverFrame - + @@ -171,14 +171,14 @@ extends protected ChopAndStitchPanel chopStitchPanel -
    The panel allowing the creation of new Jobs.
    +
    The panel allowing the creation of new Jobs.
    -protected ArrayList<Job> +protected ArrayList<Job> jobs -
    A reference to the ArrayList where the Jobs should be contained.
    +
    A reference to the ArrayList where the Jobs should be contained.
    @@ -192,7 +192,7 @@ extends protected JobsTablePanel jobsTablePanel -
    The panel containing the Jobs table.
    +
    The panel containing the Jobs table.
    @@ -242,7 +242,7 @@ extends -CleaverFrame​(ArrayList<Job> jobs) +CleaverFrame​(ArrayList<Job> jobs)
    Construct the CleaverFrame by setting its fields and adding to it the panels it should contain.
    @@ -310,7 +310,7 @@ extends

    chopStitchPanel

    protected final ChopAndStitchPanel chopStitchPanel
    -
    The panel allowing the creation of new Jobs.
    +
    The panel allowing the creation of new Jobs.
    See Also:
    ChopAndStitchPanel
    @@ -321,7 +321,7 @@ extends

    jobsTablePanel

    protected final JobsTablePanel jobsTablePanel
    -
    The panel containing the Jobs table.
    +
    The panel containing the Jobs table.
    See Also:
    JobsTablePanel
    @@ -342,8 +342,8 @@ extends

    jobs

    -
    protected final ArrayList<Job> jobs
    -
    A reference to the ArrayList where the Jobs should be contained.
    +
    protected final ArrayList<Job> jobs
    +
    A reference to the ArrayList where the Jobs should be contained.
    See Also:
    CleaverFrame(ArrayList)
    @@ -363,11 +363,11 @@ extends

    CleaverFrame

    -
    public CleaverFrame​(ArrayList<Job> jobs)
    +
    public CleaverFrame​(ArrayList<Job> jobs)
    Construct the CleaverFrame by setting its fields and adding to it the panels it should contain. - The frame is passed a reference to an ArrayList of Jobs in order to be able to display them in the - JobsTablePanel and to add/remove Jobs from it. + The frame is passed a reference to an ArrayList of Jobs in order to be able to display them in the + JobsTablePanel and to add/remove Jobs from it. It also creates ActionListeners for the events that require access to the jobs list.
    diff --git a/docs/eu.steffo.cleaver/eu/steffo/cleaver/gui/package-summary.html b/docs/eu.steffo.cleaver/eu/steffo/cleaver/gui/package-summary.html index 80f4682..67f78b6 100644 --- a/docs/eu.steffo.cleaver/eu/steffo/cleaver/gui/package-summary.html +++ b/docs/eu.steffo.cleaver/eu/steffo/cleaver/gui/package-summary.html @@ -2,10 +2,10 @@ - + eu.steffo.cleaver.gui - + diff --git a/docs/eu.steffo.cleaver/eu/steffo/cleaver/gui/package-tree.html b/docs/eu.steffo.cleaver/eu/steffo/cleaver/gui/package-tree.html index 1900078..59cf3b7 100644 --- a/docs/eu.steffo.cleaver/eu/steffo/cleaver/gui/package-tree.html +++ b/docs/eu.steffo.cleaver/eu/steffo/cleaver/gui/package-tree.html @@ -2,10 +2,10 @@ - + eu.steffo.cleaver.gui Class Hierarchy - + diff --git a/docs/eu.steffo.cleaver/eu/steffo/cleaver/gui/panels/ChopAndStitchPanel.html b/docs/eu.steffo.cleaver/eu/steffo/cleaver/gui/panels/ChopAndStitchPanel.html index 0927a16..6940ec9 100644 --- a/docs/eu.steffo.cleaver/eu/steffo/cleaver/gui/panels/ChopAndStitchPanel.html +++ b/docs/eu.steffo.cleaver/eu/steffo/cleaver/gui/panels/ChopAndStitchPanel.html @@ -2,10 +2,10 @@ - + ChopAndStitchPanel - + @@ -247,7 +247,7 @@ extends void -createAndAddChopJobs​(ArrayList<Job> jobs, +createAndAddChopJobs​(ArrayList<Job> jobs, Runnable onProgressChange)
    Propagate downwards the click of the Create Jobs button on the chopPanel.
    @@ -255,7 +255,7 @@ extends void -createAndAddStitchJobs​(ArrayList<Job> jobs, +createAndAddStitchJobs​(ArrayList<Job> jobs, Runnable onProgressChange)
    Propagate downwards the click of the Create Jobs button on the stitchPanel.
    @@ -353,16 +353,16 @@ extends

    createAndAddChopJobs

    -
    public void createAndAddChopJobs​(ArrayList<Job> jobs, +
    public void createAndAddChopJobs​(ArrayList<Job> jobs, Runnable onProgressChange)
    Propagate downwards the click of the Create Jobs button on the chopPanel.
    Parameters:
    jobs - The ArrayList of jobs that should be manipulated.
    -
    onProgressChange - The function that should be invoked when the Job Progress changes.
    +
    onProgressChange - The function that should be invoked when the Job Progress changes.
    See Also:
    ChopPanel.createAndAddJobs(ArrayList, Runnable), -ChopJob, +ChopJob, CleaverFrame
    @@ -370,16 +370,16 @@ extends

    createAndAddStitchJobs

    -
    public void createAndAddStitchJobs​(ArrayList<Job> jobs, +
    public void createAndAddStitchJobs​(ArrayList<Job> jobs, Runnable onProgressChange)
    Propagate downwards the click of the Create Jobs button on the stitchPanel.
    Parameters:
    jobs - The ArrayList of jobs that should be manipulated.
    -
    onProgressChange - The function that should be invoked when the Job Progress changes.
    +
    onProgressChange - The function that should be invoked when the Job Progress changes.
    See Also:
    StitchPanel.createAndAddJobs(ArrayList, Runnable), -ChopJob, +ChopJob, CleaverFrame
    diff --git a/docs/eu.steffo.cleaver/eu/steffo/cleaver/gui/panels/ChopPanel.html b/docs/eu.steffo.cleaver/eu/steffo/cleaver/gui/panels/ChopPanel.html index 55347a8..9c51150 100644 --- a/docs/eu.steffo.cleaver/eu/steffo/cleaver/gui/panels/ChopPanel.html +++ b/docs/eu.steffo.cleaver/eu/steffo/cleaver/gui/panels/ChopPanel.html @@ -2,10 +2,10 @@ - + ChopPanel - + @@ -114,7 +114,7 @@ $('.navPadding').css('padding-top', $('.fixedNav').css("height"));
    public class ChopPanel
     extends CreateJobPanel
    -
    The CreateJobPanel allowing the creation of ChopJobs.
    +
    The CreateJobPanel allowing the creation of ChopJobs.
    See Also:
    Serialized Form
    @@ -178,7 +178,7 @@ extends protected CreateJobButtonRow createJobButtonRow -
    The Row containing the button to create the ChopJobs.
    +
    The Row containing the button to create the ChopJobs.
    @@ -267,10 +267,10 @@ extends void -createAndAddJobs​(ArrayList<Job> jobs, +createAndAddJobs​(ArrayList<Job> jobs, Runnable onProgressChange) -
    Add to the jobs ArrayList the ChopJobs for the current settings.
    +
    Add to the jobs ArrayList the ChopJobs for the current settings.
    @@ -345,7 +345,7 @@ extends

    createJobButtonRow

    protected final CreateJobButtonRow createJobButtonRow
    -
    The Row containing the button to create the ChopJobs.
    +
    The Row containing the button to create the ChopJobs.
    @@ -394,13 +394,13 @@ extends

    createAndAddJobs

    -
    public void createAndAddJobs​(ArrayList<Job> jobs, +
    public void createAndAddJobs​(ArrayList<Job> jobs, Runnable onProgressChange)
    -
    Add to the jobs ArrayList the ChopJobs for the current settings.
    +
    Add to the jobs ArrayList the ChopJobs for the current settings.
    Parameters:
    -
    jobs - The ArrayList the ChopJobs should be added to.
    -
    onProgressChange - The function that should be invoked when the Job Progress changes.
    +
    jobs - The ArrayList the ChopJobs should be added to.
    +
    onProgressChange - The function that should be invoked when the Job Progress changes.
    diff --git a/docs/eu.steffo.cleaver/eu/steffo/cleaver/gui/panels/CreateJobPanel.html b/docs/eu.steffo.cleaver/eu/steffo/cleaver/gui/panels/CreateJobPanel.html index 1920d6e..4a54e42 100644 --- a/docs/eu.steffo.cleaver/eu/steffo/cleaver/gui/panels/CreateJobPanel.html +++ b/docs/eu.steffo.cleaver/eu/steffo/cleaver/gui/panels/CreateJobPanel.html @@ -2,10 +2,10 @@ - + CreateJobPanel - + diff --git a/docs/eu.steffo.cleaver/eu/steffo/cleaver/gui/panels/JobsButtonsPanel.html b/docs/eu.steffo.cleaver/eu/steffo/cleaver/gui/panels/JobsButtonsPanel.html index dcc676c..9a4c273 100644 --- a/docs/eu.steffo.cleaver/eu/steffo/cleaver/gui/panels/JobsButtonsPanel.html +++ b/docs/eu.steffo.cleaver/eu/steffo/cleaver/gui/panels/JobsButtonsPanel.html @@ -2,10 +2,10 @@ - + JobsButtonsPanel - + diff --git a/docs/eu.steffo.cleaver/eu/steffo/cleaver/gui/panels/JobsTablePanel.JobsTableModel.html b/docs/eu.steffo.cleaver/eu/steffo/cleaver/gui/panels/JobsTablePanel.JobsTableModel.html index 91effbb..a089722 100644 --- a/docs/eu.steffo.cleaver/eu/steffo/cleaver/gui/panels/JobsTablePanel.JobsTableModel.html +++ b/docs/eu.steffo.cleaver/eu/steffo/cleaver/gui/panels/JobsTablePanel.JobsTableModel.html @@ -2,10 +2,10 @@ - + JobsTablePanel.JobsTableModel - + diff --git a/docs/eu.steffo.cleaver/eu/steffo/cleaver/gui/panels/JobsTablePanel.html b/docs/eu.steffo.cleaver/eu/steffo/cleaver/gui/panels/JobsTablePanel.html index 51c4bfa..a0fbf7b 100644 --- a/docs/eu.steffo.cleaver/eu/steffo/cleaver/gui/panels/JobsTablePanel.html +++ b/docs/eu.steffo.cleaver/eu/steffo/cleaver/gui/panels/JobsTablePanel.html @@ -2,10 +2,10 @@ - + JobsTablePanel - + @@ -187,10 +187,10 @@ extends -protected ArrayList<Job> +protected ArrayList<Job> jobs -
    A reference to the ArrayList of Jobs that should be displayed.
    +
    A reference to the ArrayList of Jobs that should be displayed.
    @@ -251,7 +251,7 @@ extends -JobsTablePanel​(ArrayList<Job> jobs) +JobsTablePanel​(ArrayList<Job> jobs)
    Construct a JobsTablePanel.
    @@ -357,8 +357,8 @@ extends

    jobs

    -
    protected final ArrayList<Job> jobs
    -
    A reference to the ArrayList of Jobs that should be displayed.
    +
    protected final ArrayList<Job> jobs
    +
    A reference to the ArrayList of Jobs that should be displayed.
    @@ -374,11 +374,11 @@ extends

    JobsTablePanel

    -
    public JobsTablePanel​(ArrayList<Job> jobs)
    +
    public JobsTablePanel​(ArrayList<Job> jobs)
    Construct a JobsTablePanel.
    Parameters:
    -
    jobs - A reference to the ArrayList of Jobs that should be displayed in the table.
    +
    jobs - A reference to the ArrayList of Jobs that should be displayed in the table.
    diff --git a/docs/eu.steffo.cleaver/eu/steffo/cleaver/gui/panels/StitchPanel.html b/docs/eu.steffo.cleaver/eu/steffo/cleaver/gui/panels/StitchPanel.html index 0ca2765..83fb571 100644 --- a/docs/eu.steffo.cleaver/eu/steffo/cleaver/gui/panels/StitchPanel.html +++ b/docs/eu.steffo.cleaver/eu/steffo/cleaver/gui/panels/StitchPanel.html @@ -2,10 +2,10 @@ - + StitchPanel - + @@ -114,7 +114,7 @@ $('.navPadding').css('padding-top', $('.fixedNav').css("height"));
    public class StitchPanel
     extends CreateJobPanel
    -
    The CreateJobPanel allowing the creation of StitchJobs.
    +
    The CreateJobPanel allowing the creation of StitchJobs.
    See Also:
    Serialized Form
    @@ -171,7 +171,7 @@ extends protected CreateJobButtonRow createJobButtonRow -
    The Row containing the button to create the StitchJobs.
    +
    The Row containing the button to create the StitchJobs.
    @@ -253,10 +253,10 @@ extends void -createAndAddJobs​(ArrayList<Job> jobs, +createAndAddJobs​(ArrayList<Job> jobs, Runnable onProgressChange) -
    Add to the jobs ArrayList the StitchJobs for the current settings.
    +
    Add to the jobs ArrayList the StitchJobs for the current settings.
    @@ -317,7 +317,7 @@ extends

    createJobButtonRow

    protected final CreateJobButtonRow createJobButtonRow
    -
    The Row containing the button to create the StitchJobs.
    +
    The Row containing the button to create the StitchJobs.
    @@ -366,13 +366,13 @@ extends

    createAndAddJobs

    -
    public void createAndAddJobs​(ArrayList<Job> jobs, +
    public void createAndAddJobs​(ArrayList<Job> jobs, Runnable onProgressChange)
    -
    Add to the jobs ArrayList the StitchJobs for the current settings.
    +
    Add to the jobs ArrayList the StitchJobs for the current settings.
    Parameters:
    -
    jobs - The ArrayList the StitchJobs should be added to.
    -
    onProgressChange - The function that should be invoked when the Job Progress changes.
    +
    jobs - The ArrayList the StitchJobs should be added to.
    +
    onProgressChange - The function that should be invoked when the Job Progress changes.
    diff --git a/docs/eu.steffo.cleaver/eu/steffo/cleaver/gui/panels/package-summary.html b/docs/eu.steffo.cleaver/eu/steffo/cleaver/gui/panels/package-summary.html index c08fe32..1e8df22 100644 --- a/docs/eu.steffo.cleaver/eu/steffo/cleaver/gui/panels/package-summary.html +++ b/docs/eu.steffo.cleaver/eu/steffo/cleaver/gui/panels/package-summary.html @@ -2,10 +2,10 @@ - + eu.steffo.cleaver.gui.panels - + @@ -101,7 +101,7 @@ $('.navPadding').css('padding-top', $('.fixedNav').css("height")); ChopPanel -
    The CreateJobPanel allowing the creation of ChopJobs.
    +
    The CreateJobPanel allowing the creation of ChopJobs.
    @@ -125,7 +125,7 @@ $('.navPadding').css('padding-top', $('.fixedNav').css("height")); StitchPanel -
    The CreateJobPanel allowing the creation of StitchJobs.
    +
    The CreateJobPanel allowing the creation of StitchJobs.
    diff --git a/docs/eu.steffo.cleaver/eu/steffo/cleaver/gui/panels/package-tree.html b/docs/eu.steffo.cleaver/eu/steffo/cleaver/gui/panels/package-tree.html index 4b55003..33bce8d 100644 --- a/docs/eu.steffo.cleaver/eu/steffo/cleaver/gui/panels/package-tree.html +++ b/docs/eu.steffo.cleaver/eu/steffo/cleaver/gui/panels/package-tree.html @@ -2,10 +2,10 @@ - + eu.steffo.cleaver.gui.panels Class Hierarchy - + diff --git a/docs/eu.steffo.cleaver/eu/steffo/cleaver/gui/panels/rows/CreateJobButtonRow.html b/docs/eu.steffo.cleaver/eu/steffo/cleaver/gui/panels/rows/CreateJobButtonRow.html index 2c1af8b..68fd0a1 100644 --- a/docs/eu.steffo.cleaver/eu/steffo/cleaver/gui/panels/rows/CreateJobButtonRow.html +++ b/docs/eu.steffo.cleaver/eu/steffo/cleaver/gui/panels/rows/CreateJobButtonRow.html @@ -2,10 +2,10 @@ - + CreateJobButtonRow - + diff --git a/docs/eu.steffo.cleaver/eu/steffo/cleaver/gui/panels/rows/FileSelectRow.html b/docs/eu.steffo.cleaver/eu/steffo/cleaver/gui/panels/rows/FileSelectRow.html index 7d71514..9496649 100644 --- a/docs/eu.steffo.cleaver/eu/steffo/cleaver/gui/panels/rows/FileSelectRow.html +++ b/docs/eu.steffo.cleaver/eu/steffo/cleaver/gui/panels/rows/FileSelectRow.html @@ -2,10 +2,10 @@ - + FileSelectRow - + diff --git a/docs/eu.steffo.cleaver/eu/steffo/cleaver/gui/panels/rows/Row.html b/docs/eu.steffo.cleaver/eu/steffo/cleaver/gui/panels/rows/Row.html index 172cbf7..ece9dfe 100644 --- a/docs/eu.steffo.cleaver/eu/steffo/cleaver/gui/panels/rows/Row.html +++ b/docs/eu.steffo.cleaver/eu/steffo/cleaver/gui/panels/rows/Row.html @@ -2,10 +2,10 @@ - + Row - + diff --git a/docs/eu.steffo.cleaver/eu/steffo/cleaver/gui/panels/rows/TitleRow.html b/docs/eu.steffo.cleaver/eu/steffo/cleaver/gui/panels/rows/TitleRow.html index 60b2819..e107daa 100644 --- a/docs/eu.steffo.cleaver/eu/steffo/cleaver/gui/panels/rows/TitleRow.html +++ b/docs/eu.steffo.cleaver/eu/steffo/cleaver/gui/panels/rows/TitleRow.html @@ -2,10 +2,10 @@ - + TitleRow - + diff --git a/docs/eu.steffo.cleaver/eu/steffo/cleaver/gui/panels/rows/option/CompressRow.html b/docs/eu.steffo.cleaver/eu/steffo/cleaver/gui/panels/rows/option/CompressRow.html index f6b8e51..2d728f2 100644 --- a/docs/eu.steffo.cleaver/eu/steffo/cleaver/gui/panels/rows/option/CompressRow.html +++ b/docs/eu.steffo.cleaver/eu/steffo/cleaver/gui/panels/rows/option/CompressRow.html @@ -2,10 +2,10 @@ - + CompressRow - + @@ -116,7 +116,7 @@ $('.navPadding').css('padding-top', $('.fixedNav').css("height"));
    public class CompressRow
     extends OptionRow
    -
    A OptionRow allowing the configuration of the compress step of the file chop process.
    +
    A OptionRow allowing the configuration of the compress step of the file chop process.
    See Also:
    ChopPanel, @@ -243,15 +243,15 @@ extends -CompressConfig +ICompressConfig getCompressConfig() -
    Create a CompressConfig from the settings in this OptionRow.
    +
    Create a DeflateConfig from the settings in this OptionRow.
    void -setCompressConfig​(CompressConfig cfg) +setCompressConfig​(DeflateConfig cfg)   @@ -342,18 +342,18 @@ extends

    getCompressConfig

    -
    public CompressConfig getCompressConfig()
    -
    Create a CompressConfig from the settings in this OptionRow.
    +
    public ICompressConfig getCompressConfig()
    +
    Create a DeflateConfig from the settings in this OptionRow.
    Returns:
    -
    The resulting CompressConfig, or null if the compressionCheckBox is unticked.
    +
    The resulting DeflateConfig, or null if the compressionCheckBox is unticked.
  • -

    setCompressConfig

    -
    public void setCompressConfig​(CompressConfig cfg)
    +

    setCompressConfig

    +
    public void setCompressConfig​(DeflateConfig cfg)
  • diff --git a/docs/eu.steffo.cleaver/eu/steffo/cleaver/gui/panels/rows/option/CryptRow.html b/docs/eu.steffo.cleaver/eu/steffo/cleaver/gui/panels/rows/option/CryptRow.html index f6e2465..2aa5ae2 100644 --- a/docs/eu.steffo.cleaver/eu/steffo/cleaver/gui/panels/rows/option/CryptRow.html +++ b/docs/eu.steffo.cleaver/eu/steffo/cleaver/gui/panels/rows/option/CryptRow.html @@ -2,10 +2,10 @@ - + CryptRow - + @@ -116,7 +116,7 @@ $('.navPadding').css('padding-top', $('.fixedNav').css("height"));
    public class CryptRow
     extends OptionRow
    -
    A OptionRow allowing the configuration of the crypt step of the file chop process.
    +
    A OptionRow allowing the configuration of the crypt step of the file chop process.
    See Also:
    ChopPanel, @@ -264,10 +264,10 @@ extends -CryptConfig +ICryptConfig getCryptConfig() -
    Create a CryptConfig from the settings in this OptionRow.
    +
    Create a PasswordConfig from the settings in this OptionRow.
    @@ -386,11 +386,11 @@ extends

    getCryptConfig

    -
    public CryptConfig getCryptConfig()
    -
    Create a CryptConfig from the settings in this OptionRow.
    +
    public ICryptConfig getCryptConfig()
    +
    Create a PasswordConfig from the settings in this OptionRow.
    Returns:
    -
    The resulting CryptConfig, or null if the cryptCheckBox is unticked.
    +
    The resulting PasswordConfig, or null if the cryptCheckBox is unticked.
  • diff --git a/docs/eu.steffo.cleaver/eu/steffo/cleaver/gui/panels/rows/option/KeyRow.html b/docs/eu.steffo.cleaver/eu/steffo/cleaver/gui/panels/rows/option/KeyRow.html index 9da6e1a..dbdfe3d 100644 --- a/docs/eu.steffo.cleaver/eu/steffo/cleaver/gui/panels/rows/option/KeyRow.html +++ b/docs/eu.steffo.cleaver/eu/steffo/cleaver/gui/panels/rows/option/KeyRow.html @@ -2,10 +2,10 @@ - + KeyRow - + @@ -116,7 +116,7 @@ $('.navPadding').css('padding-top', $('.fixedNav').css("height"));
    public class KeyRow
     extends OptionRow
    -
    A OptionRow allowing the configuration of the crypt step of the file stitch process. +
    A OptionRow allowing the configuration of the crypt step of the file stitch process. This configuration is used only if the selected *.chp file specifies that the *.cXX are encrypted.
    diff --git a/docs/eu.steffo.cleaver/eu/steffo/cleaver/gui/panels/rows/option/OptionRow.html b/docs/eu.steffo.cleaver/eu/steffo/cleaver/gui/panels/rows/option/OptionRow.html index b5ebdc6..8a418b0 100644 --- a/docs/eu.steffo.cleaver/eu/steffo/cleaver/gui/panels/rows/option/OptionRow.html +++ b/docs/eu.steffo.cleaver/eu/steffo/cleaver/gui/panels/rows/option/OptionRow.html @@ -2,10 +2,10 @@ - + OptionRow - + diff --git a/docs/eu.steffo.cleaver/eu/steffo/cleaver/gui/panels/rows/option/SplitRow.html b/docs/eu.steffo.cleaver/eu/steffo/cleaver/gui/panels/rows/option/SplitRow.html index 2b9271a..151e832 100644 --- a/docs/eu.steffo.cleaver/eu/steffo/cleaver/gui/panels/rows/option/SplitRow.html +++ b/docs/eu.steffo.cleaver/eu/steffo/cleaver/gui/panels/rows/option/SplitRow.html @@ -2,10 +2,10 @@ - + SplitRow - + @@ -116,7 +116,7 @@ $('.navPadding').css('padding-top', $('.fixedNav').css("height"));
    public class SplitRow
     extends OptionRow
    -
    A OptionRow allowing the configuration of the split step of the file chop process.
    +
    A OptionRow allowing the configuration of the split step of the file chop process.
    See Also:
    ChopPanel, @@ -292,10 +292,10 @@ extends -SplitConfig +ISplitConfig getSplitConfig​(long fileSize) -
    Create a SplitConfig from the settings in this OptionRow.
    +
    Create a IConfig from the settings in this OptionRow.
    @@ -450,14 +450,14 @@ extends

    getSplitConfig

    -
    public SplitConfig getSplitConfig​(long fileSize) - throws NumberFormatException
    -
    Create a SplitConfig from the settings in this OptionRow.
    +
    public ISplitConfig getSplitConfig​(long fileSize) + throws NumberFormatException
    +
    Create a IConfig from the settings in this OptionRow.
    Parameters:
    -
    fileSize - The size of the file that the SplitConfig is being generated for.
    +
    fileSize - The size of the file that the IConfig is being generated for.
    Returns:
    -
    The resulting SplitConfig, or null if the splitCheckBox is unticked.
    +
    The resulting IConfig, or null if the splitCheckBox is unticked.
    Throws:
    NumberFormatException
    diff --git a/docs/eu.steffo.cleaver/eu/steffo/cleaver/gui/panels/rows/option/package-summary.html b/docs/eu.steffo.cleaver/eu/steffo/cleaver/gui/panels/rows/option/package-summary.html index 72ba1f2..9c6a8da 100644 --- a/docs/eu.steffo.cleaver/eu/steffo/cleaver/gui/panels/rows/option/package-summary.html +++ b/docs/eu.steffo.cleaver/eu/steffo/cleaver/gui/panels/rows/option/package-summary.html @@ -2,10 +2,10 @@ - + eu.steffo.cleaver.gui.panels.rows.option - + @@ -91,19 +91,19 @@ $('.navPadding').css('padding-top', $('.fixedNav').css("height")); CompressRow -
    A OptionRow allowing the configuration of the compress step of the file chop process.
    +
    A OptionRow allowing the configuration of the compress step of the file chop process.
    CryptRow -
    A OptionRow allowing the configuration of the crypt step of the file chop process.
    +
    A OptionRow allowing the configuration of the crypt step of the file chop process.
    KeyRow -
    A OptionRow allowing the configuration of the crypt step of the file stitch process.
    +
    A OptionRow allowing the configuration of the crypt step of the file stitch process.
    @@ -115,7 +115,7 @@ $('.navPadding').css('padding-top', $('.fixedNav').css("height")); SplitRow -
    A OptionRow allowing the configuration of the split step of the file chop process.
    +
    A OptionRow allowing the configuration of the split step of the file chop process.
    diff --git a/docs/eu.steffo.cleaver/eu/steffo/cleaver/gui/panels/rows/option/package-tree.html b/docs/eu.steffo.cleaver/eu/steffo/cleaver/gui/panels/rows/option/package-tree.html index 319dbd6..a0e4f73 100644 --- a/docs/eu.steffo.cleaver/eu/steffo/cleaver/gui/panels/rows/option/package-tree.html +++ b/docs/eu.steffo.cleaver/eu/steffo/cleaver/gui/panels/rows/option/package-tree.html @@ -2,10 +2,10 @@ - + eu.steffo.cleaver.gui.panels.rows.option Class Hierarchy - + diff --git a/docs/eu.steffo.cleaver/eu/steffo/cleaver/gui/panels/rows/package-summary.html b/docs/eu.steffo.cleaver/eu/steffo/cleaver/gui/panels/rows/package-summary.html index c640c68..f851981 100644 --- a/docs/eu.steffo.cleaver/eu/steffo/cleaver/gui/panels/rows/package-summary.html +++ b/docs/eu.steffo.cleaver/eu/steffo/cleaver/gui/panels/rows/package-summary.html @@ -2,10 +2,10 @@ - + eu.steffo.cleaver.gui.panels.rows - + diff --git a/docs/eu.steffo.cleaver/eu/steffo/cleaver/gui/panels/rows/package-tree.html b/docs/eu.steffo.cleaver/eu/steffo/cleaver/gui/panels/rows/package-tree.html index 8660bc0..0af8695 100644 --- a/docs/eu.steffo.cleaver/eu/steffo/cleaver/gui/panels/rows/package-tree.html +++ b/docs/eu.steffo.cleaver/eu/steffo/cleaver/gui/panels/rows/package-tree.html @@ -2,10 +2,10 @@ - + eu.steffo.cleaver.gui.panels.rows Class Hierarchy - + diff --git a/docs/eu.steffo.cleaver/eu/steffo/cleaver/logic/config/DeflateConfig.html b/docs/eu.steffo.cleaver/eu/steffo/cleaver/logic/config/DeflateConfig.html new file mode 100644 index 0000000..d73a69b --- /dev/null +++ b/docs/eu.steffo.cleaver/eu/steffo/cleaver/logic/config/DeflateConfig.html @@ -0,0 +1,269 @@ + + + + + +DeflateConfig + + + + + + + + + + + + + + + + + +
    + +
    + +
    +
    + + +

    Class DeflateConfig

    +
    +
    +
    java.lang.Object +
    eu.steffo.cleaver.logic.config.DeflateConfig
    +
    +
    +
    +
    All Implemented Interfaces:
    +
    ICompressConfig, IConfig
    +
    +
    +
    public class DeflateConfig
    +extends Object
    +implements ICompressConfig
    +
    A ICompressConfig requesting a compression with the Deflate algorithm.
    +
    +
    + +
    +
    +
      + +
    • +
      + + +

      Constructor Details

      + +
      +
    • + +
    • +
      + + +

      Method Details

      +
        +
      • +
        +

        toString

        +
        public String toString()
        +
        Description copied from interface: IConfig
        +
        Get the string representation of the step, to be displayed in the Operations column of the + JobsTablePanel.
        +
        +
        Specified by:
        +
        toString in interface IConfig
        +
        Overrides:
        +
        toString in class Object
        +
        Returns:
        +
        The string to be displated.
        +
        +
        +
      • +
      +
      +
    • +
    +
    +
    +
    + + + + diff --git a/docs/eu.steffo.cleaver/eu/steffo/cleaver/logic/config/ICompressConfig.html b/docs/eu.steffo.cleaver/eu/steffo/cleaver/logic/config/ICompressConfig.html new file mode 100644 index 0000000..8e6fbad --- /dev/null +++ b/docs/eu.steffo.cleaver/eu/steffo/cleaver/logic/config/ICompressConfig.html @@ -0,0 +1,167 @@ + + + + + +ICompressConfig + + + + + + + + + + + + + + + + + +
    + +
    + +
    +
    + + +

    Interface ICompressConfig

    +
    +
    +
    +
    +
    All Superinterfaces:
    +
    IConfig
    +
    +
    +
    All Known Implementing Classes:
    +
    DeflateConfig
    +
    +
    +
    public interface ICompressConfig
    +extends IConfig
    +
    A IConfig generated by a CompressRow.
    +
    +
    +
      + +
    • +
      + + +

      Method Summary

      +
      +

      Methods inherited from interface eu.steffo.cleaver.logic.config.IConfig

      + + +toString
      +
      +
    • +
    +
    +
    +
    + + + + diff --git a/docs/eu.steffo.cleaver/eu/steffo/cleaver/logic/config/IConfig.html b/docs/eu.steffo.cleaver/eu/steffo/cleaver/logic/config/IConfig.html new file mode 100644 index 0000000..49277dc --- /dev/null +++ b/docs/eu.steffo.cleaver/eu/steffo/cleaver/logic/config/IConfig.html @@ -0,0 +1,220 @@ + + + + + +IConfig + + + + + + + + + + + + + + + + + +
    + +
    + +
    +
    + + +

    Interface IConfig

    +
    +
    +
    +
    +
    All Known Subinterfaces:
    +
    ICompressConfig, ICryptConfig, ISplitConfig
    +
    +
    +
    All Known Implementing Classes:
    +
    DeflateConfig, PartsConfig, PasswordConfig, SizeConfig
    +
    +
    +
    public interface IConfig
    +
    A configuration generated by a OptionRow to configure a step of a + ChopJob.
    +
    +
    +
      + +
    • +
      + + +

      Method Summary

      +
      +
      +
      + + + + + + + + + + + + + + + +
      Modifier and TypeMethodDescription
      StringtoString() +
      Get the string representation of the step, to be displayed in the Operations column of the + JobsTablePanel.
      +
      +
      +
      +
      +
    • +
    +
    +
    +
      + +
    • +
      + + +

      Method Details

      +
        +
      • +
        +

        toString

        +
        String toString()
        +
        Get the string representation of the step, to be displayed in the Operations column of the + JobsTablePanel.
        +
        +
        Overrides:
        +
        toString in class Object
        +
        Returns:
        +
        The string to be displated.
        +
        +
        +
      • +
      +
      +
    • +
    +
    +
    +
    + + + + diff --git a/docs/eu.steffo.cleaver/eu/steffo/cleaver/logic/config/ICryptConfig.html b/docs/eu.steffo.cleaver/eu/steffo/cleaver/logic/config/ICryptConfig.html new file mode 100644 index 0000000..cc92238 --- /dev/null +++ b/docs/eu.steffo.cleaver/eu/steffo/cleaver/logic/config/ICryptConfig.html @@ -0,0 +1,167 @@ + + + + + +ICryptConfig + + + + + + + + + + + + + + + + + +
    + +
    + +
    +
    + + +

    Interface ICryptConfig

    +
    +
    +
    +
    +
    All Superinterfaces:
    +
    IConfig
    +
    +
    +
    All Known Implementing Classes:
    +
    PasswordConfig
    +
    +
    +
    public interface ICryptConfig
    +extends IConfig
    +
    A IConfig generated by a CryptRow.
    +
    +
    +
      + +
    • +
      + + +

      Method Summary

      +
      +

      Methods inherited from interface eu.steffo.cleaver.logic.config.IConfig

      + + +toString
      +
      +
    • +
    +
    +
    +
    + + + + diff --git a/docs/eu.steffo.cleaver/eu/steffo/cleaver/logic/config/ISplitConfig.html b/docs/eu.steffo.cleaver/eu/steffo/cleaver/logic/config/ISplitConfig.html new file mode 100644 index 0000000..e4fa6d3 --- /dev/null +++ b/docs/eu.steffo.cleaver/eu/steffo/cleaver/logic/config/ISplitConfig.html @@ -0,0 +1,167 @@ + + + + + +ISplitConfig + + + + + + + + + + + + + + + + + +
    + +
    + +
    +
    + + +

    Interface ISplitConfig

    +
    +
    +
    +
    +
    All Superinterfaces:
    +
    IConfig
    +
    +
    +
    All Known Implementing Classes:
    +
    PartsConfig, SizeConfig
    +
    +
    +
    public interface ISplitConfig
    +extends IConfig
    +
    A IConfig generated by a SplitRow.
    +
    +
    +
      + +
    • +
      + + +

      Method Summary

      +
      +

      Methods inherited from interface eu.steffo.cleaver.logic.config.IConfig

      + + +toString
      +
      +
    • +
    +
    +
    +
    + + + + diff --git a/docs/eu.steffo.cleaver/eu/steffo/cleaver/logic/config/PartsConfig.html b/docs/eu.steffo.cleaver/eu/steffo/cleaver/logic/config/PartsConfig.html new file mode 100644 index 0000000..89fd673 --- /dev/null +++ b/docs/eu.steffo.cleaver/eu/steffo/cleaver/logic/config/PartsConfig.html @@ -0,0 +1,337 @@ + + + + + +PartsConfig + + + + + + + + + + + + + + + + + +
    + +
    + +
    +
    + + +

    Class PartsConfig

    +
    +
    +
    java.lang.Object +
    eu.steffo.cleaver.logic.config.PartsConfig
    +
    +
    +
    +
    All Implemented Interfaces:
    +
    IConfig, ISplitConfig
    +
    +
    +
    public class PartsConfig
    +extends Object
    +implements ISplitConfig
    +
    A ISplitConfig requesting the split of a file in a specific number of parts.
    +
    +
    +
      + +
    • +
      + + +

      Field Summary

      +
      + + + + + + + + + + + + + + + + +
      Fields 
      Modifier and TypeFieldDescription
      private intparts +
      The number of parts the file should be split in.
      +
      +
      +
      +
    • + +
    • +
      + + +

      Constructor Summary

      +
      + + + + + + + + + + + + + + +
      Constructors 
      ConstructorDescription
      PartsConfig​(int parts) +
      Construct a new SplitByPartsConfig.
      +
      +
      +
      +
    • + +
    • +
      + + +

      Method Summary

      +
      +
      +
      + + + + + + + + + + + + + + + + + + + + +
      Modifier and TypeMethodDescription
      intgetPartCount() 
      StringtoString() +
      Get the string representation of the step, to be displayed in the Operations column of the + JobsTablePanel.
      +
      +
      +
      +
      +

      Methods inherited from class java.lang.Object

      + + +clone, equals, getClass, hashCode, notify, notifyAll, wait, wait, wait
      +
      +
    • +
    +
    +
    +
      + +
    • +
      + + +

      Field Details

      +
        +
      • +
        +

        parts

        +
        private int parts
        +
        The number of parts the file should be split in.
        +
        +
      • +
      +
      +
    • + +
    • +
      + + +

      Constructor Details

      +
        +
      • +
        +

        PartsConfig

        +
        public PartsConfig​(int parts)
        +
        Construct a new SplitByPartsConfig.
        +
        +
        Parameters:
        +
        parts - The number of parts the file should be split in.
        +
        +
        +
      • +
      +
      +
    • + +
    • +
      + + +

      Method Details

      +
        +
      • +
        +

        getPartCount

        +
        public int getPartCount()
        +
        +
        Returns:
        +
        The number of parts the file should be split in.
        +
        +
        +
      • +
      • +
        +

        toString

        +
        public String toString()
        +
        Description copied from interface: IConfig
        +
        Get the string representation of the step, to be displayed in the Operations column of the + JobsTablePanel.
        +
        +
        Specified by:
        +
        toString in interface IConfig
        +
        Overrides:
        +
        toString in class Object
        +
        Returns:
        +
        The string to be displated.
        +
        +
        +
      • +
      +
      +
    • +
    +
    +
    +
    + + + + diff --git a/docs/eu.steffo.cleaver/eu/steffo/cleaver/logic/config/PasswordConfig.html b/docs/eu.steffo.cleaver/eu/steffo/cleaver/logic/config/PasswordConfig.html new file mode 100644 index 0000000..c96e301 --- /dev/null +++ b/docs/eu.steffo.cleaver/eu/steffo/cleaver/logic/config/PasswordConfig.html @@ -0,0 +1,337 @@ + + + + + +PasswordConfig + + + + + + + + + + + + + + + + + +
    + +
    + +
    +
    + + +

    Class PasswordConfig

    +
    +
    +
    java.lang.Object +
    eu.steffo.cleaver.logic.config.PasswordConfig
    +
    +
    +
    +
    All Implemented Interfaces:
    +
    IConfig, ICryptConfig
    +
    +
    +
    public class PasswordConfig
    +extends Object
    +implements ICryptConfig
    +
    A ICryptConfig requesting the encryption of a file using a specific password.
    +
    +
    +
      + +
    • +
      + + +

      Field Summary

      +
      + + + + + + + + + + + + + + + + +
      Fields 
      Modifier and TypeFieldDescription
      private Stringpassword +
      The password to be used in the encryption.
      +
      +
      +
      +
    • + +
    • +
      + + +

      Constructor Summary

      +
      + + + + + + + + + + + + + + +
      Constructors 
      ConstructorDescription
      PasswordConfig​(String key) +
      Construct a new PasswordConfig with a specific password.
      +
      +
      +
      +
    • + +
    • +
      + + +

      Method Summary

      +
      +
      +
      + + + + + + + + + + + + + + + + + + + + +
      Modifier and TypeMethodDescription
      StringgetPassword() 
      StringtoString() +
      Get the string representation of the step, to be displayed in the Operations column of the + JobsTablePanel.
      +
      +
      +
      +
      +

      Methods inherited from class java.lang.Object

      + + +clone, equals, getClass, hashCode, notify, notifyAll, wait, wait, wait
      +
      +
    • +
    +
    +
    +
      + +
    • +
      + + +

      Field Details

      +
        +
      • +
        +

        password

        +
        private final String password
        +
        The password to be used in the encryption.
        +
        +
      • +
      +
      +
    • + +
    • +
      + + +

      Constructor Details

      +
        +
      • +
        +

        PasswordConfig

        +
        public PasswordConfig​(String key)
        +
        Construct a new PasswordConfig with a specific password.
        +
        +
        Parameters:
        +
        key - The password to be used in the encryption.
        +
        +
        +
      • +
      +
      +
    • + +
    • +
      + + +

      Method Details

      +
        +
      • +
        +

        getPassword

        +
        public String getPassword()
        +
        +
        Returns:
        +
        The password to be used in the encryption.
        +
        +
        +
      • +
      • +
        +

        toString

        +
        public String toString()
        +
        Description copied from interface: IConfig
        +
        Get the string representation of the step, to be displayed in the Operations column of the + JobsTablePanel.
        +
        +
        Specified by:
        +
        toString in interface IConfig
        +
        Overrides:
        +
        toString in class Object
        +
        Returns:
        +
        The string to be displated.
        +
        +
        +
      • +
      +
      +
    • +
    +
    +
    +
    + + + + diff --git a/docs/eu.steffo.cleaver/eu/steffo/cleaver/logic/config/SizeConfig.html b/docs/eu.steffo.cleaver/eu/steffo/cleaver/logic/config/SizeConfig.html new file mode 100644 index 0000000..5ab41cd --- /dev/null +++ b/docs/eu.steffo.cleaver/eu/steffo/cleaver/logic/config/SizeConfig.html @@ -0,0 +1,337 @@ + + + + + +SizeConfig + + + + + + + + + + + + + + + + + +
    + +
    + +
    +
    + + +

    Class SizeConfig

    +
    +
    +
    java.lang.Object +
    eu.steffo.cleaver.logic.config.SizeConfig
    +
    +
    +
    +
    All Implemented Interfaces:
    +
    IConfig, ISplitConfig
    +
    +
    +
    public class SizeConfig
    +extends Object
    +implements ISplitConfig
    +
    A ISplitConfig requesting the split of a file in parts of a specific size.
    +
    +
    +
      + +
    • +
      + + +

      Field Summary

      +
      + + + + + + + + + + + + + + + + +
      Fields 
      Modifier and TypeFieldDescription
      private longsize +
      The size (in bytes) of a single part.
      +
      +
      +
      +
    • + +
    • +
      + + +

      Constructor Summary

      +
      + + + + + + + + + + + + + + +
      Constructors 
      ConstructorDescription
      SizeConfig​(long size) +
      Construct a new SizeConfig.
      +
      +
      +
      +
    • + +
    • +
      + + +

      Method Summary

      +
      +
      +
      + + + + + + + + + + + + + + + + + + + + +
      Modifier and TypeMethodDescription
      longgetSize() 
      StringtoString() +
      Get the string representation of the step, to be displayed in the Operations column of the + JobsTablePanel.
      +
      +
      +
      +
      +

      Methods inherited from class java.lang.Object

      + + +clone, equals, getClass, hashCode, notify, notifyAll, wait, wait, wait
      +
      +
    • +
    +
    +
    +
      + +
    • +
      + + +

      Field Details

      +
        +
      • +
        +

        size

        +
        private long size
        +
        The size (in bytes) of a single part.
        +
        +
      • +
      +
      +
    • + +
    • +
      + + +

      Constructor Details

      +
        +
      • +
        +

        SizeConfig

        +
        public SizeConfig​(long size)
        +
        Construct a new SizeConfig.
        +
        +
        Parameters:
        +
        size - The size (in bytes) of a single part.
        +
        +
        +
      • +
      +
      +
    • + +
    • +
      + + +

      Method Details

      +
        +
      • +
        +

        getSize

        +
        public long getSize()
        +
        +
        Returns:
        +
        The size (in bytes) of a single part.
        +
        +
        +
      • +
      • +
        +

        toString

        +
        public String toString()
        +
        Description copied from interface: IConfig
        +
        Get the string representation of the step, to be displayed in the Operations column of the + JobsTablePanel.
        +
        +
        Specified by:
        +
        toString in interface IConfig
        +
        Overrides:
        +
        toString in class Object
        +
        Returns:
        +
        The string to be displated.
        +
        +
        +
      • +
      +
      +
    • +
    +
    +
    +
    + + + + diff --git a/docs/eu.steffo.cleaver/eu/steffo/cleaver/logic/config/package-summary.html b/docs/eu.steffo.cleaver/eu/steffo/cleaver/logic/config/package-summary.html new file mode 100644 index 0000000..a024071 --- /dev/null +++ b/docs/eu.steffo.cleaver/eu/steffo/cleaver/logic/config/package-summary.html @@ -0,0 +1,190 @@ + + + + + +eu.steffo.cleaver.logic.config + + + + + + + + + + + + + + + + + +
    + +
    +
    +
    + +

    Package eu.steffo.cleaver.logic.config

    +
    +
    +
    + + +
    A package containing all possible IConfigs used to configure + ChopJobs.
    +
    +
    + +
    +
    +
    + + + diff --git a/docs/eu.steffo.cleaver/eu/steffo/cleaver/logic/config/package-tree.html b/docs/eu.steffo.cleaver/eu/steffo/cleaver/logic/config/package-tree.html new file mode 100644 index 0000000..7fdf252 --- /dev/null +++ b/docs/eu.steffo.cleaver/eu/steffo/cleaver/logic/config/package-tree.html @@ -0,0 +1,129 @@ + + + + + +eu.steffo.cleaver.logic.config Class Hierarchy + + + + + + + + + + + + + + + + + +
    + +
    +
    +
    +

    Hierarchy For Package eu.steffo.cleaver.logic.config

    +Package Hierarchies: + +
    +
    +
    +

    Class Hierarchy

    + +
    +
    +

    Interface Hierarchy

    + +
    +
    +
    + + + diff --git a/docs/eu.steffo.cleaver/eu/steffo/cleaver/logic/job/ChopJob.html b/docs/eu.steffo.cleaver/eu/steffo/cleaver/logic/job/ChopJob.html new file mode 100644 index 0000000..00a04fd --- /dev/null +++ b/docs/eu.steffo.cleaver/eu/steffo/cleaver/logic/job/ChopJob.html @@ -0,0 +1,586 @@ + + + + + +ChopJob + + + + + + + + + + + + + + + + + +
    + +
    + +
    +
    + + +

    Class ChopJob

    +
    +
    +
    java.lang.Object +
    java.lang.Thread +
    eu.steffo.cleaver.logic.job.Job +
    eu.steffo.cleaver.logic.job.ChopJob
    +
    +
    +
    +
    +
    +
    All Implemented Interfaces:
    +
    Runnable
    +
    +
    +
    public class ChopJob
    +extends Job
    +
    A Job to convert a file into one or more chopped (*.chp + *.cXX) files. + + The conversion is done in steps, which may be skipped if the required configuration is null: +
      +
    1. Compress (if compressConfig is not null)
    2. +
    3. Crypt (if cryptConfig is not null)
    4. +
    5. Split (if splitConfig is not null)
    6. +
    7. *.chp file creation
    8. +
    +
    +
    + +
    +
    + +
    +
    +
    + + + + diff --git a/docs/eu.steffo.cleaver/eu/steffo/cleaver/logic/job/Job.html b/docs/eu.steffo.cleaver/eu/steffo/cleaver/logic/job/Job.html new file mode 100644 index 0000000..f33e09e --- /dev/null +++ b/docs/eu.steffo.cleaver/eu/steffo/cleaver/logic/job/Job.html @@ -0,0 +1,483 @@ + + + + + +Job + + + + + + + + + + + + + + + + + +
    + +
    + +
    +
    + + +

    Class Job

    +
    +
    +
    java.lang.Object +
    java.lang.Thread +
    eu.steffo.cleaver.logic.job.Job
    +
    +
    +
    +
    +
    All Implemented Interfaces:
    +
    Runnable
    +
    +
    +
    Direct Known Subclasses:
    +
    ChopJob, StitchJob
    +
    +
    +
    public abstract class Job
    +extends Thread
    +
    A task that can be executed by Cleaver in a separate Thread, and that keeps track of its progress and can display progress updates on a Swing GUI.
    +
    +
    + +
    +
    + +
    +
    +
    + + + + diff --git a/docs/eu.steffo.cleaver/eu/steffo/cleaver/logic/job/StitchJob.html b/docs/eu.steffo.cleaver/eu/steffo/cleaver/logic/job/StitchJob.html new file mode 100644 index 0000000..00ef8b5 --- /dev/null +++ b/docs/eu.steffo.cleaver/eu/steffo/cleaver/logic/job/StitchJob.html @@ -0,0 +1,530 @@ + + + + + +StitchJob + + + + + + + + + + + + + + + + + +
    + +
    + +
    +
    + + +

    Class StitchJob

    +
    +
    +
    java.lang.Object +
    java.lang.Thread +
    eu.steffo.cleaver.logic.job.Job +
    eu.steffo.cleaver.logic.job.StitchJob
    +
    +
    +
    +
    +
    +
    All Implemented Interfaces:
    +
    Runnable
    +
    +
    +
    public class StitchJob
    +extends Job
    +
    A Job that converts chopped (*.chp + *.cXX) files back into regular files.
    +
    +
    + +
    +
    + +
    +
    +
    + + + + diff --git a/docs/eu.steffo.cleaver/eu/steffo/cleaver/logic/job/package-summary.html b/docs/eu.steffo.cleaver/eu/steffo/cleaver/logic/job/package-summary.html new file mode 100644 index 0000000..560b91a --- /dev/null +++ b/docs/eu.steffo.cleaver/eu/steffo/cleaver/logic/job/package-summary.html @@ -0,0 +1,143 @@ + + + + + +eu.steffo.cleaver.logic.job + + + + + + + + + + + + + + + + + +
    + +
    +
    +
    + +

    Package eu.steffo.cleaver.logic.job

    +
    +
    +
    + + +
    The package containing all possible Jobs.
    +
    +
    +
      +
    • +
      + + + + + + + + + + + + + + + + + + + + + + +
      Class Summary 
      ClassDescription
      ChopJob +
      A Job to convert a file into one or more chopped (*.chp + *.cXX) files.
      +
      Job +
      A task that can be executed by Cleaver in a separate Thread, and that keeps track of its progress and can display progress updates on a Swing GUI.
      +
      StitchJob +
      A Job that converts chopped (*.chp + *.cXX) files back into regular files.
      +
      +
      +
    • +
    +
    +
    +
    + + + diff --git a/docs/eu.steffo.cleaver/eu/steffo/cleaver/logic/job/package-tree.html b/docs/eu.steffo.cleaver/eu/steffo/cleaver/logic/job/package-tree.html new file mode 100644 index 0000000..283ead8 --- /dev/null +++ b/docs/eu.steffo.cleaver/eu/steffo/cleaver/logic/job/package-tree.html @@ -0,0 +1,123 @@ + + + + + +eu.steffo.cleaver.logic.job Class Hierarchy + + + + + + + + + + + + + + + + + +
    + +
    +
    +
    +

    Hierarchy For Package eu.steffo.cleaver.logic.job

    +Package Hierarchies: + +
    +
    +
    +

    Class Hierarchy

    +
      +
    • java.lang.Object +
        +
      • java.lang.Thread (implements java.lang.Runnable) +
          +
        • eu.steffo.cleaver.logic.job.Job + +
        • +
        +
      • +
      +
    • +
    +
    +
    +
    + + + diff --git a/docs/eu.steffo.cleaver/eu/steffo/cleaver/logic/progress/ErrorProgress.html b/docs/eu.steffo.cleaver/eu/steffo/cleaver/logic/progress/ErrorProgress.html index 7de1a7f..e406b84 100644 --- a/docs/eu.steffo.cleaver/eu/steffo/cleaver/logic/progress/ErrorProgress.html +++ b/docs/eu.steffo.cleaver/eu/steffo/cleaver/logic/progress/ErrorProgress.html @@ -2,10 +2,10 @@ - + ErrorProgress - + @@ -21,7 +21,7 @@ - + + + + + + + + + +
    + +
    + +
    +
    + + +

    Class MergeConfig

    +
    +
    +
    java.lang.Object +
    eu.steffo.cleaver.logic.split.SplitConfig +
    eu.steffo.cleaver.logic.split.MergeConfig
    +
    +
    +
    +
    +
    public class MergeConfig
    +extends SplitConfig
    +
    A SplitConfig created by reading a *.chp file, containing the number of parts and their size, but not the resulting file size.
    +
    +
    +
      + +
    • +
      + + +

      Field Summary

      +
      + + + + + + + + + + + + + + + + + + + + + + + + + + +
      Fields 
      Modifier and TypeFieldDescription
      private intparts +
      The number of parts the file was split in.
      +
      private longpartSize +
      The size of the parts the file was split in.
      +
      private longtotalSize +
      The total size of the original file.
      +
      +
      +
      +
    • + +
    • +
      + + +

      Constructor Summary

      +
      + + + + + + + + + + + + + + +
      Constructors 
      ConstructorDescription
      MergeConfig​(long partSize, +int parts, +long totalSize) +
      Construct a new MergeConfig.
      +
      +
      +
      +
    • + +
    • +
      + + +

      Method Summary

      +
      +
      +
      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      Modifier and TypeMethodDescription
      intgetPartCount() 
      longgetPartSize() 
      longgetTotalSize() 
      StringtoString() 
      +
      +
      +
      +

      Methods inherited from class eu.steffo.cleaver.logic.split.SplitConfig

      + + +toElement
      +
      +

      Methods inherited from class java.lang.Object

      + + +clone, equals, getClass, hashCode, notify, notifyAll, wait, wait, wait
      +
      +
    • +
    +
    +
    +
      + +
    • +
      + + +

      Field Details

      +
        +
      • +
        +

        partSize

        +
        private long partSize
        +
        The size of the parts the file was split in.
        +
        +
      • +
      • +
        +

        parts

        +
        private int parts
        +
        The number of parts the file was split in.
        +
        +
      • +
      • +
        +

        totalSize

        +
        private long totalSize
        +
        The total size of the original file.
        +
        +
      • +
      +
      +
    • + +
    • +
      + + +

      Constructor Details

      +
        +
      • +
        +

        MergeConfig

        +
        public MergeConfig​(long partSize, +int parts, +long totalSize)
        +
        Construct a new MergeConfig.
        +
        +
        Parameters:
        +
        partSize - The size of the parts the file was split in.
        +
        parts - The number of parts the file was split in.
        +
        totalSize - The total size of the original file.
        +
        +
        +
      • +
      +
      +
    • + +
    • +
      + + +

      Method Details

      + +
      +
    • +
    +
    +
    +
    + + + + diff --git a/docs/eu.steffo.cleaver/eu/steffo/cleaver/logic/stream/ICleaverStream.html b/docs/eu.steffo.cleaver/eu/steffo/cleaver/logic/stream/ICleaverStream.html new file mode 100644 index 0000000..7d36e06 --- /dev/null +++ b/docs/eu.steffo.cleaver/eu/steffo/cleaver/logic/stream/ICleaverStream.html @@ -0,0 +1,148 @@ + + + + + +ICleaverStream + + + + + + + + + + + + + + + + + +
    + +
    + +
    +
    + + +

    Interface ICleaverStream

    +
    + +
    + + + + diff --git a/docs/eu.steffo.cleaver/eu/steffo/cleaver/logic/stream/input/CleaverCryptInputStream.html b/docs/eu.steffo.cleaver/eu/steffo/cleaver/logic/stream/input/CleaverCryptInputStream.html new file mode 100644 index 0000000..78c14fb --- /dev/null +++ b/docs/eu.steffo.cleaver/eu/steffo/cleaver/logic/stream/input/CleaverCryptInputStream.html @@ -0,0 +1,546 @@ + + + + + +CleaverCryptInputStream + + + + + + + + + + + + + + + + + +
    + +
    + +
    +
    + + +

    Class CleaverCryptInputStream

    +
    +
    +
    java.lang.Object +
    java.io.InputStream +
    java.io.FilterInputStream +
    eu.steffo.cleaver.logic.stream.input.CleaverCryptInputStream
    +
    +
    +
    +
    +
    +
    All Implemented Interfaces:
    +
    ICleaverStream, ICleaverInputStream, Closeable, AutoCloseable
    +
    +
    +
    public class CleaverCryptInputStream
    +extends FilterInputStream
    +implements ICleaverInputStream
    +
    +
    + +
    +
    + +
    +
    +
    + + + + diff --git a/docs/eu.steffo.cleaver/eu/steffo/cleaver/logic/stream/input/CleaverDeflateInputStream.html b/docs/eu.steffo.cleaver/eu/steffo/cleaver/logic/stream/input/CleaverDeflateInputStream.html new file mode 100644 index 0000000..a2a559d --- /dev/null +++ b/docs/eu.steffo.cleaver/eu/steffo/cleaver/logic/stream/input/CleaverDeflateInputStream.html @@ -0,0 +1,257 @@ + + + + + +CleaverDeflateInputStream + + + + + + + + + + + + + + + + + +
    + +
    + +
    +
    + + +

    Class CleaverDeflateInputStream

    +
    +
    +
    java.lang.Object +
    java.io.InputStream +
    java.io.FilterInputStream +
    java.util.zip.InflaterInputStream +
    eu.steffo.cleaver.logic.stream.input.CleaverDeflateInputStream
    +
    +
    +
    +
    +
    +
    +
    All Implemented Interfaces:
    +
    ICleaverStream, ICleaverInputStream, Closeable, AutoCloseable
    +
    +
    +
    public class CleaverDeflateInputStream
    +extends InflaterInputStream
    +implements ICleaverInputStream
    +
    +
    + +
    +
    + +
    +
    +
    + + + + diff --git a/docs/eu.steffo.cleaver/eu/steffo/cleaver/logic/stream/input/CleaverForkFileInputStream.html b/docs/eu.steffo.cleaver/eu/steffo/cleaver/logic/stream/input/CleaverForkFileInputStream.html new file mode 100644 index 0000000..2e1c0a9 --- /dev/null +++ b/docs/eu.steffo.cleaver/eu/steffo/cleaver/logic/stream/input/CleaverForkFileInputStream.html @@ -0,0 +1,440 @@ + + + + + +CleaverForkFileInputStream + + + + + + + + + + + + + + + + + +
    + +
    + +
    +
    + + +

    Class CleaverForkFileInputStream

    +
    +
    +
    java.lang.Object +
    java.io.InputStream +
    eu.steffo.cleaver.logic.stream.input.CleaverForkFileInputStream
    +
    +
    +
    +
    +
    All Implemented Interfaces:
    +
    ICleaverStream, ICleaverInputStream, Closeable, AutoCloseable
    +
    +
    +
    public class CleaverForkFileInputStream
    +extends InputStream
    +implements ICleaverInputStream
    +
    +
    + +
    +
    + +
    +
    +
    + + + + diff --git a/docs/eu.steffo.cleaver/eu/steffo/cleaver/logic/stream/input/CleaverSimpleFileInputStream.html b/docs/eu.steffo.cleaver/eu/steffo/cleaver/logic/stream/input/CleaverSimpleFileInputStream.html new file mode 100644 index 0000000..b471de7 --- /dev/null +++ b/docs/eu.steffo.cleaver/eu/steffo/cleaver/logic/stream/input/CleaverSimpleFileInputStream.html @@ -0,0 +1,273 @@ + + + + + +CleaverSimpleFileInputStream + + + + + + + + + + + + + + + + + +
    + +
    + +
    +
    + + +

    Class CleaverSimpleFileInputStream

    +
    +
    +
    java.lang.Object +
    java.io.InputStream +
    java.io.FileInputStream +
    eu.steffo.cleaver.logic.stream.input.CleaverSimpleFileInputStream
    +
    +
    +
    +
    +
    +
    All Implemented Interfaces:
    +
    ICleaverStream, ICleaverInputStream, Closeable, AutoCloseable
    +
    +
    +
    public class CleaverSimpleFileInputStream
    +extends FileInputStream
    +implements ICleaverInputStream
    +
    +
    + +
    +
    + +
    +
    +
    + + + + diff --git a/docs/eu.steffo.cleaver/eu/steffo/cleaver/logic/stream/input/CleaverSplitFileInputStream.html b/docs/eu.steffo.cleaver/eu/steffo/cleaver/logic/stream/input/CleaverSplitFileInputStream.html new file mode 100644 index 0000000..0051e26 --- /dev/null +++ b/docs/eu.steffo.cleaver/eu/steffo/cleaver/logic/stream/input/CleaverSplitFileInputStream.html @@ -0,0 +1,477 @@ + + + + + +CleaverSplitFileInputStream + + + + + + + + + + + + + + + + + +
    + +
    + +
    +
    + + +

    Class CleaverSplitFileInputStream

    +
    +
    +
    java.lang.Object +
    java.io.InputStream +
    eu.steffo.cleaver.logic.stream.input.CleaverSplitFileInputStream
    +
    +
    +
    +
    +
    All Implemented Interfaces:
    +
    ICleaverStream, ICleaverInputStream, Closeable, AutoCloseable
    +
    +
    +
    public class CleaverSplitFileInputStream
    +extends InputStream
    +implements ICleaverInputStream
    +
    +
    + +
    +
    +
      + +
    • +
      + + +

      Field Details

      + +
      +
    • + +
    • +
      + + +

      Constructor Details

      +
        +
      • +
        +

        CleaverSplitFileInputStream

        +
        public CleaverSplitFileInputStream​(File baseFile, +long maximumByteCount)
        +
        Construct a SplitFileInputStream. + It will read data from the files having the same name as the baseFile and a *.cXX extension.
        +
        +
        Parameters:
        +
        baseFile - The File to be reconstructed.
        +
        maximumByteCount - The number of bytes that should be read from a file before switching to the next one.
        +
        +
        +
      • +
      +
      +
    • + +
    • +
      + + +

      Method Details

      +
        +
      • +
        +

        createNextFileInputStream

        +
        protected void createNextFileInputStream() + throws IOException
        +
        Open the following file in the sequence, and update the currentFileInputStream.
        +
        +
        Throws:
        +
        IOException - If for some reason the program cannot open the file.
        +
        +
        +
      • +
      • +
        +

        read

        +
        public int read() + throws IOException
        +
        +
        Specified by:
        +
        read in class InputStream
        +
        Throws:
        +
        IOException
        +
        +
        +
      • +
      • +
        +

        close

        +
        public void close() + throws IOException
        +
        +
        Specified by:
        +
        close in interface AutoCloseable
        +
        Specified by:
        +
        close in interface Closeable
        +
        Overrides:
        +
        close in class InputStream
        +
        Throws:
        +
        IOException
        +
        +
        +
      • +
      • +
        +

        getBaseFile

        +
        public File getBaseFile()
        +
        Get the base File. + + The stream will read from multiple files having a name constituted by the base File name and a *.cXX extension. + + For example, if it is foo.txt, the stream will read from foo.txt.c1, foo.txt.c2, and so on.
        +
        +
        Returns:
        +
        The base file.
        +
        +
        +
      • +
      • +
        +

        getCurrentByteCount

        +
        public long getCurrentByteCount()
        +
        +
        Returns:
        +
        The number of bytes that have already been read from the current file.
        +
        +
        +
      • +
      • +
        +

        getMaximumByteCount

        +
        public long getMaximumByteCount()
        +
        +
        Returns:
        +
        The number of bytes that should be read from a file before switching to the next one.
        +
        +
        +
      • +
      • +
        +

        getCurrentFileCount

        +
        public int getCurrentFileCount()
        +
        +
        Returns:
        +
        The number of files that have already been read.
        +
        +
        +
      • +
      +
      +
    • +
    +
    +
    +
    + + + + diff --git a/docs/eu.steffo.cleaver/eu/steffo/cleaver/logic/stream/input/ICleaverInputStream.html b/docs/eu.steffo.cleaver/eu/steffo/cleaver/logic/stream/input/ICleaverInputStream.html new file mode 100644 index 0000000..3c0e573 --- /dev/null +++ b/docs/eu.steffo.cleaver/eu/steffo/cleaver/logic/stream/input/ICleaverInputStream.html @@ -0,0 +1,218 @@ + + + + + +ICleaverInputStream + + + + + + + + + + + + + + + + + +
    + +
    + +
    +
    + + +

    Interface ICleaverInputStream

    +
    +
    +
    +
    +
    All Superinterfaces:
    +
    ICleaverStream
    +
    +
    +
    All Known Implementing Classes:
    +
    CleaverCryptInputStream, CleaverDeflateInputStream, CleaverForkFileInputStream, CleaverSimpleFileInputStream, CleaverSplitFileInputStream
    +
    +
    +
    public interface ICleaverInputStream
    +extends ICleaverStream
    +
    +
    +
      + +
    • +
      + + +

      Method Summary

      +
      + + + + + + + + + + + + + + + + +
      Static Methods 
      Modifier and TypeMethodDescription
      static InputStreamfromElement​(Element element, +File chpFileDirectory, +String key) +
      Construct a ICleaverInputStream from a XML tag.
      +
      +
      +
      +
    • +
    +
    +
    + +
    +
    +
    + + + + diff --git a/docs/eu.steffo.cleaver/eu/steffo/cleaver/logic/stream/input/package-summary.html b/docs/eu.steffo.cleaver/eu/steffo/cleaver/logic/stream/input/package-summary.html new file mode 100644 index 0000000..c1b8b9e --- /dev/null +++ b/docs/eu.steffo.cleaver/eu/steffo/cleaver/logic/stream/input/package-summary.html @@ -0,0 +1,159 @@ + + + + + +eu.steffo.cleaver.logic.stream.input + + + + + + + + + + + + + + + + + +
    + +
    +
    +
    + +

    Package eu.steffo.cleaver.logic.stream.input

    +
    +
    +
    + +
    +
    +
    + + + diff --git a/docs/eu.steffo.cleaver/eu/steffo/cleaver/logic/stream/input/package-tree.html b/docs/eu.steffo.cleaver/eu/steffo/cleaver/logic/stream/input/package-tree.html new file mode 100644 index 0000000..a695b0a --- /dev/null +++ b/docs/eu.steffo.cleaver/eu/steffo/cleaver/logic/stream/input/package-tree.html @@ -0,0 +1,144 @@ + + + + + +eu.steffo.cleaver.logic.stream.input Class Hierarchy + + + + + + + + + + + + + + + + + +
    + +
    +
    +
    +

    Hierarchy For Package eu.steffo.cleaver.logic.stream.input

    +Package Hierarchies: + +
    +
    +
    +

    Class Hierarchy

    + +
    +
    +

    Interface Hierarchy

    + +
    +
    +
    + + + diff --git a/docs/eu.steffo.cleaver/eu/steffo/cleaver/logic/stream/output/CleaverCryptOutputStream.html b/docs/eu.steffo.cleaver/eu/steffo/cleaver/logic/stream/output/CleaverCryptOutputStream.html new file mode 100644 index 0000000..4fbe06d --- /dev/null +++ b/docs/eu.steffo.cleaver/eu/steffo/cleaver/logic/stream/output/CleaverCryptOutputStream.html @@ -0,0 +1,620 @@ + + + + + +CleaverCryptOutputStream + + + + + + + + + + + + + + + + + +
    + +
    + +
    +
    + + +

    Class CleaverCryptOutputStream

    +
    +
    +
    java.lang.Object +
    java.io.OutputStream +
    java.io.FilterOutputStream +
    eu.steffo.cleaver.logic.stream.output.CleaverCryptOutputStream
    +
    +
    +
    +
    +
    +
    All Implemented Interfaces:
    +
    ICleaverStream, ICleaverOutputStream, Closeable, Flushable, AutoCloseable
    +
    +
    +
    public class CleaverCryptOutputStream
    +extends FilterOutputStream
    +implements ICleaverOutputStream
    +
    +
    + +
    +
    + +
    +
    +
    + + + + diff --git a/docs/eu.steffo.cleaver/eu/steffo/cleaver/logic/stream/output/CleaverDeflateOutputStream.html b/docs/eu.steffo.cleaver/eu/steffo/cleaver/logic/stream/output/CleaverDeflateOutputStream.html new file mode 100644 index 0000000..ddd2f73 --- /dev/null +++ b/docs/eu.steffo.cleaver/eu/steffo/cleaver/logic/stream/output/CleaverDeflateOutputStream.html @@ -0,0 +1,312 @@ + + + + + +CleaverDeflateOutputStream + + + + + + + + + + + + + + + + + +
    + +
    + +
    +
    + + +

    Class CleaverDeflateOutputStream

    +
    +
    +
    java.lang.Object +
    java.io.OutputStream +
    java.io.FilterOutputStream +
    java.util.zip.DeflaterOutputStream +
    eu.steffo.cleaver.logic.stream.output.CleaverDeflateOutputStream
    +
    +
    +
    +
    +
    +
    +
    All Implemented Interfaces:
    +
    ICleaverStream, ICleaverOutputStream, Closeable, Flushable, AutoCloseable
    +
    +
    +
    public class CleaverDeflateOutputStream
    +extends DeflaterOutputStream
    +implements ICleaverOutputStream
    +
    +
    + +
    +
    + +
    +
    +
    + + + + diff --git a/docs/eu.steffo.cleaver/eu/steffo/cleaver/logic/stream/output/CleaverForkFileOutputStream.html b/docs/eu.steffo.cleaver/eu/steffo/cleaver/logic/stream/output/CleaverForkFileOutputStream.html new file mode 100644 index 0000000..9a28e17 --- /dev/null +++ b/docs/eu.steffo.cleaver/eu/steffo/cleaver/logic/stream/output/CleaverForkFileOutputStream.html @@ -0,0 +1,472 @@ + + + + + +CleaverForkFileOutputStream + + + + + + + + + + + + + + + + + +
    + +
    + +
    +
    + + +

    Class CleaverForkFileOutputStream

    +
    +
    +
    java.lang.Object +
    java.io.OutputStream +
    eu.steffo.cleaver.logic.stream.output.CleaverForkFileOutputStream
    +
    +
    +
    +
    +
    All Implemented Interfaces:
    +
    ICleaverStream, ICleaverOutputStream, Closeable, Flushable, AutoCloseable
    +
    +
    +
    public class CleaverForkFileOutputStream
    +extends OutputStream
    +implements ICleaverOutputStream
    +
    A custom OutputStream that writes the bytes received in input in multiple files with a progressively increasing number (.c1, .c2, .c3, and so on). + + Bytes are written one at a time to the files in a round-robin format until the stream is exausted.
    +
    +
    + +
    +
    +
      + +
    • +
      + + +

      Field Details

      + +
      +
    • + +
    • +
      + + +

      Constructor Details

      +
        +
      • +
        +

        CleaverForkFileOutputStream

        +
        public CleaverForkFileOutputStream​(File baseFile, +int parts) + throws FileNotFoundException
        +
        Construct a CleaverForkFileOutputStream.
        +
        +
        Parameters:
        +
        baseFile - The name of the files without the extension. If it is example, the created files will be example.c1, example.c2, and so on.
        +
        parts - The number of parts to be created.
        +
        Throws:
        +
        FileNotFoundException
        +
        +
        +
      • +
      +
      +
    • + +
    • +
      + + +

      Method Details

      +
        +
      • +
        +

        toElement

        +
        public Element toElement​(Document doc)
        +
        Description copied from interface: ICleaverOutputStream
        +
        Create a Element representing the stream (to be used in *.chp metadata files).
        +
        +
        Specified by:
        +
        toElement in interface ICleaverOutputStream
        +
        Parameters:
        +
        doc - The Document the Element should be created in.
        +
        Returns:
        +
        The created Element.
        +
        +
        +
      • +
      • +
        +

        write

        +
        public void write​(int b) + throws IOException
        +
        +
        Specified by:
        +
        write in class OutputStream
        +
        Throws:
        +
        IOException
        +
        +
        +
      • +
      • +
        +

        close

        +
        public void close() + throws IOException
        +
        +
        Specified by:
        +
        close in interface AutoCloseable
        +
        Specified by:
        +
        close in interface Closeable
        +
        Overrides:
        +
        close in class OutputStream
        +
        Throws:
        +
        IOException
        +
        +
        +
      • +
      • +
        +

        getBaseFile

        +
        public File getBaseFile()
        +
        Get the base File. + + The base File gives the name to all generated files, including the file parts (*.cXX) and the reconstructed file. + + For example, if it is foo.txt, the created files will be foo.txt.c1, foo.txt.c2, and so on.
        +
        +
        Returns:
        +
        The base file.
        +
        +
        +
      • +
      • +
        +

        getPartSize

        +
        public long getPartSize()
        +
        +
        Returns:
        +
        The number of bytes written to each part.
        +
        +
        +
      • +
      • +
        +

        getParts

        +
        public int getParts()
        +
        +
        Returns:
        +
        The number of file parts to create.
        +
        +
        +
      • +
      • +
        +

        getWriteTo

        +
        public int getWriteTo()
        +
        +
        Returns:
        +
        The number of the next file where a byte should be written, from 0 to the number of parts -1.
        +
        +
        +
      • +
      +
      +
    • +
    +
    +
    +
    + + + + diff --git a/docs/eu.steffo.cleaver/eu/steffo/cleaver/logic/stream/output/CleaverSimpleFileOutputStream.html b/docs/eu.steffo.cleaver/eu/steffo/cleaver/logic/stream/output/CleaverSimpleFileOutputStream.html new file mode 100644 index 0000000..ca73a8a --- /dev/null +++ b/docs/eu.steffo.cleaver/eu/steffo/cleaver/logic/stream/output/CleaverSimpleFileOutputStream.html @@ -0,0 +1,351 @@ + + + + + +CleaverSimpleFileOutputStream + + + + + + + + + + + + + + + + + +
    + +
    + +
    +
    + + +

    Class CleaverSimpleFileOutputStream

    +
    +
    +
    java.lang.Object +
    java.io.OutputStream +
    java.io.FileOutputStream +
    eu.steffo.cleaver.logic.stream.output.CleaverSimpleFileOutputStream
    +
    +
    +
    +
    +
    +
    All Implemented Interfaces:
    +
    ICleaverStream, ICleaverOutputStream, Closeable, Flushable, AutoCloseable
    +
    +
    +
    public class CleaverSimpleFileOutputStream
    +extends FileOutputStream
    +implements ICleaverOutputStream
    +
    A custom OutputStream that writes the bytes received in input to a single file with a *.c0 extension.
    +
    +
    See Also:
    +
    FileOutputStream
    +
    +
    +
    + +
    +
    + +
    +
    +
    + + + + diff --git a/docs/eu.steffo.cleaver/eu/steffo/cleaver/logic/stream/output/CleaverSplitFileOutputStream.html b/docs/eu.steffo.cleaver/eu/steffo/cleaver/logic/stream/output/CleaverSplitFileOutputStream.html new file mode 100644 index 0000000..6bceb8c --- /dev/null +++ b/docs/eu.steffo.cleaver/eu/steffo/cleaver/logic/stream/output/CleaverSplitFileOutputStream.html @@ -0,0 +1,503 @@ + + + + + +CleaverSplitFileOutputStream + + + + + + + + + + + + + + + + + +
    + +
    + +
    +
    + + +

    Class CleaverSplitFileOutputStream

    +
    +
    +
    java.lang.Object +
    java.io.OutputStream +
    eu.steffo.cleaver.logic.stream.output.CleaverSplitFileOutputStream
    +
    +
    +
    +
    +
    All Implemented Interfaces:
    +
    ICleaverStream, ICleaverOutputStream, Closeable, Flushable, AutoCloseable
    +
    +
    +
    public class CleaverSplitFileOutputStream
    +extends OutputStream
    +implements ICleaverOutputStream
    +
    A custom OutputStream that writes the bytes received in input in multiple files with a progressively increasing number (.c1, .c2, .c3, and so on). + + Bytes are written to a file until its length reaches maximumByteCount, then the program switches to the following file (.c2 if .c1 is full, .c3 if .c2 is full, and so on).
    +
    +
    + +
    +
    + +
    +
    +
    + + + + diff --git a/docs/eu.steffo.cleaver/eu/steffo/cleaver/logic/stream/output/ICleaverOutputStream.html b/docs/eu.steffo.cleaver/eu/steffo/cleaver/logic/stream/output/ICleaverOutputStream.html new file mode 100644 index 0000000..05954e4 --- /dev/null +++ b/docs/eu.steffo.cleaver/eu/steffo/cleaver/logic/stream/output/ICleaverOutputStream.html @@ -0,0 +1,217 @@ + + + + + +ICleaverOutputStream + + + + + + + + + + + + + + + + + +
    + +
    + +
    +
    + + +

    Interface ICleaverOutputStream

    +
    +
    +
    +
    +
    All Superinterfaces:
    +
    ICleaverStream
    +
    +
    +
    All Known Implementing Classes:
    +
    CleaverCryptOutputStream, CleaverDeflateOutputStream, CleaverForkFileOutputStream, CleaverSimpleFileOutputStream, CleaverSplitFileOutputStream
    +
    +
    +
    public interface ICleaverOutputStream
    +extends ICleaverStream
    +
    +
    +
      + +
    • +
      + + +

      Method Summary

      +
      +
      +
      + + + + + + + + + + + + + + + +
      Modifier and TypeMethodDescription
      ElementtoElement​(Document doc) +
      Create a Element representing the stream (to be used in *.chp metadata files).
      +
      +
      +
      +
      +
    • +
    +
    +
    + +
    +
    +
    + + + + diff --git a/docs/eu.steffo.cleaver/eu/steffo/cleaver/logic/stream/output/package-summary.html b/docs/eu.steffo.cleaver/eu/steffo/cleaver/logic/stream/output/package-summary.html new file mode 100644 index 0000000..d2581b4 --- /dev/null +++ b/docs/eu.steffo.cleaver/eu/steffo/cleaver/logic/stream/output/package-summary.html @@ -0,0 +1,165 @@ + + + + + +eu.steffo.cleaver.logic.stream.output + + + + + + + + + + + + + + + + + +
    + +
    +
    +
    + +

    Package eu.steffo.cleaver.logic.stream.output

    +
    +
    +
    + +
    +
    +
    + + + diff --git a/docs/eu.steffo.cleaver/eu/steffo/cleaver/logic/stream/output/package-tree.html b/docs/eu.steffo.cleaver/eu/steffo/cleaver/logic/stream/output/package-tree.html new file mode 100644 index 0000000..c4cea1d --- /dev/null +++ b/docs/eu.steffo.cleaver/eu/steffo/cleaver/logic/stream/output/package-tree.html @@ -0,0 +1,144 @@ + + + + + +eu.steffo.cleaver.logic.stream.output Class Hierarchy + + + + + + + + + + + + + + + + + +
    + +
    +
    +
    +

    Hierarchy For Package eu.steffo.cleaver.logic.stream.output

    +Package Hierarchies: + +
    +
    +
    +

    Class Hierarchy

    + +
    +
    +

    Interface Hierarchy

    + +
    +
    +
    + + + diff --git a/docs/eu.steffo.cleaver/eu/steffo/cleaver/logic/stream/package-summary.html b/docs/eu.steffo.cleaver/eu/steffo/cleaver/logic/stream/package-summary.html new file mode 100644 index 0000000..aa9bf72 --- /dev/null +++ b/docs/eu.steffo.cleaver/eu/steffo/cleaver/logic/stream/package-summary.html @@ -0,0 +1,124 @@ + + + + + +eu.steffo.cleaver.logic.stream + + + + + + + + + + + + + + + + + +
    + +
    +
    +
    + +

    Package eu.steffo.cleaver.logic.stream

    +
    +
    +
    +
      +
    • +
      + + + + + + + + + + + + + + +
      Interface Summary 
      InterfaceDescription
      ICleaverStream 
      +
      +
    • +
    +
    +
    +
    + + + diff --git a/docs/eu.steffo.cleaver/eu/steffo/cleaver/logic/stream/package-tree.html b/docs/eu.steffo.cleaver/eu/steffo/cleaver/logic/stream/package-tree.html new file mode 100644 index 0000000..de0709a --- /dev/null +++ b/docs/eu.steffo.cleaver/eu/steffo/cleaver/logic/stream/package-tree.html @@ -0,0 +1,110 @@ + + + + + +eu.steffo.cleaver.logic.stream Class Hierarchy + + + + + + + + + + + + + + + + + +
    + +
    +
    +
    +

    Hierarchy For Package eu.steffo.cleaver.logic.stream

    +Package Hierarchies: + +
    +
    +
    +

    Interface Hierarchy

    + +
    +
    +
    + + + diff --git a/docs/eu.steffo.cleaver/eu/steffo/cleaver/logic/utils/SaltSerializer.html b/docs/eu.steffo.cleaver/eu/steffo/cleaver/logic/utils/SaltSerializer.html new file mode 100644 index 0000000..b30283a --- /dev/null +++ b/docs/eu.steffo.cleaver/eu/steffo/cleaver/logic/utils/SaltSerializer.html @@ -0,0 +1,260 @@ + + + + + +SaltSerializer + + + + + + + + + + + + + + + + + +
    + +
    + +
    +
    + + +

    Class SaltSerializer

    +
    +
    +
    java.lang.Object +
    eu.steffo.cleaver.logic.utils.SaltSerializer
    +
    +
    +
    +
    public class SaltSerializer
    +extends Object
    +
    +
    + +
    +
    +
      + +
    • +
      + + +

      Constructor Details

      + +
      +
    • + +
    • +
      + + +

      Method Details

      + +
      +
    • +
    +
    +
    +
    + + + + diff --git a/docs/eu.steffo.cleaver/eu/steffo/cleaver/logic/utils/package-summary.html b/docs/eu.steffo.cleaver/eu/steffo/cleaver/logic/utils/package-summary.html new file mode 100644 index 0000000..2522ed9 --- /dev/null +++ b/docs/eu.steffo.cleaver/eu/steffo/cleaver/logic/utils/package-summary.html @@ -0,0 +1,124 @@ + + + + + +eu.steffo.cleaver.logic.utils + + + + + + + + + + + + + + + + + +
    + +
    +
    +
    + +

    Package eu.steffo.cleaver.logic.utils

    +
    +
    +
    +
      +
    • +
      + + + + + + + + + + + + + + +
      Class Summary 
      ClassDescription
      SaltSerializer 
      +
      +
    • +
    +
    +
    +
    + + + diff --git a/docs/eu.steffo.cleaver/eu/steffo/cleaver/logic/utils/package-tree.html b/docs/eu.steffo.cleaver/eu/steffo/cleaver/logic/utils/package-tree.html new file mode 100644 index 0000000..92656ce --- /dev/null +++ b/docs/eu.steffo.cleaver/eu/steffo/cleaver/logic/utils/package-tree.html @@ -0,0 +1,114 @@ + + + + + +eu.steffo.cleaver.logic.utils Class Hierarchy + + + + + + + + + + + + + + + + + +
    + +
    +
    +
    +

    Hierarchy For Package eu.steffo.cleaver.logic.utils

    +Package Hierarchies: + +
    +
    +
    +

    Class Hierarchy

    + +
    +
    +
    + + + diff --git a/docs/eu.steffo.cleaver/eu/steffo/cleaver/package-summary.html b/docs/eu.steffo.cleaver/eu/steffo/cleaver/package-summary.html index ae2c0d8..bca6504 100644 --- a/docs/eu.steffo.cleaver/eu/steffo/cleaver/package-summary.html +++ b/docs/eu.steffo.cleaver/eu/steffo/cleaver/package-summary.html @@ -2,10 +2,10 @@ - + eu.steffo.cleaver - + @@ -77,7 +77,7 @@ $('.navPadding').css('padding-top', $('.fixedNav').css("height")); It contains all the runnable functions (currently only Main), and all other packages.
    See Also:
    -
    eu.steffo.cleaver.logic, +
    eu.steffo.cleaver.logic, eu.steffo.cleaver.gui, eu.steffo.cleaver.errors
    @@ -101,10 +101,6 @@ $('.navPadding').css('padding-top', $('.fixedNav').css("height"));
    The class containing the main function.
    - -Test -  - diff --git a/docs/eu.steffo.cleaver/eu/steffo/cleaver/package-tree.html b/docs/eu.steffo.cleaver/eu/steffo/cleaver/package-tree.html index 71332ee..3faa014 100644 --- a/docs/eu.steffo.cleaver/eu/steffo/cleaver/package-tree.html +++ b/docs/eu.steffo.cleaver/eu/steffo/cleaver/package-tree.html @@ -2,10 +2,10 @@ - + eu.steffo.cleaver Class Hierarchy - + @@ -79,7 +79,6 @@ $('.navPadding').css('padding-top', $('.fixedNav').css("height"));
  • java.lang.Object
    • eu.steffo.cleaver.Main
    • -
    • eu.steffo.cleaver.Test
  • diff --git a/docs/eu.steffo.cleaver/module-summary.html b/docs/eu.steffo.cleaver/module-summary.html index 880ed48..cfff514 100644 --- a/docs/eu.steffo.cleaver/module-summary.html +++ b/docs/eu.steffo.cleaver/module-summary.html @@ -2,10 +2,10 @@ - + eu.steffo.cleaver - + @@ -21,7 +21,7 @@ - + + + + + + + + + +
    + +
    +
    +
    +

    Index

    +
    +
    B C D E F G I J K M N O P R S T U W 
    All Classes All Packages + + +

    W

    +
    +
    WorkingProgress - Class in eu.steffo.cleaver.logic.progress
    +
    +
    A Progress that specifies that a Job is currently running and has progressed to WorkingProgress.progress %.
    +
    +
    WorkingProgress() - Constructor for class eu.steffo.cleaver.logic.progress.WorkingProgress
    +
    +
    Create a new WorkingProgress at 0%.
    +
    +
    WorkingProgress(float) - Constructor for class eu.steffo.cleaver.logic.progress.WorkingProgress
    +
    +
    Create a new WorkingProgress at a specific percentage.
    +
    +
    write(int) - Method in class eu.steffo.cleaver.logic.stream.output.CleaverCryptOutputStream
    +
     
    +
    write(int) - Method in class eu.steffo.cleaver.logic.stream.output.CleaverForkFileOutputStream
    +
     
    +
    write(int) - Method in class eu.steffo.cleaver.logic.stream.output.CleaverSplitFileOutputStream
    +
     
    +
    writeTo - Variable in class eu.steffo.cleaver.logic.stream.input.CleaverForkFileInputStream
    +
     
    +
    writeTo - Variable in class eu.steffo.cleaver.logic.stream.output.CleaverForkFileOutputStream
    +
     
    +
    +B C D E F G I J K M N O P R S T U W 
    All Classes All Packages
    +
    + + + diff --git a/docs/index-files/index-2.html b/docs/index-files/index-2.html index e1d4df3..753b7bc 100644 --- a/docs/index-files/index-2.html +++ b/docs/index-files/index-2.html @@ -2,11 +2,11 @@ - -D-Index + +C-Index - - + + @@ -68,17 +68,266 @@ $('.navPadding').css('padding-top', $('.fixedNav').css("height"));

    Index

    -
    C D E F G I J K M N O P R S T U W 
    All Classes All Packages +
    B C D E F G I J K M N O P R S T U W 
    All Classes All Packages -

    D

    +

    C

    -
    deleteButton - Variable in class eu.steffo.cleaver.gui.panels.JobsButtonsPanel
    +
    ChopAndStitchPanel - Class in eu.steffo.cleaver.gui.panels
    -
    The Delete selected jobs button.
    +
    This panel displays a ChopPanel and a StitchPanel horizontally side-by-side.
    +
    +
    ChopAndStitchPanel(ActionListener, ActionListener) - Constructor for class eu.steffo.cleaver.gui.panels.ChopAndStitchPanel
    +
    +
    Construct a ChopAndStitchPanel by instantiating and adding a ChopPanel and a StitchPanel to it.
    +
    +
    ChopJob - Class in eu.steffo.cleaver.logic.job
    +
    +
    A Job to convert a file into one or more chopped (*.chp + *.cXX) files.
    +
    +
    ChopJob(File, ICompressConfig, ICryptConfig, ISplitConfig) - Constructor for class eu.steffo.cleaver.logic.job.ChopJob
    +
    +
    Create a new ChopJob (without progress updates support).
    +
    +
    ChopJob(File, ICompressConfig, ICryptConfig, ISplitConfig, Runnable) - Constructor for class eu.steffo.cleaver.logic.job.ChopJob
    +
    +
    Create a new ChopJob (with progress updates support).
    +
    +
    chopPanel - Variable in class eu.steffo.cleaver.gui.panels.ChopAndStitchPanel
    +
    +
    The ChopPanel, displayed on the left.
    +
    +
    ChopPanel - Class in eu.steffo.cleaver.gui.panels
    +
    +
    The CreateJobPanel allowing the creation of ChopJobs.
    +
    +
    ChopPanel(ActionListener) - Constructor for class eu.steffo.cleaver.gui.panels.ChopPanel
    +
    +
    Construct a ChopPanel.
    +
    +
    chopStitchPanel - Variable in class eu.steffo.cleaver.gui.CleaverFrame
    +
    +
    The panel allowing the creation of new Jobs.
    +
    +
    chpDocument - Variable in class eu.steffo.cleaver.logic.job.StitchJob
    +
     
    +
    ChpFileError - Exception in eu.steffo.cleaver.errors
    +
    +
    An error occoured during the parsing of a .chp file.
    +
    +
    ChpFileError(String) - Constructor for exception eu.steffo.cleaver.errors.ChpFileError
    +
     
    +
    chpFolder - Variable in class eu.steffo.cleaver.logic.job.StitchJob
    +
     
    +
    cipher - Variable in class eu.steffo.cleaver.logic.stream.input.CleaverCryptInputStream
    +
     
    +
    cipher - Variable in class eu.steffo.cleaver.logic.stream.output.CleaverCryptOutputStream
    +
     
    +
    clearSelectedFiles() - Method in class eu.steffo.cleaver.gui.panels.rows.FileSelectRow
    +
    +
    Clear the files selected in the FileSelectRow.fileChooser, and update the text displayed.
    +
    +
    CleaverCryptInputStream - Class in eu.steffo.cleaver.logic.stream.input
    +
     
    +
    CleaverCryptInputStream(InputStream, char[], byte[], byte[]) - Constructor for class eu.steffo.cleaver.logic.stream.input.CleaverCryptInputStream
    +
     
    +
    CleaverCryptOutputStream - Class in eu.steffo.cleaver.logic.stream.output
    +
     
    +
    CleaverCryptOutputStream(OutputStream, char[]) - Constructor for class eu.steffo.cleaver.logic.stream.output.CleaverCryptOutputStream
    +
    +
    Create a new CleaverCryptOutputStream with default Cipher parameters (AES algorithm in operation mode CFB8 with PKCS5 padding).
    +
    +
    CleaverDeflateInputStream - Class in eu.steffo.cleaver.logic.stream.input
    +
     
    +
    CleaverDeflateInputStream(InputStream) - Constructor for class eu.steffo.cleaver.logic.stream.input.CleaverDeflateInputStream
    +
    +
    Construct a new CleaverDeflateInputStream and ensure the passed InputStream implements ICleaverInputStream.
    +
    +
    CleaverDeflateOutputStream - Class in eu.steffo.cleaver.logic.stream.output
    +
     
    +
    CleaverDeflateOutputStream(OutputStream) - Constructor for class eu.steffo.cleaver.logic.stream.output.CleaverDeflateOutputStream
    +
    +
    Construct a new CleaverDeflateOutputStream and ensure the passed OutputStream implements ICleaverOutputStream.
    +
    +
    CleaverForkFileInputStream - Class in eu.steffo.cleaver.logic.stream.input
    +
     
    +
    CleaverForkFileInputStream(File, int) - Constructor for class eu.steffo.cleaver.logic.stream.input.CleaverForkFileInputStream
    +
     
    +
    CleaverForkFileOutputStream - Class in eu.steffo.cleaver.logic.stream.output
    +
    +
    A custom OutputStream that writes the bytes received in input in multiple files with a progressively increasing number (.c1, .c2, .c3, and so on).
    +
    +
    CleaverForkFileOutputStream(File, int) - Constructor for class eu.steffo.cleaver.logic.stream.output.CleaverForkFileOutputStream
    +
    +
    Construct a CleaverForkFileOutputStream.
    +
    +
    CleaverFrame - Class in eu.steffo.cleaver.gui
    +
    +
    A class providing a GUI for Cleaver made with javax.swing.
    +
    +
    CleaverFrame(ArrayList<Job>) - Constructor for class eu.steffo.cleaver.gui.CleaverFrame
    +
    +
    Construct the CleaverFrame by setting its fields and adding to it the panels it should contain.
    +
    +
    CleaverSimpleFileInputStream - Class in eu.steffo.cleaver.logic.stream.input
    +
     
    +
    CleaverSimpleFileInputStream(File) - Constructor for class eu.steffo.cleaver.logic.stream.input.CleaverSimpleFileInputStream
    +
     
    +
    CleaverSimpleFileOutputStream - Class in eu.steffo.cleaver.logic.stream.output
    +
    +
    A custom OutputStream that writes the bytes received in input to a single file with a *.c0 extension.
    +
    +
    CleaverSimpleFileOutputStream(File) - Constructor for class eu.steffo.cleaver.logic.stream.output.CleaverSimpleFileOutputStream
    +
     
    +
    CleaverSplitFileInputStream - Class in eu.steffo.cleaver.logic.stream.input
    +
     
    +
    CleaverSplitFileInputStream(File, long) - Constructor for class eu.steffo.cleaver.logic.stream.input.CleaverSplitFileInputStream
    +
    +
    Construct a SplitFileInputStream.
    +
    +
    CleaverSplitFileOutputStream - Class in eu.steffo.cleaver.logic.stream.output
    +
    +
    A custom OutputStream that writes the bytes received in input in multiple files with a progressively increasing number (.c1, .c2, .c3, and so on).
    +
    +
    CleaverSplitFileOutputStream(File, long) - Constructor for class eu.steffo.cleaver.logic.stream.output.CleaverSplitFileOutputStream
    +
    +
    Construct a CleaverSplitFileOutputStream.
    +
    +
    close() - Method in class eu.steffo.cleaver.logic.stream.input.CleaverForkFileInputStream
    +
     
    +
    close() - Method in class eu.steffo.cleaver.logic.stream.input.CleaverSplitFileInputStream
    +
     
    +
    close() - Method in class eu.steffo.cleaver.logic.stream.output.CleaverForkFileOutputStream
    +
     
    +
    close() - Method in class eu.steffo.cleaver.logic.stream.output.CleaverSplitFileOutputStream
    +
     
    +
    compressConfig - Variable in class eu.steffo.cleaver.logic.job.ChopJob
    +
    +
    The IConfig for the Compress step.
    +
    +
    compressionCheckBox - Variable in class eu.steffo.cleaver.gui.panels.rows.option.CompressRow
    +
    +
    The checkbox enabling or disabling the crypt step.
    +
    +
    compressRow - Variable in class eu.steffo.cleaver.gui.panels.ChopPanel
    +
    +
    The Row to enable/disable the compression functionality.
    +
    +
    CompressRow - Class in eu.steffo.cleaver.gui.panels.rows.option
    +
    +
    A OptionRow allowing the configuration of the compress step of the file chop process.
    +
    +
    CompressRow() - Constructor for class eu.steffo.cleaver.gui.panels.rows.option.CompressRow
    +
    +
    Construct a CompressRow.
    +
    +
    createAndAddChopJobs(ArrayList<Job>, Runnable) - Method in class eu.steffo.cleaver.gui.panels.ChopAndStitchPanel
    +
    +
    Propagate downwards the click of the Create Jobs button on the ChopAndStitchPanel.chopPanel.
    +
    +
    createAndAddJobs(ArrayList<Job>, Runnable) - Method in class eu.steffo.cleaver.gui.panels.ChopPanel
    +
    +
    Add to the jobs ArrayList the ChopJobs for the current settings.
    +
    +
    createAndAddJobs(ArrayList<Job>, Runnable) - Method in class eu.steffo.cleaver.gui.panels.StitchPanel
    +
    +
    Add to the jobs ArrayList the StitchJobs for the current settings.
    +
    +
    createAndAddStitchJobs(ArrayList<Job>, Runnable) - Method in class eu.steffo.cleaver.gui.panels.ChopAndStitchPanel
    +
    +
    Propagate downwards the click of the Create Jobs button on the ChopAndStitchPanel.stitchPanel.
    +
    +
    createChpFile(OutputStream) - Method in class eu.steffo.cleaver.logic.job.ChopJob
    +
    +
    Generate the element tree by calling the ICleaverOutputStream.toElement(Document) method on the passed OutputStream and by writing the + results on a file with a Transformer.
    +
    +
    createCompressOutputStream(OutputStream) - Method in class eu.steffo.cleaver.logic.job.ChopJob
    +
    +
    Create a OutputStream based on the ChopJob.compressConfig of this ChopJob.
    +
    +
    createCryptOutputStream(OutputStream) - Method in class eu.steffo.cleaver.logic.job.ChopJob
    +
    +
    Create a OutputStream based on the ChopJob.cryptConfig of this ChopJob.
    +
    +
    createJobButton - Variable in class eu.steffo.cleaver.gui.panels.rows.CreateJobButtonRow
    +
     
    +
    createJobButtonRow - Variable in class eu.steffo.cleaver.gui.panels.ChopPanel
    +
    +
    The Row containing the button to create the ChopJobs.
    +
    +
    createJobButtonRow - Variable in class eu.steffo.cleaver.gui.panels.StitchPanel
    +
    +
    The Row containing the button to create the StitchJobs.
    +
    +
    CreateJobButtonRow - Class in eu.steffo.cleaver.gui.panels.rows
    +
    +
    A Row with a clickable JButton.
    +
    +
    CreateJobButtonRow(ActionListener) - Constructor for class eu.steffo.cleaver.gui.panels.rows.CreateJobButtonRow
    +
    +
    Construct a CreateJobButtonRow.
    +
    +
    CreateJobPanel - Class in eu.steffo.cleaver.gui.panels
    +
    +
    The base class for the two job creation panels (ChopPanel and StitchPanel).
    +
    +
    CreateJobPanel() - Constructor for class eu.steffo.cleaver.gui.panels.CreateJobPanel
    +
    +
    Construct the job panel by setting its layout, adding a border, the TitleRow and the FileSelectRow.
    +
    +
    createNextFileInputStream() - Method in class eu.steffo.cleaver.logic.stream.input.CleaverSplitFileInputStream
    +
    +
    Open the following file in the sequence, and update the CleaverSplitFileInputStream.currentFileInputStream.
    +
    +
    createNextFileOutputStream() - Method in class eu.steffo.cleaver.logic.stream.output.CleaverSplitFileOutputStream
    +
    +
    Create the following file in the sequence, and update the CleaverSplitFileOutputStream.currentFileOutputStream.
    +
    +
    createSplitOutputStream() - Method in class eu.steffo.cleaver.logic.job.ChopJob
    +
    +
    Create a OutputStream based on the ChopJob.splitConfig of this ChopJob.
    +
    +
    cryptCheckBox - Variable in class eu.steffo.cleaver.gui.panels.rows.option.CryptRow
    +
    +
    The checkbox enabling or disabling the crypt step.
    +
    +
    cryptConfig - Variable in class eu.steffo.cleaver.logic.job.ChopJob
    +
    +
    The IConfig for the Crypt step.
    +
    +
    cryptKey - Variable in class eu.steffo.cleaver.logic.job.StitchJob
    +
     
    +
    cryptRow - Variable in class eu.steffo.cleaver.gui.panels.ChopPanel
    +
    +
    The Row to enable/disable the encryption functionality.
    +
    +
    CryptRow - Class in eu.steffo.cleaver.gui.panels.rows.option
    +
    +
    A OptionRow allowing the configuration of the crypt step of the file chop process.
    +
    +
    CryptRow() - Constructor for class eu.steffo.cleaver.gui.panels.rows.option.CryptRow
    +
    +
    Construct a CryptRow.
    +
    +
    currentByteCount - Variable in class eu.steffo.cleaver.logic.stream.input.CleaverSplitFileInputStream
    +
     
    +
    currentByteCount - Variable in class eu.steffo.cleaver.logic.stream.output.CleaverSplitFileOutputStream
    +
     
    +
    currentFileCount - Variable in class eu.steffo.cleaver.logic.stream.input.CleaverSplitFileInputStream
    +
     
    +
    currentFileCount - Variable in class eu.steffo.cleaver.logic.stream.output.CleaverSplitFileOutputStream
    +
     
    +
    currentFileInputStream - Variable in class eu.steffo.cleaver.logic.stream.input.CleaverSplitFileInputStream
    +
    +
    The FileInputStream this InputStream is currently reading from.
    +
    +
    currentFileOutputStream - Variable in class eu.steffo.cleaver.logic.stream.output.CleaverSplitFileOutputStream
    +
    +
    The FileOutputStream this OutputStream is currently writing to.
    -C D E F G I J K M N O P R S T U W 
    All Classes All Packages
    +B C D E F G I J K M N O P R S T U W 
    All Classes All Packages

    Interface Hierarchy

    diff --git a/docs/serialized-form.html b/docs/serialized-form.html index 40de540..5e30fef 100644 --- a/docs/serialized-form.html +++ b/docs/serialized-form.html @@ -2,7 +2,7 @@ - + Serialized Form @@ -85,7 +85,7 @@ $('.navPadding').css('padding-top', $('.fixedNav').css("height"));
    -

    Class eu.steffo.cleaver.errors.ProgrammingError extends Exception implements Serializable

    +

    Class eu.steffo.cleaver.errors.ProgrammingError extends RuntimeException implements Serializable

    diff --git a/src/eu/steffo/cleaver/errors/ChpFileError.java b/src/eu/steffo/cleaver/errors/ChpFileError.java index 43b8899..be486f8 100644 --- a/src/eu/steffo/cleaver/errors/ChpFileError.java +++ b/src/eu/steffo/cleaver/errors/ChpFileError.java @@ -1,7 +1,7 @@ package eu.steffo.cleaver.errors; /** - * An error in the parsing of the {@literal .chp} file occoured. + * An error occoured during the parsing of a {@literal .chp} file. */ public class ChpFileError extends Exception { public ChpFileError(String s) { diff --git a/src/eu/steffo/cleaver/errors/ProgrammingError.java b/src/eu/steffo/cleaver/errors/ProgrammingError.java index 3659ef1..ce9a18b 100644 --- a/src/eu/steffo/cleaver/errors/ProgrammingError.java +++ b/src/eu/steffo/cleaver/errors/ProgrammingError.java @@ -1,11 +1,13 @@ package eu.steffo.cleaver.errors; /** - * An exception that should never be thrown during the execution of the program. + * An exception that is never supposed to happen during the execution of the program. * * It is thrown when an exception that should never be thrown is caught, such as {@link javax.xml.parsers.ParserConfigurationException}. + * + * As they are never supposed to happen, they don't need to be caught, therefore they extend {@link RuntimeException}. */ -public class ProgrammingError extends Exception { +public class ProgrammingError extends RuntimeException { public ProgrammingError(String s) { super(s); } diff --git a/src/eu/steffo/cleaver/errors/package-info.java b/src/eu/steffo/cleaver/errors/package-info.java index 65bee57..b91d827 100644 --- a/src/eu/steffo/cleaver/errors/package-info.java +++ b/src/eu/steffo/cleaver/errors/package-info.java @@ -1,4 +1,4 @@ /** - * A package containing all possible exceptions thrown by Cleaver. + * A package containing all possible {@link java.lang.Error Errors} and {@link java.lang.Exception Exceptions} thrown by Cleaver. */ -package eu.steffo.cleaver.errors; \ No newline at end of file +package eu.steffo.cleaver.errors; diff --git a/src/eu/steffo/cleaver/gui/panels/ChopPanel.java b/src/eu/steffo/cleaver/gui/panels/ChopPanel.java index 8e4de2e..5cf7bf4 100644 --- a/src/eu/steffo/cleaver/gui/panels/ChopPanel.java +++ b/src/eu/steffo/cleaver/gui/panels/ChopPanel.java @@ -95,7 +95,7 @@ public class ChopPanel extends CreateJobPanel { ICompressConfig zc = compressRow.getCompressConfig(); - Job job = new ChopJob(file, sc, cc, zc, onProgressChange); + Job job = new ChopJob(file, zc, cc, sc, onProgressChange); jobs.add(job); } diff --git a/src/eu/steffo/cleaver/gui/panels/JobsTablePanel.java b/src/eu/steffo/cleaver/gui/panels/JobsTablePanel.java index f6954e1..ba006e6 100644 --- a/src/eu/steffo/cleaver/gui/panels/JobsTablePanel.java +++ b/src/eu/steffo/cleaver/gui/panels/JobsTablePanel.java @@ -4,8 +4,6 @@ import eu.steffo.cleaver.logic.job.Job; import javax.swing.*; import javax.swing.table.AbstractTableModel; -import javax.swing.table.TableColumn; -import javax.swing.table.TableColumnModel; import java.awt.*; import java.util.ArrayList; @@ -54,7 +52,7 @@ public class JobsTablePanel extends JPanel { switch(columnIndex) { case 0: return "Type"; case 1: return "File"; - case 2: return "Process"; + case 2: return "Operations"; case 3: return "Progress"; } return null; @@ -79,9 +77,9 @@ public class JobsTablePanel extends JPanel { case 1: return job.getFileString(); case 2: - return job.getProcessString(); + return job.getOperationsString(); case 3: - return job.getProgress().toString(); + return job.getProgressString(); } return "Unknown"; } diff --git a/src/eu/steffo/cleaver/gui/panels/StitchPanel.java b/src/eu/steffo/cleaver/gui/panels/StitchPanel.java index ca1328f..d7e8c89 100644 --- a/src/eu/steffo/cleaver/gui/panels/StitchPanel.java +++ b/src/eu/steffo/cleaver/gui/panels/StitchPanel.java @@ -67,9 +67,8 @@ public class StitchPanel extends CreateJobPanel { try { Job job = new StitchJob(file, keyOptionRow.getKey(), onProgressChange); jobs.add(job); - } catch (ChpFileError ex) { - JOptionPane.showMessageDialog(null, ex.getMessage(), "Error", JOptionPane.ERROR_MESSAGE); - } catch (ProgrammingError ex) { + } catch (Throwable ex) { + ex.printStackTrace(); JOptionPane.showMessageDialog(null, ex.toString(), "Error", JOptionPane.ERROR_MESSAGE); } } diff --git a/src/eu/steffo/cleaver/logic/config/DeflateConfig.java b/src/eu/steffo/cleaver/logic/config/DeflateConfig.java index 7361b0f..b4a1688 100644 --- a/src/eu/steffo/cleaver/logic/config/DeflateConfig.java +++ b/src/eu/steffo/cleaver/logic/config/DeflateConfig.java @@ -1,7 +1,7 @@ package eu.steffo.cleaver.logic.config; /** - * A {@link IConfig} for compressing a file with the Deflate algorithm. + * A {@link ICompressConfig} requesting a compression with the Deflate algorithm. */ public class DeflateConfig implements ICompressConfig { @Override diff --git a/src/eu/steffo/cleaver/logic/config/ICompressConfig.java b/src/eu/steffo/cleaver/logic/config/ICompressConfig.java index f95cf3a..766671d 100644 --- a/src/eu/steffo/cleaver/logic/config/ICompressConfig.java +++ b/src/eu/steffo/cleaver/logic/config/ICompressConfig.java @@ -1,7 +1,7 @@ package eu.steffo.cleaver.logic.config; /** - * A {@link IConfig} for the Compress step of the {@link eu.steffo.cleaver.logic.job.ChopJob Chop}/{@link eu.steffo.cleaver.logic.job.StitchJob Stitch} process. + * A {@link IConfig} generated by a {@link eu.steffo.cleaver.gui.panels.rows.option.CompressRow CompressRow}. */ public interface ICompressConfig extends IConfig { } diff --git a/src/eu/steffo/cleaver/logic/config/IConfig.java b/src/eu/steffo/cleaver/logic/config/IConfig.java index a322cdf..00e9010 100644 --- a/src/eu/steffo/cleaver/logic/config/IConfig.java +++ b/src/eu/steffo/cleaver/logic/config/IConfig.java @@ -1,14 +1,16 @@ package eu.steffo.cleaver.logic.config; -import eu.steffo.cleaver.logic.job.Job; - /** - * An interface for the configuration of a step of a {@link Job Job}. + * A configuration generated by a {@link eu.steffo.cleaver.gui.panels.rows.option.OptionRow OptionRow} to configure a step of a + * {@link eu.steffo.cleaver.logic.job.ChopJob ChopJob}. */ public interface IConfig { /** - * @return The string representation of the {@link IConfig}, to be used in the jobs table. - * @see eu.steffo.cleaver.gui.panels.JobsTablePanel + * Get the string representation of the step, to be displayed in the Operations column of the + * {@link eu.steffo.cleaver.gui.panels.JobsTablePanel JobsTablePanel}. + * + * @return The string to be displated. */ + @Override String toString(); } diff --git a/src/eu/steffo/cleaver/logic/config/ICryptConfig.java b/src/eu/steffo/cleaver/logic/config/ICryptConfig.java index 35bcbe5..ab2a5a6 100644 --- a/src/eu/steffo/cleaver/logic/config/ICryptConfig.java +++ b/src/eu/steffo/cleaver/logic/config/ICryptConfig.java @@ -1,7 +1,7 @@ package eu.steffo.cleaver.logic.config; /** - * A {@link IConfig} for the Crypt step of the {@link eu.steffo.cleaver.logic.job.ChopJob Chop}/{@link eu.steffo.cleaver.logic.job.StitchJob Stitch} process. + * A {@link IConfig} generated by a {@link eu.steffo.cleaver.gui.panels.rows.option.CryptRow CryptRow}. */ public interface ICryptConfig extends IConfig { } diff --git a/src/eu/steffo/cleaver/logic/config/ISplitConfig.java b/src/eu/steffo/cleaver/logic/config/ISplitConfig.java index 56b790a..85df393 100644 --- a/src/eu/steffo/cleaver/logic/config/ISplitConfig.java +++ b/src/eu/steffo/cleaver/logic/config/ISplitConfig.java @@ -1,7 +1,7 @@ package eu.steffo.cleaver.logic.config; /** - * A {@link IConfig} for the Split step of the {@link eu.steffo.cleaver.logic.job.ChopJob Chop}/{@link eu.steffo.cleaver.logic.job.StitchJob Stitch} process. + * A {@link IConfig} generated by a {@link eu.steffo.cleaver.gui.panels.rows.option.SplitRow SplitRow}. */ public interface ISplitConfig extends IConfig { } diff --git a/src/eu/steffo/cleaver/logic/config/PartsConfig.java b/src/eu/steffo/cleaver/logic/config/PartsConfig.java index 410fc02..baa29da 100644 --- a/src/eu/steffo/cleaver/logic/config/PartsConfig.java +++ b/src/eu/steffo/cleaver/logic/config/PartsConfig.java @@ -1,7 +1,7 @@ package eu.steffo.cleaver.logic.config; /** - * A {@link IConfig} for splitting a file in a specific number of parts. + * A {@link ISplitConfig} requesting the split of a file in a specific number of {@link #parts}. */ public class PartsConfig implements ISplitConfig { /** @@ -16,13 +16,16 @@ public class PartsConfig implements ISplitConfig { public PartsConfig(int parts) { this.parts = parts; } + /** + * @return The number of parts the file should be split in. + */ + public int getPartCount() { + return parts; + } @Override public String toString() { return String.format("Split (%d parts)", this.parts); } - public int getPartCount() { - return parts; - } } diff --git a/src/eu/steffo/cleaver/logic/config/PasswordConfig.java b/src/eu/steffo/cleaver/logic/config/PasswordConfig.java index d37e8b2..eb2669c 100644 --- a/src/eu/steffo/cleaver/logic/config/PasswordConfig.java +++ b/src/eu/steffo/cleaver/logic/config/PasswordConfig.java @@ -1,24 +1,27 @@ package eu.steffo.cleaver.logic.config; /** - * A config for encrypting a file with an arbitrary length password. + * A {@link ICryptConfig} requesting the encryption of a file using a specific {@link #password}. */ public class PasswordConfig implements ICryptConfig { - protected final String key; + /** + * The password to be used in the encryption. + */ + private final String password; /** - * Construct a new CryptConfig with a specific encryption key. - * @param key The encryption key. + * Construct a new PasswordConfig with a specific password. + * @param key The password to be used in the encryption. */ public PasswordConfig(String key) { - this.key = key; + this.password = key; } /** - * @return The encryption key. + * @return The password to be used in the encryption. */ - public String getKey() { - return key; + public String getPassword() { + return password; } @Override diff --git a/src/eu/steffo/cleaver/logic/config/SizeConfig.java b/src/eu/steffo/cleaver/logic/config/SizeConfig.java index d6064c4..a9f2e97 100644 --- a/src/eu/steffo/cleaver/logic/config/SizeConfig.java +++ b/src/eu/steffo/cleaver/logic/config/SizeConfig.java @@ -1,28 +1,31 @@ package eu.steffo.cleaver.logic.config; /** - * A {@link IConfig} for splitting a file in parts of a specific part size. + * A {@link ISplitConfig} requesting the split of a file in parts of a specific {@link #size size}. */ public class SizeConfig implements ISplitConfig { /** - * The size of the parts to split the file in. + * The size (in bytes) of a single part. */ - private long partSize; + private long size; /** - * Construct a new SplitBySizeConfig. - * @param partSize The size of the parts to split the file in. + * Construct a new SizeConfig. + * @param size The size (in bytes) of a single part. */ - public SizeConfig(long partSize) { - this.partSize = partSize; + public SizeConfig(long size) { + this.size = size; + } + + /** + * @return The size (in bytes) of a single part. + */ + public long getSize() { + return size; } @Override public String toString() { - return String.format("Split (%d bytes)", this.partSize); - } - - public long getPartSize() { - return partSize; + return String.format("Split (%d bytes)", this.size); } } diff --git a/src/eu/steffo/cleaver/logic/config/package-info.java b/src/eu/steffo/cleaver/logic/config/package-info.java new file mode 100644 index 0000000..61c8095 --- /dev/null +++ b/src/eu/steffo/cleaver/logic/config/package-info.java @@ -0,0 +1,5 @@ +/** + * A package containing all possible {@link eu.steffo.cleaver.logic.config.IConfig IConfigs} used to configure + * {@link eu.steffo.cleaver.logic.job.ChopJob ChopJobs}. + */ +package eu.steffo.cleaver.logic.config; diff --git a/src/eu/steffo/cleaver/logic/job/ChopJob.java b/src/eu/steffo/cleaver/logic/job/ChopJob.java index a58df33..e2622d9 100644 --- a/src/eu/steffo/cleaver/logic/job/ChopJob.java +++ b/src/eu/steffo/cleaver/logic/job/ChopJob.java @@ -1,62 +1,86 @@ package eu.steffo.cleaver.logic.job; -import eu.steffo.cleaver.errors.ProgrammingError; +import eu.steffo.cleaver.errors.*; import eu.steffo.cleaver.logic.config.*; import eu.steffo.cleaver.logic.stream.output.*; -import eu.steffo.cleaver.logic.progress.ErrorProgress; -import eu.steffo.cleaver.logic.progress.FinishedProgress; -import eu.steffo.cleaver.logic.progress.Progress; -import eu.steffo.cleaver.logic.progress.WorkingProgress; -import org.w3c.dom.Document; -import org.w3c.dom.Element; +import eu.steffo.cleaver.logic.progress.*; import javax.xml.parsers.DocumentBuilder; import javax.xml.parsers.DocumentBuilderFactory; import javax.xml.parsers.ParserConfigurationException; import javax.xml.transform.Transformer; +import javax.xml.transform.TransformerConfigurationException; +import javax.xml.transform.TransformerException; import javax.xml.transform.TransformerFactory; import javax.xml.transform.dom.DOMSource; import javax.xml.transform.stream.StreamResult; import java.io.*; +import org.w3c.dom.Document; +import org.w3c.dom.Element; /** - * A {@link Job} that converts regular files into chopped (*.chp + *.cXX) files. + * A {@link Job} to convert a file into one or more chopped (*.chp + *.cXX) files. + * + * The conversion is done in steps, which may be skipped if the required configuration is {@code null}: + *
      + *
    1. Compress (if {@link #compressConfig} is not {@code null})
    2. + *
    3. Crypt (if {@link #cryptConfig} is not {@code null})
    4. + *
    5. Split (if {@link #splitConfig} is not {@code null})
    6. + *
    7. *.chp file creation
    8. + *
    */ public class ChopJob extends Job { - private final File file; - private final ISplitConfig splitConfig; + /** + * The file to chop. + */ + private final File fileToChop; + + /** + * The {@link IConfig} for the Crypt step. + */ private final ICryptConfig cryptConfig; + + /** + * The {@link IConfig} for the Compress step. + */ private final ICompressConfig compressConfig; + + /** + * The {@link IConfig} for the Split step. + */ + private final ISplitConfig splitConfig; + /** * Create a new ChopJob (with progress updates support). - * @param file The file to be chopped. - * @param splitConfig The configuration for the Split step. - * @param cryptConfig The configuration for the Crypt step. - * @param compressConfig The configuration for the Compress step. - * @param onProgressChange A {@link Runnable} that should be invoked when {@link #setProgress(Progress)} is called. + * @param fileToChop The file to chop. + * @param compressConfig The {@link IConfig} for the Compress step. + * @param cryptConfig The {@link IConfig} for the Crypt step. + * @param splitConfig The {@link IConfig} for the Split step. + * @param onProgressChange A {@link Runnable} that will be invoked on the GUI {@link Thread} + * (with {@link javax.swing.SwingUtilities#invokeLater(Runnable)}) every time {@link #setProgress(Progress)} is called. * @see Job#Job(Runnable) */ - public ChopJob(File file, ISplitConfig splitConfig, ICryptConfig cryptConfig, ICompressConfig compressConfig, Runnable onProgressChange) { + public ChopJob(File fileToChop, ICompressConfig compressConfig, ICryptConfig cryptConfig, ISplitConfig splitConfig, Runnable onProgressChange) { super(onProgressChange); - this.file = file.getAbsoluteFile(); - this.splitConfig = splitConfig; - this.cryptConfig = cryptConfig; + this.fileToChop = fileToChop.getAbsoluteFile(); this.compressConfig = compressConfig; + this.cryptConfig = cryptConfig; + this.splitConfig = splitConfig; } /** * Create a new ChopJob (without progress updates support). - * @param file The file to be chopped. - * @param splitConfig The configuration for the Split step. - * @param cryptConfig The configuration for the Crypt step. - * @param compressConfig The configuration for the Compress step. - * @see ChopJob#ChopJob(File, ISplitConfig, ICryptConfig, ICompressConfig, Runnable) + * @param fileToChop The file to chop. + * @param compressConfig The {@link IConfig} for the Compress step. + * @param cryptConfig The {@link IConfig} for the Crypt step. + * @param splitConfig The {@link IConfig} for the Split step. + * @see ChopJob#ChopJob(File, ICompressConfig, ICryptConfig, ISplitConfig, Runnable) * @see Job#Job() */ - public ChopJob(File file, ISplitConfig splitConfig, ICryptConfig cryptConfig, ICompressConfig compressConfig) { - this(file, splitConfig, cryptConfig, compressConfig, null); + public ChopJob(File fileToChop, ICompressConfig compressConfig, ICryptConfig cryptConfig, ISplitConfig splitConfig) { + this(fileToChop, compressConfig, cryptConfig, splitConfig, null); } @Override @@ -66,11 +90,11 @@ public class ChopJob extends Job { @Override public String getFileString() { - return file.toString(); + return fileToChop.toString(); } @Override - public String getProcessString() { + public String getOperationsString() { StringBuilder s = new StringBuilder(); if(compressConfig != null) { @@ -94,41 +118,99 @@ public class ChopJob extends Job { return s.toString(); } + /** + * Create a {@link OutputStream} based on the {@link #splitConfig} of this ChopJob. + * + * The {@link OutputStream} will be the sink of the stream chain created in {@link #run()}. + * + * @return The created {@link OutputStream}. + * @throws FileNotFoundException If one or more files cannot be created (for example, a directory with the same name is present). + * @see CleaverSplitFileOutputStream + * @see CleaverForkFileOutputStream + * @see CleaverSimpleFileOutputStream + */ + protected OutputStream createSplitOutputStream() throws FileNotFoundException { + if(splitConfig instanceof SizeConfig) { + return new CleaverSplitFileOutputStream(fileToChop, ((SizeConfig)splitConfig).getSize()); + } + else if(splitConfig instanceof PartsConfig) { + return new CleaverForkFileOutputStream(fileToChop, ((PartsConfig)splitConfig).getPartCount()); + } + return new CleaverSimpleFileOutputStream(fileToChop); + } + + /** + * Create a {@link OutputStream} based on the {@link #compressConfig} of this ChopJob. + * + * The created {@link OutputStream} will wrap the {@link OutputStream} passed as parameter, creating a chain of streams. + * + * @param sourceOutputStream The {@link OutputStream} that should be wrapped. + * @return The created {@link OutputStream}, wrapping the one that was passed as parameter. + * @see CleaverDeflateOutputStream + */ + protected OutputStream createCompressOutputStream(OutputStream sourceOutputStream) { + if(compressConfig instanceof DeflateConfig) { + return new CleaverDeflateOutputStream(sourceOutputStream); + } + return sourceOutputStream; + } + + /** + * Create a {@link OutputStream} based on the {@link #cryptConfig} of this ChopJob. + * + * The created {@link OutputStream} will wrap the {@link OutputStream} passed as parameter, creating a chain of streams. + * + * @param sourceOutputStream The {@link OutputStream} that should be wrapped. + * @return The created {@link OutputStream}, wrapping the one that was passed as parameter. + * @see CleaverCryptOutputStream + */ + protected OutputStream createCryptOutputStream(OutputStream sourceOutputStream) { + if(cryptConfig instanceof PasswordConfig) { + return new CleaverCryptOutputStream(sourceOutputStream, ((PasswordConfig)cryptConfig).getPassword().toCharArray()); + } + return sourceOutputStream; + } + + /** + * Generate the element tree by calling the {@link ICleaverOutputStream#toElement(Document)} method on the passed {@link OutputStream} and by writing the + * results on a file with a {@link Transformer}. + * @param outputStream The {@link OutputStream} to create the *.chp file for. + */ + protected void createChpFile(OutputStream outputStream) { + DocumentBuilderFactory factory = DocumentBuilderFactory.newInstance(); + DocumentBuilder builder; + try { + builder = factory.newDocumentBuilder(); + } catch (ParserConfigurationException e) { + throw new ProgrammingError("Parser configuration error in the ChopJob."); + } + Document doc = builder.newDocument(); + Element root = doc.createElement("Cleaver"); + doc.appendChild(root); + + root.appendChild(((ICleaverOutputStream)outputStream).toElement(doc)); + + TransformerFactory transformerFactory = TransformerFactory.newInstance(); + Transformer transformer = null; + try { + transformer = transformerFactory.newTransformer(); + } catch (TransformerConfigurationException e) { + throw new ProgrammingError(e.toString()); + } + DOMSource source = new DOMSource(doc); + StreamResult result = new StreamResult(String.format("%s.chp", fileToChop.getAbsolutePath())); + try { + transformer.transform(source, result); + } catch (TransformerException e) { + throw new ProgrammingError(e.toString()); + } + } + @Override public void run() { try { - InputStream inputStream = new FileInputStream(file); - OutputStream outputStream; - - if(splitConfig instanceof SizeConfig) { - outputStream = new CleaverSplitFileOutputStream(file, ((SizeConfig)splitConfig).getPartSize()); - } - else if(splitConfig instanceof PartsConfig) { - outputStream = new CleaverForkFileOutputStream(file, ((PartsConfig)splitConfig).getPartCount()); - } - else { - outputStream = new CleaverSimpleFileOutputStream(file); - } - - if(compressConfig instanceof DeflateConfig) { - outputStream = new CleaverDeflateOutputStream(outputStream); - } - - if(cryptConfig instanceof PasswordConfig) { - outputStream = new CleaverCryptOutputStream(outputStream, ((PasswordConfig)cryptConfig).getKey().toCharArray()); - } - - //Create the .chp file - DocumentBuilderFactory factory = DocumentBuilderFactory.newInstance(); - DocumentBuilder builder; - try { - builder = factory.newDocumentBuilder(); - } catch (ParserConfigurationException e) { - throw new ProgrammingError("Parser configuration error in the ChopJob."); - } - Document doc = builder.newDocument(); - Element root = doc.createElement("Cleaver"); - doc.appendChild(root); + InputStream inputStream = new FileInputStream(fileToChop); + OutputStream outputStream = createCryptOutputStream(createCompressOutputStream(createSplitOutputStream())); //Pipe everything to the output int bytesUntilNextUpdate = 2048; @@ -139,7 +221,7 @@ public class ChopJob extends Job { outputStream.write(i); bytesUntilNextUpdate -= 1; if(bytesUntilNextUpdate <= 0) { - this.setProgress(new WorkingProgress((float)(file.length() - inputStream.available()) / (float)file.length())); + this.setProgress(new WorkingProgress((float)(fileToChop.length() - inputStream.available()) / (float) fileToChop.length())); bytesUntilNextUpdate = 2048; } } @@ -147,13 +229,7 @@ public class ChopJob extends Job { inputStream.close(); outputStream.close(); - root.appendChild(((ICleaverOutputStream)outputStream).toElement(doc)); - - TransformerFactory transformerFactory = TransformerFactory.newInstance(); - Transformer transformer = transformerFactory.newTransformer(); - DOMSource source = new DOMSource(doc); - StreamResult result = new StreamResult(String.format("%s.chp", file.getAbsolutePath())); - transformer.transform(source, result); + createChpFile(outputStream); this.setProgress(new FinishedProgress()); } catch (Throwable e) { diff --git a/src/eu/steffo/cleaver/logic/job/Job.java b/src/eu/steffo/cleaver/logic/job/Job.java index dbc42b9..c7ac9dc 100644 --- a/src/eu/steffo/cleaver/logic/job/Job.java +++ b/src/eu/steffo/cleaver/logic/job/Job.java @@ -3,30 +3,40 @@ package eu.steffo.cleaver.logic.job; import java.io.File; import javax.swing.SwingUtilities; -import eu.steffo.cleaver.logic.config.*; -import eu.steffo.cleaver.logic.progress.NotStartedProgress; -import eu.steffo.cleaver.logic.progress.Progress; +import eu.steffo.cleaver.logic.progress.*; /** - * A {@link Thread} that allows access to the basic . + * A task that can be executed by Cleaver in a separate {@link Thread}, and that keeps track of its progress and can display progress updates on a Swing GUI. */ public abstract class Job extends Thread { - + /** + * The current {@link Progress} of the job. + * @see NotStartedProgress + * @see WorkingProgress + * @see FinishedProgress + * @see ErrorProgress + */ private Progress progress; + + /** + * A {@link Runnable} that will be invoked on the GUI {@link Thread} (with {@link SwingUtilities#invokeLater(Runnable)}) every time + * {@link #setProgress(Progress)} is called. + */ private Runnable onProgressChange = null; /** - * Construct a Job, setting its progress to {@link NotStartedProgress Not started}. + * Construct a Job and set its progress to {@link NotStartedProgress Not started}. */ public Job() { this.progress = new NotStartedProgress(); } /** - * Construct a Job, then add to it a {@link Runnable} that will be invoked through {@link SwingUtilities#invokeLater(Runnable) invokeLater} on progress - * changes. - * @param onProgressChange A {@link Runnable} that should be invoked when {@link #setProgress(Progress)} is called. - * @see Job() + * Construct a Job, set its progress to {@link NotStartedProgress Not started} and set the {@link Runnable} that will be called on the GUI {@link Thread} + * every time the progress changes. + * + * @param onProgressChange A {@link Runnable} that will be invoked on the GUI {@link Thread} (with {@link SwingUtilities#invokeLater(Runnable)}) every time + * {@link #setProgress(Progress)} is called. */ public Job(Runnable onProgressChange) { this(); @@ -37,31 +47,16 @@ public abstract class Job extends Thread { } /** - * @return The current progress of the job. - * @see eu.steffo.cleaver.logic.progress.NotStartedProgress - * @see eu.steffo.cleaver.logic.progress.WorkingProgress - * @see eu.steffo.cleaver.logic.progress.FinishedProgress - * @see eu.steffo.cleaver.logic.progress.ErrorProgress + * @return The current {@link Progress} of the job. + * @see NotStartedProgress + * @see WorkingProgress + * @see FinishedProgress + * @see ErrorProgress */ public Progress getProgress() { return progress; } - /** - * @return The {@link String} that should be displayed in the Type column of the {@link eu.steffo.cleaver.gui.panels.JobsTablePanel Jobs Table}. - */ - public abstract String getTypeString(); - - /** - * @return The {@link String} that should be displayed in the File column of the {@link eu.steffo.cleaver.gui.panels.JobsTablePanel Jobs Table}. - */ - public abstract String getFileString(); - - /** - * @return The {@link String} that should be displayed in the Process column of the {@link eu.steffo.cleaver.gui.panels.JobsTablePanel Jobs Table}. - */ - public abstract String getProcessString(); - /** * Set the progress of the job to a different value. * @@ -78,10 +73,29 @@ public abstract class Job extends Thread { } /** - * The function that is run on a different thread when {@link Thread#start()} is called. - * - * Child classes should override {@link Thread#run()}. + * @return The {@link String} that should be displayed in the Type column of the {@link eu.steffo.cleaver.gui.panels.JobsTablePanel Jobs Table}. */ + public abstract String getTypeString(); + + /** + * @return The {@link String} that should be displayed in the File column of the {@link eu.steffo.cleaver.gui.panels.JobsTablePanel Jobs Table}. + */ + public abstract String getFileString(); + + /** + * @return The {@link String} that should be displayed in the Operations column of the + * {@link eu.steffo.cleaver.gui.panels.JobsTablePanel Jobs Table}. + */ + public abstract String getOperationsString(); + + /** + * @return The {@link String} that should be displayed in the Progress column of the {@link eu.steffo.cleaver.gui.panels.JobsTablePanel Jobs Table}. + */ + public String getProgressString() { + return progress.toString(); + } + @Override public abstract void run(); } + diff --git a/src/eu/steffo/cleaver/logic/job/StitchJob.java b/src/eu/steffo/cleaver/logic/job/StitchJob.java index f38c6d6..b495a5d 100644 --- a/src/eu/steffo/cleaver/logic/job/StitchJob.java +++ b/src/eu/steffo/cleaver/logic/job/StitchJob.java @@ -33,7 +33,7 @@ public class StitchJob extends Job { * Construct a StitchJob, specifying the *.chp file to import the settings from. * @param file The *.chp file. * @throws ChpFileError If there's an error while parsing the *.chp file. - * @throws ProgrammingError It shouldn't be thrown, but it isn't caught to allow its display in the GUI if it actually happens. + * @throws ProgrammingError It should never be thrown, but it may happen if there's a bug in the program... */ public StitchJob(File file) throws ChpFileError, ProgrammingError { this(file, null, null); @@ -44,7 +44,7 @@ public class StitchJob extends Job { * @param file The *.chp file. * @param cryptKey The encryption key to use while decrypting the files. * @throws ChpFileError If there's an error while parsing the *.chp file. - * @throws ProgrammingError It shouldn't be thrown, but it isn't caught to allow its display in the GUI if it actually happens. + * @throws ProgrammingError It should never be thrown, but it may happen if there's a bug in the program... * @see #StitchJob(File) */ public StitchJob(File file, String cryptKey) throws ChpFileError, ProgrammingError { @@ -57,7 +57,7 @@ public class StitchJob extends Job { * @param cryptKey The encryption key to use while decrypting the files. * @param updateTable The {@link Runnable} that should be invoked when {@link #setProgress(Progress)} is called. * @throws ChpFileError If there's an error while parsing the *.chp file. - * @throws ProgrammingError It shouldn't be thrown, but it isn't caught to allow its display in the GUI if it actually happens. + * @throws ProgrammingError It should never be thrown, but it may happen if there's a bug in the program... * @see #StitchJob(File, String) * @see Job#Job(Runnable) */ @@ -83,7 +83,7 @@ public class StitchJob extends Job { } @Override - public String getProcessString() { + public String getOperationsString() { Element element = (Element)(chpDocument.getDocumentElement().getFirstChild()); StringBuilder s = new StringBuilder(); @@ -128,7 +128,7 @@ public class StitchJob extends Job { * @param chpFile The file to create a {@link Document} from. * @return The created {@link Document}. * @throws ChpFileError If the .chp does not exist, or is corrupt. - * @throws ProgrammingError It should never happen, as the parser should be already configured correctly. + * @throws ProgrammingError It should never be thrown, but it may happen if there's a bug in the program... */ protected static Document getChpFileDocument(File chpFile) throws ChpFileError, ProgrammingError { DocumentBuilderFactory factory = DocumentBuilderFactory.newInstance(); diff --git a/src/eu/steffo/cleaver/logic/stream/input/CleaverCryptInputStream.java b/src/eu/steffo/cleaver/logic/stream/input/CleaverCryptInputStream.java index fb444a7..7ac781f 100644 --- a/src/eu/steffo/cleaver/logic/stream/input/CleaverCryptInputStream.java +++ b/src/eu/steffo/cleaver/logic/stream/input/CleaverCryptInputStream.java @@ -40,7 +40,7 @@ public class CleaverCryptInputStream extends FilterInputStream implements ICleav private final int saltSize = 8; /** - * The name of the key derivation algorithm to be used (Password-Based Key Derivation Function 2 with HMAC-Password-Based Key Derivation Function 2 with HMAC-SHA512). */ private final String keyDerivationAlgorithm = "PBKDF2WithHmacSHA512"; diff --git a/src/eu/steffo/cleaver/logic/stream/output/CleaverCryptOutputStream.java b/src/eu/steffo/cleaver/logic/stream/output/CleaverCryptOutputStream.java index 515805f..9750669 100644 --- a/src/eu/steffo/cleaver/logic/stream/output/CleaverCryptOutputStream.java +++ b/src/eu/steffo/cleaver/logic/stream/output/CleaverCryptOutputStream.java @@ -45,7 +45,7 @@ public class CleaverCryptOutputStream extends FilterOutputStream implements ICle private final int saltSize = 8; /** - * The name of the key derivation algorithm to be used (Password-Based Key Derivation Function 2 with HMAC-Password-Based Key Derivation Function 2 with HMAC-SHA512). */ private final String keyDerivationAlgorithm = "PBKDF2WithHmacSHA512";