hudson.util.IOUtils Maven / Gradle / Ivy
Show all versions of hudson-core Show documentation
/*******************************************************************************
*
* Copyright (c) 2004-2010 Oracle Corporation.
*
* All rights reserved. This program and the accompanying materials
* are made available under the terms of the Eclipse Public License v1.0
* which accompanies this distribution, and is available at
* http://www.eclipse.org/legal/epl-v10.html
*
* Contributors:
*
*
*******************************************************************************/
package hudson.util;
import java.io.*;
import java.util.regex.Pattern;
/**
* Adds more to commons-io.
*
* @author Kohsuke Kawaguchi
* @since 1.337
*/
public class IOUtils extends org.apache.commons.io.IOUtils {
/**
* Drains the input stream and closes it.
*/
public static void drain(InputStream in) throws IOException {
copy(in, new NullStream());
in.close();
}
public static void copy(File src, OutputStream out) throws IOException {
FileInputStream in = new FileInputStream(src);
try {
copy(in, out);
} finally {
closeQuietly(in);
}
}
public static void copy(InputStream in, File out) throws IOException {
FileOutputStream fos = new FileOutputStream(out);
try {
copy(in, fos);
} finally {
closeQuietly(fos);
}
}
/**
* Ensures that the given directory exists (if not, it's created, including
* all the parent directories.)
*
* @return This method returns the 'dir' parameter so that the method call
* flows better.
*/
public static File mkdirs(File dir) throws IOException {
if (dir.mkdirs() || dir.exists()) {
return dir;
}
// following Ant task to avoid possible race condition.
try {
Thread.sleep(10);
} catch (InterruptedException e) {
// ignore
}
if (dir.mkdirs() || dir.exists()) {
return dir;
}
throw new IOException("Failed to create a directory at " + dir);
}
/**
* Fully skips the specified size from the given input stream.
*
* {@link InputStream#skip(long)} has two problems. One is that it
* doesn't let us reliably differentiate "hit EOF" case vs "inpustream just
* returning 0 since there's no data currently available at hand", and some
* subtypes (such as {@link FileInputStream#skip(long)} returning -1.
*
*
So to reliably skip just the N bytes, we'll actually read all those
* bytes.
*
* @since 1.349
* @deprecated use
* {@link org.apache.commons.io.IOUtils#skip(java.io.InputStream, long)}
* instead
* @since 2.1.2
*/
public static long skip(InputStream in, long size) throws IOException {
return org.apache.commons.io.IOUtils.skip(in, size);
}
/**
* Resolves the given path with respect to given base. If the path
* represents an absolute path, a file representing it is returned,
* otherwise a file representing a path relative to base is returned.
It
* would be nice if File#File(File, String) were doing this.
*
* @param base File that represents the parent, may be null if path is
* absolute
* @param path Path of the file, may not be null
* @return new File(name) if name represents an absolute path, new
* File(base, name) otherwise
* @see hudson.FilePath#absolutize()
*/
public static File absolutize(File base, String path) {
if (isAbsolute(path)) {
return new File(path);
}
return new File(base, path);
}
/**
* See {@link hudson.FilePath#isAbsolute(String)}.
*
* @param path String representing Platform Specific (unlike
* FilePath, which may get Platform agnostic paths), may not be null
* @return true if String represents absolute path on this platform, false
* otherwise
*/
public static boolean isAbsolute(String path) {
Pattern DRIVE_PATTERN = Pattern.compile("[A-Za-z]:[\\\\/].*");
return path.startsWith("/") || DRIVE_PATTERN.matcher(path).matches();
}
private static final byte[] SKIP_BUFFER = new byte[8192];
}