Issue#42 improved javadoc
This commit is contained in:
parent
258503d079
commit
b4e41dd549
@ -31,11 +31,13 @@
|
|||||||
<mkdir dir="bin"/>
|
<mkdir dir="bin"/>
|
||||||
<copy includeemptydirs="false" todir="bin">
|
<copy includeemptydirs="false" todir="bin">
|
||||||
<fileset dir="src">
|
<fileset dir="src">
|
||||||
|
<exclude name="**/*.launch"/>
|
||||||
<exclude name="**/*.java"/>
|
<exclude name="**/*.java"/>
|
||||||
</fileset>
|
</fileset>
|
||||||
</copy>
|
</copy>
|
||||||
<copy includeemptydirs="false" todir="bin">
|
<copy includeemptydirs="false" todir="bin">
|
||||||
<fileset dir="test">
|
<fileset dir="test">
|
||||||
|
<exclude name="**/*.launch"/>
|
||||||
<exclude name="**/*.java"/>
|
<exclude name="**/*.java"/>
|
||||||
</fileset>
|
</fileset>
|
||||||
</copy>
|
</copy>
|
||||||
|
@ -55,6 +55,7 @@ public class AboutDialog extends JDialog
|
|||||||
* This is the constructor for the dialog.
|
* This is the constructor for the dialog.
|
||||||
*
|
*
|
||||||
* @throws IOException
|
* @throws IOException
|
||||||
|
* IOException
|
||||||
*/
|
*/
|
||||||
public AboutDialog() throws IOException
|
public AboutDialog() throws IOException
|
||||||
{
|
{
|
||||||
|
@ -60,6 +60,9 @@ public class BackupPanel extends JPanel
|
|||||||
|
|
||||||
/**
|
/**
|
||||||
* This is the constructor for this panel.
|
* This is the constructor for this panel.
|
||||||
|
*
|
||||||
|
* @throws SibaException
|
||||||
|
* specific exception
|
||||||
*/
|
*/
|
||||||
public BackupPanel() throws SibaException
|
public BackupPanel() throws SibaException
|
||||||
{
|
{
|
||||||
@ -207,6 +210,7 @@ public class BackupPanel extends JPanel
|
|||||||
/**
|
/**
|
||||||
*
|
*
|
||||||
* @param sourceDirectory
|
* @param sourceDirectory
|
||||||
|
* the source Directory
|
||||||
*/
|
*/
|
||||||
public void setSourceDirectory(final String sourceDirectory)
|
public void setSourceDirectory(final String sourceDirectory)
|
||||||
{
|
{
|
||||||
|
@ -26,6 +26,7 @@ public class CheckDirectorySelector extends JFileChooser
|
|||||||
/**
|
/**
|
||||||
*
|
*
|
||||||
* @param targetFile
|
* @param targetFile
|
||||||
|
* target file
|
||||||
*/
|
*/
|
||||||
public CheckDirectorySelector(final File targetFile)
|
public CheckDirectorySelector(final File targetFile)
|
||||||
{
|
{
|
||||||
@ -89,7 +90,10 @@ public class CheckDirectorySelector extends JFileChooser
|
|||||||
* This method is the main one of the selector.
|
* This method is the main one of the selector.
|
||||||
*
|
*
|
||||||
* @param parent
|
* @param parent
|
||||||
* @return
|
* The parent's component
|
||||||
|
* @param targetFile
|
||||||
|
* target file
|
||||||
|
* @return the selected file
|
||||||
*/
|
*/
|
||||||
public static File showSelectorDialog(final Component parent, final File targetFile)
|
public static File showSelectorDialog(final Component parent, final File targetFile)
|
||||||
{
|
{
|
||||||
|
@ -62,6 +62,8 @@ public class CheckPanel extends JPanel
|
|||||||
|
|
||||||
/**
|
/**
|
||||||
*
|
*
|
||||||
|
* @throws SibaException
|
||||||
|
* specific exception
|
||||||
*/
|
*/
|
||||||
public CheckPanel() throws SibaException
|
public CheckPanel() throws SibaException
|
||||||
{
|
{
|
||||||
@ -168,6 +170,7 @@ public class CheckPanel extends JPanel
|
|||||||
/**
|
/**
|
||||||
*
|
*
|
||||||
* @param sourceDirectory
|
* @param sourceDirectory
|
||||||
|
* the source directory
|
||||||
*/
|
*/
|
||||||
public void setFileToCheck(final String sourceDirectory)
|
public void setFileToCheck(final String sourceDirectory)
|
||||||
{
|
{
|
||||||
|
@ -321,6 +321,7 @@ public final class SibaGUI
|
|||||||
* This method set the local language.
|
* This method set the local language.
|
||||||
*
|
*
|
||||||
* @param source
|
* @param source
|
||||||
|
* locale
|
||||||
*/
|
*/
|
||||||
public static void updateLanguage(final Locale source)
|
public static void updateLanguage(final Locale source)
|
||||||
{
|
{
|
||||||
|
@ -23,6 +23,8 @@ public class SourceDirectorySelector extends JFileChooser
|
|||||||
|
|
||||||
/**
|
/**
|
||||||
*
|
*
|
||||||
|
* @param targetFile
|
||||||
|
* target file
|
||||||
*/
|
*/
|
||||||
public SourceDirectorySelector(final File targetFile)
|
public SourceDirectorySelector(final File targetFile)
|
||||||
{
|
{
|
||||||
@ -85,7 +87,10 @@ public class SourceDirectorySelector extends JFileChooser
|
|||||||
* This method is the main one of the selector.
|
* This method is the main one of the selector.
|
||||||
*
|
*
|
||||||
* @param parent
|
* @param parent
|
||||||
* @return
|
* the parent's component
|
||||||
|
* @param targetFile
|
||||||
|
* target file
|
||||||
|
* @return the selected file
|
||||||
*/
|
*/
|
||||||
public static File showSelectorDialog(final Component parent, final File targetFile)
|
public static File showSelectorDialog(final Component parent, final File targetFile)
|
||||||
{
|
{
|
||||||
|
@ -23,6 +23,8 @@ public class TargetDirectorySelector extends JFileChooser
|
|||||||
|
|
||||||
/**
|
/**
|
||||||
*
|
*
|
||||||
|
* @param targetFile
|
||||||
|
* target file
|
||||||
*/
|
*/
|
||||||
public TargetDirectorySelector(final File targetFile)
|
public TargetDirectorySelector(final File targetFile)
|
||||||
{
|
{
|
||||||
@ -87,7 +89,10 @@ public class TargetDirectorySelector extends JFileChooser
|
|||||||
* This method is the main one of the selector.
|
* This method is the main one of the selector.
|
||||||
*
|
*
|
||||||
* @param parent
|
* @param parent
|
||||||
* @return
|
* the parent's component
|
||||||
|
* @param targetFile
|
||||||
|
* target file
|
||||||
|
* @return the selected file
|
||||||
*/
|
*/
|
||||||
public static File showSelectorDialog(final Component parent, final File targetFile)
|
public static File showSelectorDialog(final Component parent, final File targetFile)
|
||||||
{
|
{
|
||||||
|
@ -55,9 +55,11 @@ public final class SibaUtils
|
|||||||
* the file on which the md5 is calculate
|
* the file on which the md5 is calculate
|
||||||
* @param target
|
* @param target
|
||||||
* the MD5 file
|
* the MD5 file
|
||||||
* @return
|
* @return the MD5 file
|
||||||
* @throws IOException
|
* @throws IOException
|
||||||
|
* IOException
|
||||||
* @throws NoSuchAlgorithmException
|
* @throws NoSuchAlgorithmException
|
||||||
|
* NoSuchAlgorithmException
|
||||||
*/
|
*/
|
||||||
public static File createMD5File(final File inputFile, final String target)
|
public static File createMD5File(final File inputFile, final String target)
|
||||||
throws IOException, NoSuchAlgorithmException
|
throws IOException, NoSuchAlgorithmException
|
||||||
@ -75,10 +77,14 @@ public final class SibaUtils
|
|||||||
/**
|
/**
|
||||||
*
|
*
|
||||||
* @param md5
|
* @param md5
|
||||||
|
* Hash MD5
|
||||||
* @param fileName
|
* @param fileName
|
||||||
|
* The name of the file
|
||||||
* @param target
|
* @param target
|
||||||
* @return
|
* directory to put the file
|
||||||
|
* @return The MD5 file
|
||||||
* @throws IOException
|
* @throws IOException
|
||||||
|
* IOexception
|
||||||
*/
|
*/
|
||||||
public static File createMD5File(final String md5, final String fileName, final String target) throws IOException
|
public static File createMD5File(final String md5, final String fileName, final String target) throws IOException
|
||||||
{
|
{
|
||||||
@ -107,8 +113,10 @@ public final class SibaUtils
|
|||||||
/**
|
/**
|
||||||
*
|
*
|
||||||
* @param choosenFile
|
* @param choosenFile
|
||||||
* @return
|
* the file to check
|
||||||
|
* @return The MD5sum
|
||||||
* @throws IOException
|
* @throws IOException
|
||||||
|
* IOException
|
||||||
*/
|
*/
|
||||||
public static String loadMD5Sum(final File choosenFile) throws IOException
|
public static String loadMD5Sum(final File choosenFile) throws IOException
|
||||||
{
|
{
|
||||||
@ -141,9 +149,12 @@ public final class SibaUtils
|
|||||||
* This method calculate the MD5 itself.
|
* This method calculate the MD5 itself.
|
||||||
*
|
*
|
||||||
* @param input
|
* @param input
|
||||||
* @return
|
* The name of the file for witch the MD5 sum is to calculate
|
||||||
|
* @return The MD5Sum
|
||||||
* @throws IOException
|
* @throws IOException
|
||||||
|
* IOException
|
||||||
* @throws NoSuchAlgorithmException
|
* @throws NoSuchAlgorithmException
|
||||||
|
* NoSuchAlgorithmException
|
||||||
*/
|
*/
|
||||||
public static String md5(final File input) throws IOException, NoSuchAlgorithmException
|
public static String md5(final File input) throws IOException, NoSuchAlgorithmException
|
||||||
{
|
{
|
||||||
@ -192,8 +203,10 @@ public final class SibaUtils
|
|||||||
/**
|
/**
|
||||||
*
|
*
|
||||||
* @param choosenFile
|
* @param choosenFile
|
||||||
* @return
|
* The MD5file
|
||||||
|
* @return the file to check
|
||||||
* @throws IOException
|
* @throws IOException
|
||||||
|
* IOException
|
||||||
*/
|
*/
|
||||||
public static File readFileNameToCheck(final File choosenFile) throws IOException
|
public static File readFileNameToCheck(final File choosenFile) throws IOException
|
||||||
{
|
{
|
||||||
@ -234,8 +247,11 @@ public final class SibaUtils
|
|||||||
|
|
||||||
/**
|
/**
|
||||||
*
|
*
|
||||||
* @return
|
* @param resource
|
||||||
|
* the resource to read
|
||||||
|
* @return the string of the resource
|
||||||
* @throws IOException
|
* @throws IOException
|
||||||
|
* IOException
|
||||||
*/
|
*/
|
||||||
public static String readResource(final String resource) throws IOException
|
public static String readResource(final String resource) throws IOException
|
||||||
{
|
{
|
||||||
@ -250,8 +266,11 @@ public final class SibaUtils
|
|||||||
/**
|
/**
|
||||||
*
|
*
|
||||||
* @param fileToSave
|
* @param fileToSave
|
||||||
|
* The directory to backup
|
||||||
* @param outputStream
|
* @param outputStream
|
||||||
|
* local Stream
|
||||||
* @throws IOException
|
* @throws IOException
|
||||||
|
* IOException
|
||||||
*/
|
*/
|
||||||
public static void tarDirectoryTree(final File fileToSave, final TarArchiveOutputStream outputStream)
|
public static void tarDirectoryTree(final File fileToSave, final TarArchiveOutputStream outputStream)
|
||||||
throws IOException
|
throws IOException
|
||||||
@ -265,9 +284,13 @@ public final class SibaUtils
|
|||||||
* This method generates ArchiveEntry.
|
* This method generates ArchiveEntry.
|
||||||
*
|
*
|
||||||
* @param directory
|
* @param directory
|
||||||
|
* The actual directory being archived
|
||||||
* @param outputStream
|
* @param outputStream
|
||||||
|
* local stream
|
||||||
* @param pathLength
|
* @param pathLength
|
||||||
|
* used to select the starting directory
|
||||||
* @throws IOException
|
* @throws IOException
|
||||||
|
* IOException
|
||||||
*/
|
*/
|
||||||
public static void tarDirectoryTree(final File directory, final TarArchiveOutputStream outputStream,
|
public static void tarDirectoryTree(final File directory, final TarArchiveOutputStream outputStream,
|
||||||
final int pathLength) throws IOException
|
final int pathLength) throws IOException
|
||||||
|
Loading…
Reference in New Issue
Block a user