public abstract static class ProcessBuilder.Redirect extends Object
Represents a source of subprocess input or a destination of subprocess output. Each Redirect
instance is one of the following:
Redirect.PIPE
Redirect.INHERIT
Redirect.from(File)
Redirect.to(File)
Redirect.appendTo(File)
Each of the above categories has an associated unique Type
.
Modifier and Type | Class and Description |
---|---|
static class |
ProcessBuilder.Redirect.Type The type of a |
public static final ProcessBuilder.Redirect PIPE
Indicates that subprocess I/O will be connected to the current Java process over a pipe. This is the default handling of subprocess standard I/O.
It will always be true that
Redirect.PIPE.file() == null && Redirect.PIPE.type() == Redirect.Type.PIPE
public static final ProcessBuilder.Redirect INHERIT
Indicates that subprocess I/O source or destination will be the same as those of the current process. This is the normal behavior of most operating system command interpreters (shells).
It will always be true that
Redirect.INHERIT.file() == null && Redirect.INHERIT.type() == Redirect.Type.INHERIT
public abstract ProcessBuilder.Redirect.Type type()
Returns the type of this Redirect
.
Redirect
public File file()
Returns the File
source or destination associated with this redirect, or null
if there is no such file.
null
if there is no such filepublic static ProcessBuilder.Redirect from(File file)
Returns a redirect to read from the specified file.
It will always be true that
Redirect.from(file).file() == file && Redirect.from(file).type() == Redirect.Type.READ
file
- The File
for the Redirect
.NullPointerException
- if the specified file is nullpublic static ProcessBuilder.Redirect to(File file)
Returns a redirect to write to the specified file. If the specified file exists when the subprocess is started, its previous contents will be discarded.
It will always be true that
Redirect.to(file).file() == file && Redirect.to(file).type() == Redirect.Type.WRITE
file
- The File
for the Redirect
.NullPointerException
- if the specified file is nullpublic static ProcessBuilder.Redirect appendTo(File file)
Returns a redirect to append to the specified file. Each write operation first advances the position to the end of the file and then writes the requested data. Whether the advancement of the position and the writing of the data are done in a single atomic operation is system-dependent and therefore unspecified.
It will always be true that
Redirect.appendTo(file).file() == file && Redirect.appendTo(file).type() == Redirect.Type.APPEND
file
- The File
for the Redirect
.NullPointerException
- if the specified file is nullpublic boolean equals(Object obj)
Compares the specified object with this Redirect
for equality. Returns true
if and only if the two objects are identical or both objects are Redirect
instances of the same type associated with non-null equal File
instances.
equals
in class Object
obj
- the reference object with which to compare.true
if this object is the same as the obj argument; false
otherwise.Object.hashCode()
, HashMap
public int hashCode()
Returns a hash code value for this Redirect
.
hashCode
in class Object
Redirect
Object.equals(java.lang.Object)
, System.identityHashCode(java.lang.Object)
© 1993–2017, Oracle and/or its affiliates. All rights reserved.
Documentation extracted from Debian's OpenJDK Development Kit package.
Licensed under the GNU General Public License, version 2, with the Classpath Exception.
Various third party code in OpenJDK is licensed under different licenses (see Debian package).
Java and OpenJDK are trademarks or registered trademarks of Oracle and/or its affiliates.