@@ -1,5 +1,5 @@
/* /*
* Copyright 2003-2004 The Apache Software Foundation
* Copyright 2003-2005 The Apache Software Foundation
* *
* Licensed under the Apache License, Version 2.0 (the "License"); * Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License. * you may not use this file except in compliance with the License.
@@ -22,6 +22,9 @@ import java.util.Iterator;
import java.util.StringTokenizer; import java.util.StringTokenizer;
import java.io.File; import java.io.File;
/**
* A helper object for Scp representing a directory in a file system.
*/
public class Directory { public class Directory {
private File directory; private File directory;
@@ -29,10 +32,19 @@ public class Directory {
private ArrayList files; private ArrayList files;
private Directory parent; private Directory parent;
/**
* Constructor for a Directory.
* @param directory a directory.
*/
public Directory(File directory) { public Directory(File directory) {
this(directory, null); this(directory, null);
} }
/**
* Constructor for a Directory.
* @param directory a directory
* @param parent a parent Directory
*/
public Directory(File directory , Directory parent) { public Directory(File directory , Directory parent) {
this.parent = parent; this.parent = parent;
this.childDirectories = new ArrayList(); this.childDirectories = new ArrayList();
@@ -40,36 +52,69 @@ public class Directory {
this.directory = directory; this.directory = directory;
} }
/**
* Add a directory to the child directories.
* @param directory a Directory
*/
public void addDirectory(Directory directory) { public void addDirectory(Directory directory) {
if (!childDirectories.contains(directory)) { if (!childDirectories.contains(directory)) {
childDirectories.add(directory); childDirectories.add(directory);
} }
} }
/**
* Add a file to the list of files.
* @param file a file to add
*/
public void addFile(File file) { public void addFile(File file) {
files.add(file); files.add(file);
} }
/**
* Get an iterator over the child Directories.
* @return an iterator
*/
public Iterator directoryIterator() { public Iterator directoryIterator() {
return childDirectories.iterator(); return childDirectories.iterator();
} }
/**
* Get an iterator over the files.
* @return an iterator
*/
public Iterator filesIterator() { public Iterator filesIterator() {
return files.iterator(); return files.iterator();
} }
/**
* Get the parent Directory.
* @return the parent Directory.
*/
public Directory getParent() { public Directory getParent() {
return parent; return parent;
} }
/**
* Is this a root Directory?
* @return true if there is no parent Directory
*/
public boolean isRoot() { public boolean isRoot() {
return parent == null; return parent == null;
} }
/**
* Get the directory file.
* @return the directory file
*/
public File getDirectory() { public File getDirectory() {
return directory; return directory;
} }
/**
* Get a child directory of this directory.
* @param dir the directory to look for
* @return the child directory, or null if not found
*/
public Directory getChild(File dir) { public Directory getChild(File dir) {
for (int i = 0; i < childDirectories.size(); i++) { for (int i = 0; i < childDirectories.size(); i++) {
Directory current = (Directory) childDirectories.get(i); Directory current = (Directory) childDirectories.get(i);
@@ -81,6 +126,12 @@ public class Directory {
return null; return null;
} }
/**
* The equality method.
* This checks if the directory field is the same.
* @param obj the object to compare to
* @return true if this object has an equal directory field as the other object
*/
public boolean equals(Object obj) { public boolean equals(Object obj) {
if (obj == this) { if (obj == this) {
return true; return true;
@@ -95,14 +146,28 @@ public class Directory {
return this.directory.equals(d.directory); return this.directory.equals(d.directory);
} }
/**
* The hashcode method.
* @return the hash code of the directory field
*/
public int hashCode() { public int hashCode() {
return directory.hashCode(); return directory.hashCode();
} }
/**
* Get the path components of this directory.
* @return the path components as an array of strings.
*/
public String[] getPath() { public String[] getPath() {
return getPath(directory.getAbsolutePath()); return getPath(directory.getAbsolutePath());
} }
/**
* Convert a file path to an array of path components.
* This uses File.sepatator to split the file path string.
* @param thePath the file path string to convert
* @return an array of path components
*/
public static String[] getPath(String thePath) { public static String[] getPath(String thePath) {
StringTokenizer tokenizer = new StringTokenizer(thePath, StringTokenizer tokenizer = new StringTokenizer(thePath,
File.separator); File.separator);
@@ -117,6 +182,10 @@ public class Directory {
return path; return path;
} }
/**
* Get the number of files in the files attribute.
* @return the number of files
*/
public int fileSize() { public int fileSize() {
return files.size(); return files.size();
} }
Peter Reilly