Skip to content

Commit

Permalink
Javadoc
Browse files Browse the repository at this point in the history
  • Loading branch information
garydgregory committed Aug 12, 2024
1 parent 243ed5b commit 67003ef
Show file tree
Hide file tree
Showing 11 changed files with 65 additions and 14 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -47,8 +47,14 @@ public class MimeFileSystem extends AbstractFileSystem {

private InputStream mimeStream;

protected MimeFileSystem(final FileName rootName, final FileObject parentLayer,
final FileSystemOptions fileSystemOptions) {
/**
* Constructs a new instance.
*
* @param rootName The root file name of this file system.
* @param parentLayer The parent layer of this file system.
* @param fileSystemOptions Options to build this file system.
*/
protected MimeFileSystem(final FileName rootName, final FileObject parentLayer, final FileSystemOptions fileSystemOptions) {
super(rootName, parentLayer, fileSystemOptions);
}

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,13 @@
* An SMB file system.
*/
public class SmbFileSystem extends AbstractFileSystem {

/**
* Constructs a new instance.
*
* @param rootName The root file name of this file system.
* @param fileSystemOptions Options to build this file system.
*/
protected SmbFileSystem(final FileName rootName, final FileSystemOptions fileSystemOptions) {
super(rootName, null, fileSystemOptions);
}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -38,6 +38,7 @@
* </p>
*/
public class VirtualFileSystem extends AbstractFileSystem {

private final Map<FileName, FileObject> junctions = new HashMap<>();

/**
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -31,8 +31,14 @@
*/
public class Bzip2FileSystem extends CompressedFileFileSystem {

protected Bzip2FileSystem(final FileName rootName, final FileObject parentLayer,
final FileSystemOptions fileSystemOptions) {
/**
* Constructs a new instance.
*
* @param rootName The root file name of this file system.
* @param parentLayer The parent layer of this file system.
* @param fileSystemOptions Options to build this file system.
*/
protected Bzip2FileSystem(final FileName rootName, final FileObject parentLayer, final FileSystemOptions fileSystemOptions) {
super(rootName, parentLayer, fileSystemOptions);
}

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -31,8 +31,14 @@
*/
public abstract class CompressedFileFileSystem extends AbstractFileSystem {

protected CompressedFileFileSystem(final FileName rootName, final FileObject parentLayer,
final FileSystemOptions fileSystemOptions) {
/**
* Constructs a new instance.
*
* @param rootName The root file name of this file system.
* @param parentLayer The parent layer of this file system.
* @param fileSystemOptions Options to build this file system.
*/
protected CompressedFileFileSystem(final FileName rootName, final FileObject parentLayer, final FileSystemOptions fileSystemOptions) {
super(rootName, parentLayer, fileSystemOptions);
}

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -47,6 +47,8 @@ public class FtpFileSystem extends AbstractFileSystem {
private final AtomicReference<FtpClient> idleClient = new AtomicReference<>();

/**
* Constructs a new instance.
*
* @param rootName The root of the file system.
* @param ftpClient The FtpClient.
* @param fileSystemOptions The FileSystemOptions.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,13 @@
*/
public class GzipFileSystem extends CompressedFileFileSystem {

/**
* Constructs a new instance.
*
* @param rootName The root file name of this file system.
* @param parentLayer The parent layer of this file system.
* @param fileSystemOptions Options to build this file system.
*/
protected GzipFileSystem(final FileName rootName, final FileObject parentLayer, final FileSystemOptions fileSystemOptions) {
super(rootName, parentLayer, fileSystemOptions);
}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -40,9 +40,17 @@
public class JarFileSystem extends ZipFileSystem {
private Attributes attributes;

protected JarFileSystem(final AbstractFileName rootName, final FileObject file,
final FileSystemOptions fileSystemOptions) throws FileSystemException {
super(rootName, file, fileSystemOptions);
/**
* Constructs a new instance.
*
* @param rootFileName The root file name of this file system.
* @param parentLayer The parent layer of this file system.
* @param fileSystemOptions Options to build this file system.
* @throws FileSystemException If the parent layer does not exist, or on error replicating the file.
*/
protected JarFileSystem(final AbstractFileName rootFileName, final FileObject parentLayer, final FileSystemOptions fileSystemOptions)
throws FileSystemException {
super(rootFileName, parentLayer, fileSystemOptions);
}

// @Override
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -51,8 +51,10 @@ public class RamFileSystem extends AbstractFileSystem implements Serializable {
private final Map<FileName, RamFileData> cache;

/**
* @param rootName The root file name.
* @param fileSystemOptions The FileSystem options.
* Constructs a new instance.
*
* @param rootName The root file name of this file system.
* @param fileSystemOptions Options to build this file system.
*/
protected RamFileSystem(final FileName rootName, final FileSystemOptions fileSystemOptions) {
super(rootName, null, fileSystemOptions);
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -89,12 +89,10 @@ public class SftpFileSystem extends AbstractFileSystem {
*/
private final boolean execDisabled;

protected SftpFileSystem(final GenericFileName rootName, final Session session,
final FileSystemOptions fileSystemOptions) {
protected SftpFileSystem(final GenericFileName rootName, final Session session, final FileSystemOptions fileSystemOptions) {
super(rootName, null, fileSystemOptions);
this.session = Objects.requireNonNull(session, "session");
connectTimeout = SftpFileSystemConfigBuilder.getInstance().getConnectTimeout(fileSystemOptions);

if (SftpFileSystemConfigBuilder.getInstance().isDisableDetectExecChannel(fileSystemOptions)) {
execDisabled = true;
} else {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -61,6 +61,14 @@ public class TarFileSystem extends AbstractFileSystem {
*/
private final Map<FileName, FileObject> cache = new HashMap<>();

/**
* Constructs a new instance.
*
* @param rootName The root file name of this file system.
* @param parentLayer The parent layer of this file system.
* @param fileSystemOptions Options to build this file system.
* @throws FileSystemException if a file system error occurs.
*/
protected TarFileSystem(final AbstractFileName rootName, final FileObject parentLayer,
final FileSystemOptions fileSystemOptions) throws FileSystemException {
super(rootName, parentLayer, fileSystemOptions);
Expand Down

0 comments on commit 67003ef

Please sign in to comment.