diff --git a/core/src/main/java/hudson/FilePath.java b/core/src/main/java/hudson/FilePath.java index 652e4f981b3fc97ad2fdee41e16187cc2b06220c..8cacc8d93a4ed672908272d4e751fdf7a77d316d 100644 --- a/core/src/main/java/hudson/FilePath.java +++ b/core/src/main/java/hudson/FilePath.java @@ -170,6 +170,7 @@ import org.apache.tools.zip.ZipEntry; * {@link FilePath} that represents the local computer causes it to become "remote." * * @author Kohsuke Kawaguchi + * @see VirtualFile */ public final class FilePath implements Serializable { /** @@ -1044,6 +1045,8 @@ public final class FilePath implements Serializable { /** * Gets the {@link VirtualFile} representation of this {@link FilePath} + * + * @since 1.532 */ public VirtualFile toVirtualFile() { return VirtualFile.forFilePath(this); diff --git a/core/src/main/java/jenkins/util/VirtualFile.java b/core/src/main/java/jenkins/util/VirtualFile.java index 2488da2c373c3c8066defdef1e6f4ac3a8965dbd..487c5e437936af8b3976576380db42acd0450739 100644 --- a/core/src/main/java/jenkins/util/VirtualFile.java +++ b/core/src/main/java/jenkins/util/VirtualFile.java @@ -26,6 +26,7 @@ package jenkins.util; import hudson.FilePath; import hudson.model.DirectoryBrowserSupport; +import hudson.remoting.Channel; import hudson.remoting.VirtualChannel; import hudson.util.DirScanner; import hudson.util.FileVisitor; @@ -41,7 +42,18 @@ import javax.annotation.Nonnull; /** * Abstraction over {@link File}, {@link FilePath}, or other items such as network resources or ZIP entries. * Assumed to be read-only and makes very limited assumptions, just enough to display content and traverse directories. + * + *
+ * To obtain a {@link VirtualFile} representation for an existing file, use {@link #forFile(File)} or {@link FilePath#toVirtualFile()} + * + *
+ * FilePath abstracts away {@link File}s on machines that are connected over {@link Channel}, whereas
+ * {@link VirtualFile} makes no assumption about where the actual files are, or whether there really exists
+ * {@link File}s somewhere. This makes VirtualFile more abstract.
+ *
* @see DirectoryBrowserSupport
+ * @see FilePath
* @since 1.531
*/
public abstract class VirtualFile implements Comparable