FileManagement package

Lots of work this past week on the FileManagement package.  Not yet finished, but getting close.  Note that JavaDoc comments are in need of tweaking and should not be trusted.
Working on further documenting (Javadoc) of all FileManagement packages classes now.  Was hoping I’d be able to push, comment, and merge before you jumped in to review :).  I  haven’t read many of your comments yet (getting there) but I suspect one of them will be that code with incomplete, missing, or outright incorrect Javadoc should never make it into the master repo.

 

- Jeff

 

From: Spencer Marks [mailto:notifications@github.com] 
Sent: Monday, June 23, 2014 7:19 AM
To: JeffBlodgett/FileSieve
Cc: Jeff Blodgett
Subject: Re: [FileSieve] FileManagement package (#5)

 

In src/main/java/FileSieve/BusinessLogic/FileManagement/ConcurrentFileManager.java:

> +        private boolean noErrors = true;
> +        boolean overwriteExistingFiles = false;
> +        boolean overwriteIfSizeDiffers = false;
> +        boolean recursionEnabled = true;
> +        private volatile int fileProgress;
> +
> +        protected BackgroundCopyWorker(Path sourcePathname, Path targetPathname) throws IllegalArgumentException, SecurityException {
> +            if ((sourcePathname == null) || (targetPathname == null)) {
> +                throw new IllegalArgumentException("null pathname provided for source or target");
> +            }
> +
> +            this.sourcePathname = sourcePathname;
> +            this.targetPathname = targetPathname;
> +        }
> +
> +        public void setOverwriteExistingFiles(boolean overwriteExistingFiles) {

be sure comment all public methods. 

personally I comment all methods, and would recommend that as a best practice. 

—
Reply to this email directly or view it on GitHub <https://github.com/JeffBlodgett/FileSieve/pull/5/files#r14070253> .