Skip navigation links
A B C D E F G H I K L M N O P R S T U V W 

A

AbstractFilteredDirectoryStream<T> - Class in com.palantir.giraffe.file.base
An thread-safe, abstract DirectoryStream that applies a filter to an underlying entry iterator.
AbstractFilteredDirectoryStream(DirectoryStream.Filter<? super T>) - Constructor for class com.palantir.giraffe.file.base.AbstractFilteredDirectoryStream
 
AbstractHostControlSystem - Class in com.palantir.giraffe.host
An abstract HostControlSystem that delegates to a file system instance and an execution system instance.
AbstractHostControlSystem(URI, FileSystem, ExecutionSystem) - Constructor for class com.palantir.giraffe.host.AbstractHostControlSystem
 
AbstractImmutableListPath<P extends AbstractImmutableListPath<P>> - Class in com.palantir.giraffe.file.base
An abstract Path implementation backed by an ImmutableList of segments.
AbstractImmutableListPath(ImmutableListPathCore) - Constructor for class com.palantir.giraffe.file.base.AbstractImmutableListPath
 
AbstractPosixFileAttributeView - Class in com.palantir.giraffe.file.base.attribute
An abstract implementation of AbstractPosixFileAttributeView that delegates setter methods to a PosixFileAttributeSetter.
AbstractPosixFileAttributeView() - Constructor for class com.palantir.giraffe.file.base.attribute.AbstractPosixFileAttributeView
 
AbstractResponseProvider<T> - Class in com.palantir.giraffe.command.interactive
Abstract implementation of ResponseProvider.
AbstractResponseProvider(AbstractResponseProvider.Builder<T>) - Constructor for class com.palantir.giraffe.command.interactive.AbstractResponseProvider
 
AbstractResponseProvider.Builder<T> - Class in com.palantir.giraffe.command.interactive
A builder for an AbstractResponseProvider.
AbstractSeekableByteChannel - Class in com.palantir.giraffe.file.base
An abstract base classe for SeekableByteChannel implementations.
AbstractSeekableByteChannel() - Constructor for class com.palantir.giraffe.file.base.AbstractSeekableByteChannel
 
add(ResponseProvider.OutputMatcher<T>) - Method in class com.palantir.giraffe.command.interactive.AbstractResponseProvider.Builder
Adds the given ResponseProvider.OutputMatcher entry.
add(FileAttributeViewFactory<?>) - Method in class com.palantir.giraffe.file.base.attribute.FileAttributeViewRegistry.Builder
 
addArgument(Object) - Method in interface com.palantir.giraffe.command.Command.Builder
Adds an argument to this command.
addArguments(Object, Object, Object...) - Method in interface com.palantir.giraffe.command.Command.Builder
Adds arguments to this command.
addArguments(List<?>) - Method in interface com.palantir.giraffe.command.Command.Builder
Adds arguments to this command.
addAttributes(PosixFileAttributeSetter, PosixFileAttributes) - Static method in class com.palantir.giraffe.file.base.attribute.PosixFileAttributeViews
 
addAttributes(PosixFileAttributeSetter, FileAttribute<?>[]) - Static method in class com.palantir.giraffe.file.base.attribute.PosixFileAttributeViews
 
addExact(String, T) - Method in class com.palantir.giraffe.command.interactive.AbstractResponseProvider.Builder
Creates a new ResponseProvider.OutputMatcher entry that matches a prompt exactly and replies exactly.
addExact(String, Function<String, T>) - Method in class com.palantir.giraffe.command.interactive.AbstractResponseProvider.Builder
Creates a new ResponseProvider.OutputMatcher entry that matches a prompt exactly and replies dynamically.
addLocalUriScheme(String) - Static method in class com.palantir.giraffe.host.Host
Adds a URI scheme to the set used by Host.fromUri(URI) to identify the localhost URIs.
addPermission(Path, PosixFilePermission) - Static method in class com.palantir.giraffe.file.MoreFiles
Adds a permission to a file or directory.
addPermissionRecursive(Path, PosixFilePermission) - Static method in class com.palantir.giraffe.file.MoreFiles
Recursively adds a permission to a directory.
addPredicate(Predicate<String>, T) - Method in class com.palantir.giraffe.command.interactive.AbstractResponseProvider.Builder
Creates a new ResponseProvider.OutputMatcher entry that matches a prompt dynamically and replies exactly.
addPredicate(Predicate<String>, Function<String, T>) - Method in class com.palantir.giraffe.command.interactive.AbstractResponseProvider.Builder
Creates a new ResponseProvider.OutputMatcher entry that matches a prompt dynamically and replies dynamically.
addRegex(String, T) - Method in class com.palantir.giraffe.command.interactive.AbstractResponseProvider.Builder
Creates a new ResponseProvider.OutputMatcher entry that matches a prompt using a regular expression and replies exactly.
addRegex(String, Function<String, T>) - Method in class com.palantir.giraffe.command.interactive.AbstractResponseProvider.Builder
Creates a new ResponseProvider.OutputMatcher entry that matches a prompt using a regular expression and replies dynamically.
advancePosition(int) - Method in class com.palantir.giraffe.file.base.AbstractSeekableByteChannel
Advances this channel's position by the given number of bytes, if it is positive.
AnnotatedBasicFileAttributes - Interface in com.palantir.giraffe.file.base.attribute
AnnotatedBasicFileAttributeView - Interface in com.palantir.giraffe.file.base.attribute
AnnotatedDosFileAttributes - Interface in com.palantir.giraffe.file.base.attribute
AnnotatedDosFileAttributeView - Interface in com.palantir.giraffe.file.base.attribute
AnnotatedFileAttributes - Interface in com.palantir.giraffe.file.base.attribute
A marker interface that indicates the implementing class supports annotation-based dynamic file attribute access.
AnnotatedFileAttributeView - Interface in com.palantir.giraffe.file.base.attribute
A FileAttributeView that supports annotation-based dynamic file attribute access.
AnnotatedPosixFileAttributes - Interface in com.palantir.giraffe.file.base.attribute
AnnotatedPosixFileAttributeView - Interface in com.palantir.giraffe.file.base.attribute
append - Variable in class com.palantir.giraffe.file.base.OpenFlags
 
asHostControlSystem() - Method in interface com.palantir.giraffe.host.HostControlSystemUpgradeable
Returns a HostControlSystem view of the resources accessible with this system.
atomicMove - Variable in class com.palantir.giraffe.file.base.CopyFlags
 
Attribute - Annotation Type in com.palantir.giraffe.file.base.attribute
An annotated method gets or sets a named attribute of a file.
attributesType() - Method in interface com.palantir.giraffe.file.base.attribute.FileAttributeViewFactory
Returns the type of attributes read by views created by this factory.
authByKerberos(KerberosSshCredential) - Method in interface com.palantir.giraffe.ssh.SshAuthenticator
 
authByPassword(PasswordSshCredential) - Method in interface com.palantir.giraffe.ssh.SshAuthenticator
 
authByPublicKey(PublicKeySshCredential) - Method in interface com.palantir.giraffe.ssh.SshAuthenticator
 
authenticate(A) - Method in class com.palantir.giraffe.host.Credential
Authenticates the connection managed by the given Authenticator using this credential.
authenticate(SshAuthenticator) - Method in class com.palantir.giraffe.ssh.KerberosSshCredential
 
authenticate(SshAuthenticator) - Method in class com.palantir.giraffe.ssh.PasswordSshCredential
 
authenticate(SshAuthenticator) - Method in class com.palantir.giraffe.ssh.PublicKeySshCredential
 
AuthenticatedHostAccessor<C extends Credential<?>> - Interface in com.palantir.giraffe.host
A HostAccessor for a host that requires authentication.
AuthenticatedSystemRequest<C extends Credential<?>> - Class in com.palantir.giraffe.host
Contains information needed to open a HostControlSystem for a host that requires authentication.
AuthenticatedSystemRequest(URI, C) - Constructor for class com.palantir.giraffe.host.AuthenticatedSystemRequest
 
AuthenticatedSystemRequest(URI, Map<String, ?>, Class<C>) - Constructor for class com.palantir.giraffe.host.AuthenticatedSystemRequest
 
AuthenticationException - Exception in com.palantir.giraffe.host
Checked exception thrown when authentication fails.
AuthenticationException(String, String) - Constructor for exception com.palantir.giraffe.host.AuthenticationException
Creates an exception with the specified hostname and detail message.
AuthenticationException(String, String, Throwable) - Constructor for exception com.palantir.giraffe.host.AuthenticationException
Creates an exception with the specified hostname, detail message, and cause.
Authenticator - Interface in com.palantir.giraffe.host
Indicates that implementations can authenticate connections to remote hosts using information from a Credential.

B

BaseFileSystem<P extends BasePath<P>> - Class in com.palantir.giraffe.file.base
An abstract FileSystem implementation that provides common functionality and additional structure for subclasses.
BaseFileSystem() - Constructor for class com.palantir.giraffe.file.base.BaseFileSystem
 
BaseFileSystemProvider<P extends BasePath<P>> - Class in com.palantir.giraffe.file.base
An abstract FileSystemProvider implementation that provides common functionality and additional structure for subclasses.
BaseFileSystemProvider(Class<P>) - Constructor for class com.palantir.giraffe.file.base.BaseFileSystemProvider
 
BasePath<P extends BasePath<P>> - Class in com.palantir.giraffe.file.base
An abstract Path implementation that works independent of the file system or path representation.
BasePath() - Constructor for class com.palantir.giraffe.file.base.BasePath
 
BASIC_NAME - Static variable in class com.palantir.giraffe.file.base.attribute.FileAttributeViews
build() - Method in interface com.palantir.giraffe.command.Command.Builder
Builds a new Command using the settings configured by this builder.
build() - Method in class com.palantir.giraffe.command.CommandContext.Builder
Creates a new CommandContext using the settings configured by this builder.
build() - Method in class com.palantir.giraffe.command.interactive.AbstractResponseProvider.Builder
 
build() - Method in class com.palantir.giraffe.command.interactive.OrderedResponseProvider.Builder
 
build() - Method in class com.palantir.giraffe.command.interactive.UnorderedResponseProvider.Builder
 
build() - Method in class com.palantir.giraffe.file.base.attribute.FileAttributeViewRegistry.Builder
 
builder() - Static method in class com.palantir.giraffe.command.CommandContext
Returns a new CommandContext builder.
Builder() - Constructor for class com.palantir.giraffe.command.interactive.AbstractResponseProvider.Builder
 
builder() - Static method in class com.palantir.giraffe.command.interactive.OrderedResponseProvider
 
builder() - Static method in class com.palantir.giraffe.command.interactive.UnorderedResponseProvider
 
builder() - Static method in class com.palantir.giraffe.file.base.attribute.FileAttributeViewRegistry
 

C

CachingBaseFileSystemProvider<P extends BasePath<P>> - Class in com.palantir.giraffe.file.base
A BaseFileSystemProvider that caches created file systems, allowing at most one open file system for a given URI at a time.
CachingBaseFileSystemProvider(Class<P>) - Constructor for class com.palantir.giraffe.file.base.CachingBaseFileSystemProvider
 
changePermissionsRecursive(Path, PermissionChange, Set<PosixFilePermission>) - Method in interface com.palantir.giraffe.file.base.feature.RecursivePermissions
Recursively changes permissions on the given path.
checkAccess(P, AccessMode...) - Method in class com.palantir.giraffe.file.base.BaseFileSystem
 
checkAccess(Path, AccessMode...) - Method in class com.palantir.giraffe.file.base.BaseFileSystemProvider
 
checkIsOpen() - Method in class com.palantir.giraffe.file.base.AbstractSeekableByteChannel
Checks that this channel is open.
checkOpen(FileSystem) - Static method in class com.palantir.giraffe.SystemPreconditions
Ensures that the given file system is open.
checkOpen(ExecutionSystem) - Static method in class com.palantir.giraffe.SystemPreconditions
Ensures that the given execution system is open.
checkPath(Path) - Method in class com.palantir.giraffe.file.base.BaseFileSystemProvider
 
checkSameHost(Path, ExecutionSystem) - Static method in class com.palantir.giraffe.SystemPreconditions
Ensures that the given path and execution system refer to the same host.
checkSameHost(FileSystem, ExecutionSystem) - Static method in class com.palantir.giraffe.SystemPreconditions
Ensures that the given file system and execution system refer to the same host.
checkSameHost(Path, Path) - Static method in class com.palantir.giraffe.SystemPreconditions
Ensures that two paths refer to the same host.
checkSameHost(Host, FileSystem) - Static method in class com.palantir.giraffe.SystemPreconditions
Ensures that the given host is the same as the host of the given file system.
checkSameHost(Host, ExecutionSystem) - Static method in class com.palantir.giraffe.SystemPreconditions
Ensures that the given host is the same as the host of the given execution system.
checkUri(URI) - Method in class com.palantir.giraffe.file.base.CachingBaseFileSystemProvider
Checks that uri is a valid URI for a file system from this provider.
ChmodFilePermissions - Class in com.palantir.giraffe.file.base.attribute
Converts PosixFilePermissions to and from representations used by the chmod command and system call.
close() - Method in class com.palantir.giraffe.file.base.AbstractFilteredDirectoryStream
 
close() - Method in class com.palantir.giraffe.file.base.AbstractSeekableByteChannel
 
close() - Method in class com.palantir.giraffe.file.base.CloseableRegistry
 
close() - Method in class com.palantir.giraffe.file.base.SuppressedCloseable
Closes the contained Closeables in order.
close() - Method in class com.palantir.giraffe.file.TempPath
Closes this path, deleting the file or directory if it exists.
CloseableRegistry - Class in com.palantir.giraffe.file.base
An ordered list of Closeables that is closed in order.
CloseableRegistry() - Constructor for class com.palantir.giraffe.file.base.CloseableRegistry
 
closeAfterCompletion(ExecutionSystem, CommandFuture) - Static method in class com.palantir.giraffe.command.ExecutionSystems
Closes any connections the ExecutionSystem uses to execute commands after the CommandFuture finishes, even if other commands are still executing over the connections.
closeAfterCompletion(ExecutionSystem, CommandExitLatch) - Static method in class com.palantir.giraffe.command.ExecutionSystems
Blocks the registration of any new futures on the ExecutionSystemShutdownListener.
ClosedExecutionSystemException - Exception in com.palantir.giraffe.command
Runtime exception thrown when methods are called on a closed execution system.
ClosedExecutionSystemException() - Constructor for exception com.palantir.giraffe.command.ClosedExecutionSystemException
 
com.palantir.giraffe - package com.palantir.giraffe
Provides general utilities for working with file and execution systems.
com.palantir.giraffe.command - package com.palantir.giraffe.command
Provides classes and interfaces for local and remote command execution.
com.palantir.giraffe.command.interactive - package com.palantir.giraffe.command.interactive
Provides classes for performing interactive command execution.
com.palantir.giraffe.command.spi - package com.palantir.giraffe.command.spi
Service-provider classes for the com.palantir.giraffe.command package.
com.palantir.giraffe.file - package com.palantir.giraffe.file
Provides classes that supplement standard JDK file system functionality.
com.palantir.giraffe.file.base - package com.palantir.giraffe.file.base
Provides utilities to make implementing custom file systems easier.
com.palantir.giraffe.file.base.attribute - package com.palantir.giraffe.file.base.attribute
Provides annotation-based dynamic access to file attributes.
com.palantir.giraffe.file.base.feature - package com.palantir.giraffe.file.base.feature
Provides interfaces defining additional file system features.
com.palantir.giraffe.host - package com.palantir.giraffe.host
Provides classes and interfaces for interacting with hosts.
com.palantir.giraffe.host.spi - package com.palantir.giraffe.host.spi
Service-provider classes for the com.palantir.giraffe.host package.
com.palantir.giraffe.ssh - package com.palantir.giraffe.ssh
Provides SSH access for remote file systems and command execution.
Command - Interface in com.palantir.giraffe.command
Represents an executable path and set of arguments that may be run by an execution system.
command - Variable in class com.palantir.giraffe.command.TerminatedCommand
 
Command.Builder - Interface in com.palantir.giraffe.command
Builds Command objects.
CommandContext - Class in com.palantir.giraffe.command
Provides command-independent information that influences how commands execute.
CommandContext.Builder - Class in com.palantir.giraffe.command
Builds CommandContext objects.
CommandEnvironment - Class in com.palantir.giraffe.command
Describes the environment variables that are present when a Command executes.
CommandEnvironment.BaseEnvironment - Enum in com.palantir.giraffe.command
Defines the target of environment changes.
CommandException - Exception in com.palantir.giraffe.command
Runtime exception thrown when a command fails, usually by exiting with a non-zero exit status.
CommandException(TerminatedCommand) - Constructor for exception com.palantir.giraffe.command.CommandException
 
CommandExitLatch - Class in com.palantir.giraffe.command
Listener that shuts down an ExecutionSystem after it's been started and all registered CommandFutures have finished.
CommandExitLatch(CommandFuture...) - Constructor for class com.palantir.giraffe.command.CommandExitLatch
Constructs a new CommandExitLatch to shutdown an ExecutionSystem after all registered CommandFutures have finished.
CommandFuture - Interface in com.palantir.giraffe.command
A ListenableFuture that provides access to the output and exit status of an asynchronous command.
CommandOutputTrigger - Class in com.palantir.giraffe.command.interactive
Listens on long-running commands and runs Runnables when certain output appears.
CommandOutputTrigger(ResponseProvider<Runnable>, CommandFuture) - Constructor for class com.palantir.giraffe.command.interactive.CommandOutputTrigger
Create a CommandOutputTrigger for a running command using the provided ResponseProvider.
CommandOutputTrigger(ResponseProvider<Runnable>, CommandFuture, Executor) - Constructor for class com.palantir.giraffe.command.interactive.CommandOutputTrigger
Create a CommandOutputTrigger for a running command using the provided ResponseProvider.
CommandResult - Class in com.palantir.giraffe.command
Contains the output and exit status of a completed command.
CommandResult(int, String, String) - Constructor for class com.palantir.giraffe.command.CommandResult
 
Commands - Class in com.palantir.giraffe.command
Static utility methods to create and execute commands.
CommandTimeoutException - Exception in com.palantir.giraffe.command
Checked exception thrown when the timeout for a command is exceeded.
CommandTimeoutException(TerminatedCommand, long, TimeUnit) - Constructor for exception com.palantir.giraffe.command.CommandTimeoutException
 
compareTo(Path) - Method in class com.palantir.giraffe.file.base.AbstractImmutableListPath
 
compareTo(ImmutableListPathCore) - Method in class com.palantir.giraffe.file.base.ImmutableListPathCore
 
compareTo(UniformPath) - Method in class com.palantir.giraffe.file.UniformPath
 
contains(String) - Method in class com.palantir.giraffe.host.SystemRequest
 
context - Variable in class com.palantir.giraffe.command.TerminatedCommand
 
copy() - Method in class com.palantir.giraffe.command.CommandEnvironment
Returns a copy of this environment.
copyAttributes(Path, Path, LinkOption...) - Static method in class com.palantir.giraffe.file.base.attribute.PosixFileAttributeViews
 
copyAttributes - Variable in class com.palantir.giraffe.file.base.CopyFlags
 
copyFile(Path, Path, CopyFlags) - Static method in class com.palantir.giraffe.file.base.CrossSystemTransfers
 
CopyFlags - Class in com.palantir.giraffe.file.base
Container for standard CopyOptions.
CopyFlags() - Constructor for class com.palantir.giraffe.file.base.CopyFlags
 
copyLarge(Path, Path) - Method in interface com.palantir.giraffe.file.base.feature.LargeFileCopy
Copies the source file to the target path in an efficient way.
copyLarge(Path, Path) - Static method in class com.palantir.giraffe.file.MoreFiles
Copy a file to a target file in an efficient way.
copyRecursive(Path, Path) - Method in interface com.palantir.giraffe.file.base.feature.RecursiveCopy
Recursively copies the source path to the target path in an efficient way.
copyRecursive(Path, Path) - Static method in class com.palantir.giraffe.file.MoreFiles
Copy a path to a target path recursively.
create - Variable in class com.palantir.giraffe.file.base.OpenFlags
 
create(Closeable, Closeable...) - Static method in class com.palantir.giraffe.file.base.SuppressedCloseable
 
create(List<? extends Closeable>) - Static method in class com.palantir.giraffe.file.base.SuppressedCloseable
 
createDirectory(P, FileAttribute<?>...) - Method in class com.palantir.giraffe.file.base.BaseFileSystem
 
createDirectory(Path, FileAttribute<?>...) - Method in class com.palantir.giraffe.file.base.BaseFileSystemProvider
 
createDirectory() - Static method in class com.palantir.giraffe.file.TempPath
Creates a new temporary directory in the default temporary file location.
createDirectory(Path) - Static method in class com.palantir.giraffe.file.TempPath
Creates a new temporary directory in the specified directory.
createFile() - Static method in class com.palantir.giraffe.file.TempPath
Creates a new temporary file in the default temporary file location.
createFile(Path) - Static method in class com.palantir.giraffe.file.TempPath
Creates a new temporary file in the specified directory.
createNew - Variable in class com.palantir.giraffe.file.base.OpenFlags
 
createView(Path, LinkOption[]) - Method in class com.palantir.giraffe.file.base.attribute.PosixFileAttributeViewFactory
 
creationTime() - Method in interface com.palantir.giraffe.file.base.attribute.AnnotatedBasicFileAttributes
 
creationTime(FileTime) - Method in interface com.palantir.giraffe.file.base.attribute.PosixFileAttributeSetter
 
Credential<A extends Authenticator> - Class in com.palantir.giraffe.host
Contains information required to authenticate with a host or service.
Credential(Class<A>) - Constructor for class com.palantir.giraffe.host.Credential
 
CREDENTIAL_KEY - Static variable in class com.palantir.giraffe.host.AuthenticatedSystemRequest
 
CrossSystemTransfers - Class in com.palantir.giraffe.file.base
Utilities to implement copy and move operations between distinct systems from the same provider.

D

DEBUG_PROPERTY - Static variable in class com.palantir.giraffe.ssh.KerberosSshCredential
System property to enable Kerberos debug output when set to true.
defaultContext() - Static method in class com.palantir.giraffe.command.CommandContext
Returns the default context object.
defaultDirectory() - Method in class com.palantir.giraffe.file.base.BaseFileSystem
Returns the default directory of this file system.
defaultDirectory(FileSystem) - Static method in class com.palantir.giraffe.file.MoreFiles
Returns the default directory for the given file system.
defaultEnvironment() - Static method in class com.palantir.giraffe.command.CommandEnvironment
Returns a default environment with no changes.
delete(P) - Method in class com.palantir.giraffe.file.base.BaseFileSystem
 
delete(Path) - Method in class com.palantir.giraffe.file.base.BaseFileSystemProvider
 
deleteOnClose - Variable in class com.palantir.giraffe.file.base.OpenFlags
 
deleteRecursive(Path) - Method in interface com.palantir.giraffe.file.base.feature.RecursiveDelete
Deletes the given path or directory recursively.
deleteRecursive(Path) - Static method in class com.palantir.giraffe.file.MoreFiles
Deletes a path recursively.
deleteRecursiveIfExists(Path) - Method in interface com.palantir.giraffe.file.base.feature.RecursiveDelete
Deletes the given path or directory recursively, if it exists.
deleteRecursiveIfExists(Path) - Static method in class com.palantir.giraffe.file.MoreFiles
Deletes a path recursively if it exists.
directoryFilter() - Static method in class com.palantir.giraffe.file.MoreFiles
Returns a directory filter that matches directories.
discardOutput() - Method in class com.palantir.giraffe.command.CommandContext.Builder
Discards all output from commands.
doClose() - Method in class com.palantir.giraffe.file.base.AbstractFilteredDirectoryStream
Performs implementation-specific close actions.
doClose() - Method in class com.palantir.giraffe.file.base.AbstractSeekableByteChannel
Performs implementation-specific close actions.
DOS_NAME - Static variable in class com.palantir.giraffe.file.base.attribute.FileAttributeViews
dsync - Variable in class com.palantir.giraffe.file.base.OpenFlags
 
DynamicAttributeAccessor - Class in com.palantir.giraffe.file.base.attribute
Reads annotations on AnnotatedFileAttributeViews to provide dynamic access to file attributes.
DynamicAttributeAccessor(AnnotatedFileAttributeView) - Constructor for class com.palantir.giraffe.file.base.attribute.DynamicAttributeAccessor
 

E

emptyEnvironment() - Static method in class com.palantir.giraffe.command.CommandEnvironment
Returns an empty environment with no changes.
endsWith(Path) - Method in class com.palantir.giraffe.file.base.AbstractImmutableListPath
 
endsWith(String) - Method in class com.palantir.giraffe.file.base.BasePath
 
endsWith(ImmutableListPathCore) - Method in class com.palantir.giraffe.file.base.ImmutableListPathCore
 
endsWith(P) - Method in interface com.palantir.giraffe.file.base.PathCore
 
endsWith(UniformPath) - Method in class com.palantir.giraffe.file.UniformPath
 
endsWith(String) - Method in class com.palantir.giraffe.file.UniformPath
 
entryIterator() - Method in class com.palantir.giraffe.file.base.AbstractFilteredDirectoryStream
Creates and returns an iterator over the entries in this directory.
environment(CommandEnvironment) - Method in class com.palantir.giraffe.command.CommandContext.Builder
Sets the environment for commands executed with this context.
equals(Object) - Method in interface com.palantir.giraffe.command.Command
Tests this Command for equality with another object.
equals(Object) - Method in class com.palantir.giraffe.file.base.AbstractImmutableListPath
 
equals(Object) - Method in class com.palantir.giraffe.file.base.attribute.GroupIdPrincipal
 
equals(Object) - Method in class com.palantir.giraffe.file.base.attribute.UserIdPrincipal
 
equals(Object) - Method in class com.palantir.giraffe.file.base.BasePath
 
equals(Object) - Method in class com.palantir.giraffe.file.base.ImmutableListPathCore
 
equals(Object) - Method in class com.palantir.giraffe.file.UniformPath
 
equals(Object) - Method in class com.palantir.giraffe.host.Host
Determines if this Host is equal to another Host.
equals(Object) - Method in class com.palantir.giraffe.host.SystemRequest
 
execute(Command) - Static method in class com.palantir.giraffe.command.Commands
Synchronously executes a command with the default context.
execute(Command, CommandContext) - Static method in class com.palantir.giraffe.command.Commands
Synchronously executes a command with the specified context.
execute(Command, long, TimeUnit) - Static method in class com.palantir.giraffe.command.Commands
Synchronously executes a command with the default context and the given timeout.
execute(Command, CommandContext, long, TimeUnit) - Static method in class com.palantir.giraffe.command.Commands
Synchronously executes a command with the given context and timeout.
execute(Command, CommandContext) - Method in class com.palantir.giraffe.command.spi.ExecutionSystemProvider
 
executeAsync(Command) - Static method in class com.palantir.giraffe.command.Commands
Executes a command asynchronously with the default context.
executeAsync(Command, CommandContext) - Static method in class com.palantir.giraffe.command.Commands
Executes a command asynchronously with the specified context.
ExecutionSystem - Class in com.palantir.giraffe.command
Provides an interface for command execution and is the factory for command objects.
ExecutionSystem() - Constructor for class com.palantir.giraffe.command.ExecutionSystem
 
ExecutionSystemAlreadyExistsException - Exception in com.palantir.giraffe.command
Runtime exception thrown when an attempt is made to create an execution system that already exists.
ExecutionSystemAlreadyExistsException() - Constructor for exception com.palantir.giraffe.command.ExecutionSystemAlreadyExistsException
 
ExecutionSystemAlreadyExistsException(String) - Constructor for exception com.palantir.giraffe.command.ExecutionSystemAlreadyExistsException
 
ExecutionSystemNotFoundException - Exception in com.palantir.giraffe.command
Runtime exception thrown when an execution system cannot be found.
ExecutionSystemNotFoundException() - Constructor for exception com.palantir.giraffe.command.ExecutionSystemNotFoundException
 
ExecutionSystemNotFoundException(String) - Constructor for exception com.palantir.giraffe.command.ExecutionSystemNotFoundException
 
ExecutionSystemProvider - Class in com.palantir.giraffe.command.spi
Service provider class for execution systems.
ExecutionSystemProvider() - Constructor for class com.palantir.giraffe.command.spi.ExecutionSystemProvider
 
ExecutionSystems - Class in com.palantir.giraffe.command
Factory methods for execution systems.

F

FileAttributeViewFactory<V extends AnnotatedFileAttributeView> - Interface in com.palantir.giraffe.file.base.attribute
FileAttributeViewRegistry - Class in com.palantir.giraffe.file.base.attribute
A mapping from attribute identifiers to FileAttributeViewFactorys.
FileAttributeViewRegistry.Builder - Class in com.palantir.giraffe.file.base.attribute
FileAttributeViews - Class in com.palantir.giraffe.file.base.attribute
Utilities for FileAttributeViews and their attribute types.
fileAttributeViews() - Method in class com.palantir.giraffe.file.base.BaseFileSystem
 
fileKey() - Method in interface com.palantir.giraffe.file.base.attribute.AnnotatedBasicFileAttributes
 
followLinks - Variable in class com.palantir.giraffe.file.base.CopyFlags
 
followLinks(LinkOption...) - Static method in class com.palantir.giraffe.file.base.LinkOptions
 
followLinks - Variable in class com.palantir.giraffe.file.base.OpenFlags
 
forCredential(Host, SshCredential) - Static method in class com.palantir.giraffe.ssh.SshHostAccessor
Returns a new SshHostAccessor that authenticates using the given SshCredential.
forCredential(Host, int, SshCredential) - Static method in class com.palantir.giraffe.ssh.SshHostAccessor
Returns a new SshHostAccessor that authenticates using the given SshCredential on the given port.
forKerberos(String, String) - Static method in class com.palantir.giraffe.ssh.SshHostAccessor
Returns a new SshHostAccessor that authenticates as the given user using the system Kerberos configuration.
forKey(String, String, Path) - Static method in class com.palantir.giraffe.ssh.SshHostAccessor
Returns a new SshHostAccessor that authenticates using the given private key.
forKey(String, String, String) - Static method in class com.palantir.giraffe.ssh.SshHostAccessor
Returns a new SshHostAccessor that authenticates using the given private key.
forPassword(String, String, String) - Static method in class com.palantir.giraffe.ssh.SshHostAccessor
Returns a new SshHostAccessor that authenticates using the given password.
forPassword(String, String, char[]) - Static method in class com.palantir.giraffe.ssh.SshHostAccessor
Returns a new SshHostAccessor that authenticates using the given password.
fromFile(String, Path) - Static method in class com.palantir.giraffe.ssh.PublicKeySshCredential
 
fromGroupPrinciple(GroupPrincipal) - Static method in class com.palantir.giraffe.file.base.attribute.GroupIdPrincipal
Creates a GroupIdPrincipal from a GroupPrincipal with an unknown type.
fromHostname(String) - Static method in class com.palantir.giraffe.host.Host
Creates a Host from a valid hostname.
fromHostnameUnresolved(String) - Static method in class com.palantir.giraffe.host.Host
Creates a Host with the given literal hostname.
fromInetAddress(InetAddress) - Static method in class com.palantir.giraffe.host.Host
Creates a Host from an InetAddress using the saved or resolved hostname.
fromOptions(CopyOption...) - Static method in class com.palantir.giraffe.file.base.CopyFlags
 
fromOptions(Iterable<? extends CopyOption>) - Static method in class com.palantir.giraffe.file.base.CopyFlags
 
fromOptions(OpenOption...) - Static method in class com.palantir.giraffe.file.base.OpenFlags
Converts the specified options to flags.
fromOptions(Iterable<? extends OpenOption>) - Static method in class com.palantir.giraffe.file.base.OpenFlags
Converts the specified options to flags.
fromPath(Path) - Static method in class com.palantir.giraffe.file.UniformPath
Converts the specified Path into a UniformPath.
fromRegex(String) - Static method in class com.palantir.giraffe.file.base.StandardPathMatchers
 
fromRegex(Pattern) - Static method in class com.palantir.giraffe.file.base.StandardPathMatchers
 
fromSyntaxAndPattern(String, String) - Static method in class com.palantir.giraffe.file.base.StandardPathMatchers
 
fromUri(URI) - Static method in class com.palantir.giraffe.host.Host
Gets a Host from a URI.
fromUserPrinciple(UserPrincipal) - Static method in class com.palantir.giraffe.file.base.attribute.UserIdPrincipal
Creates a UserIdPrincipal from a UserPrincipal with an unknown type.

G

get(String, Object...) - Static method in class com.palantir.giraffe.command.Commands
Gets a command for the default execution system.
get(Path, Object...) - Static method in class com.palantir.giraffe.command.Commands
Gets a command for the default execution system.
get(K) - Method in class com.palantir.giraffe.file.base.SystemCache
Gets the system associated with key if it exists.
get(String, String...) - Static method in class com.palantir.giraffe.file.UniformPath
Converts a path string, or a sequence of strings that form a path string when joined, to a UniformPath.
get(Iterable<String>) - Static method in class com.palantir.giraffe.file.UniformPath
Converts a sequence of strings that form a path string when joined to a UniformPath.
get(String) - Method in class com.palantir.giraffe.host.SystemRequest
 
get(String, Class<? extends T>) - Method in class com.palantir.giraffe.host.SystemRequest
 
getArguments() - Method in interface com.palantir.giraffe.command.Command
Returns the arguments of this command.
getArguments() - Method in exception com.palantir.giraffe.command.CommandException
Returns the arguments of the failed command.
getArguments() - Method in exception com.palantir.giraffe.command.CommandTimeoutException
Returns the arguments of the failed command.
getAuthenticatorType() - Method in class com.palantir.giraffe.host.Credential
Returns the type of Authenticator accepted by this credential.
getBase() - Method in class com.palantir.giraffe.command.CommandEnvironment
Returns this environment's base.
getBasicFactory() - Method in class com.palantir.giraffe.file.base.attribute.PosixFileAttributeViewFactory
 
getBuilder(Path) - Static method in class com.palantir.giraffe.command.Commands
Gets a command builder for the default execution system.
getBuilder(String) - Static method in class com.palantir.giraffe.command.Commands
Gets a command builder for the default execution system.
getByAttributesType(Class<? extends BasicFileAttributes>) - Method in class com.palantir.giraffe.file.base.attribute.FileAttributeViewRegistry
 
getByViewName(String) - Method in class com.palantir.giraffe.file.base.attribute.FileAttributeViewRegistry
 
getByViewType(Class<? extends FileAttributeView>) - Method in class com.palantir.giraffe.file.base.attribute.FileAttributeViewRegistry
 
getCanonicalHostname() - Method in class com.palantir.giraffe.host.Host
Gets this host's canonical hostname by performing a reverse DNS lookup on this host's IP address.
getChanges() - Method in class com.palantir.giraffe.command.CommandEnvironment
Returns an unmodifiable view of the changes in this environment.
getCommand(String, Object...) - Method in class com.palantir.giraffe.command.ExecutionSystem
Gets a command for this execution system.
getCommand(Path, Object...) - Method in class com.palantir.giraffe.command.ExecutionSystem
Gets a command for this execution system.
getCommand(String, Object...) - Method in class com.palantir.giraffe.host.AbstractHostControlSystem
 
getCommand(Path, Object...) - Method in class com.palantir.giraffe.host.AbstractHostControlSystem
 
getCommand(String, Object...) - Method in interface com.palantir.giraffe.host.HostControlSystem
Gets a command on this host's execution system.
getCommand(Path, Object...) - Method in interface com.palantir.giraffe.host.HostControlSystem
Gets a command on this host's execution system.
getCommandBuilder(Path) - Method in class com.palantir.giraffe.command.ExecutionSystem
Gets a command builder for this execution system.
getCommandBuilder(String) - Method in class com.palantir.giraffe.command.ExecutionSystem
Gets a command builder for this execution system.
getCore() - Method in class com.palantir.giraffe.file.base.AbstractImmutableListPath
 
getCreatePermissions(FileAttribute<?>[]) - Static method in class com.palantir.giraffe.file.base.attribute.PosixFileAttributeViews
Gets a set of file permissions used when creating a file or directory from the specified attributes.
getCredential() - Method in class com.palantir.giraffe.host.AuthenticatedSystemRequest
 
getDefault() - Static method in class com.palantir.giraffe.command.ExecutionSystems
Returns the default execution system for the local machine.
getDefault() - Static method in class com.palantir.giraffe.host.HostAccessors
Gets a HostAccessor for the local host.
getEnvironment() - Method in class com.palantir.giraffe.command.CommandContext
Returns a copy of this context's CommandEnvironment.
getExecutable() - Method in interface com.palantir.giraffe.command.Command
Returns this command's executable.
getExecutable() - Method in exception com.palantir.giraffe.command.CommandException
Returns the failed command.
getExecutable() - Method in exception com.palantir.giraffe.command.CommandTimeoutException
Returns the failed command.
getExecutionSystem() - Method in interface com.palantir.giraffe.command.Command
Returns the ExecutionSystem associated with this command.
getExecutionSystem(URI) - Static method in class com.palantir.giraffe.command.ExecutionSystems
Gets an existing execution system with the specified URI.
getExecutionSystem(URI) - Method in class com.palantir.giraffe.command.spi.ExecutionSystemProvider
 
getExecutionSystem() - Method in class com.palantir.giraffe.host.AbstractHostControlSystem
 
getExecutionSystem() - Method in interface com.palantir.giraffe.host.HostControlSystem
Returns this host's ExecutionSystem.
getExitStatus() - Method in class com.palantir.giraffe.command.CommandResult
Returns the exit status of the command.
getExitStatusVerifier() - Method in class com.palantir.giraffe.command.CommandContext
Returns the predicate this context uses to verify the exit status of commands.
getFileAttributeView(Path, Class<V>, LinkOption...) - Method in class com.palantir.giraffe.file.base.BaseFileSystemProvider
 
getFileName() - Method in class com.palantir.giraffe.file.base.AbstractImmutableListPath
 
getFileName() - Method in class com.palantir.giraffe.file.base.ImmutableListPathCore
 
getFileName() - Method in interface com.palantir.giraffe.file.base.PathCore
 
getFileName() - Method in class com.palantir.giraffe.file.UniformPath
 
getFileSystem() - Method in class com.palantir.giraffe.file.base.BasePath
 
getFileSystem(URI) - Method in class com.palantir.giraffe.file.base.CachingBaseFileSystemProvider
 
getFileSystem() - Method in class com.palantir.giraffe.host.AbstractHostControlSystem
 
getFileSystem() - Method in interface com.palantir.giraffe.host.HostControlSystem
Returns this host's FileSystem.
getGid() - Method in class com.palantir.giraffe.file.base.attribute.GroupIdPrincipal
 
getHost() - Method in class com.palantir.giraffe.host.AbstractHostControlSystem
 
getHost() - Method in interface com.palantir.giraffe.host.HostAccessor
Returns the Host that this object makes accessible.
getHost() - Method in interface com.palantir.giraffe.host.HostControlSystem
Returns the Host controlled by this system.
getHost() - Method in class com.palantir.giraffe.ssh.SshHostAccessor
 
getHostname() - Method in class com.palantir.giraffe.host.AbstractHostControlSystem
 
getHostname() - Method in class com.palantir.giraffe.host.Host
Returns the hostname of this host.
getHostname() - Method in interface com.palantir.giraffe.host.HostControlSystem
Returns the name of the host controlled by this system.
getHostname() - Method in exception com.palantir.giraffe.host.InetAddressUnresolvableException
Returns the hostname that could not be resolved.
getInetAddress() - Method in class com.palantir.giraffe.host.Host
Resolves this host's hostname to an IP address.
getKeepaliveInterval() - Method in class com.palantir.giraffe.ssh.SshSystemRequest
 
getKeyPath() - Method in class com.palantir.giraffe.ssh.PublicKeySshCredential
Returns the path of the private key used by this credential if it is available.
getLogger() - Method in class com.palantir.giraffe.ssh.SshSystemRequest
 
getMessage() - Method in exception com.palantir.giraffe.command.CommandException
Returns a description of the executed command and how it failed.
getMessage() - Method in exception com.palantir.giraffe.command.CommandTimeoutException
Returns a description of the executed command until the time out.
getName(int) - Method in class com.palantir.giraffe.file.base.AbstractImmutableListPath
 
getName() - Method in class com.palantir.giraffe.file.base.attribute.GroupIdPrincipal
Returns a string representation of this group's ID.
getName() - Method in class com.palantir.giraffe.file.base.attribute.UserIdPrincipal
Returns a string representation of this user's ID.
getName(int) - Method in class com.palantir.giraffe.file.base.ImmutableListPathCore
 
getName(int) - Method in interface com.palantir.giraffe.file.base.PathCore
 
getName(int) - Method in class com.palantir.giraffe.file.UniformPath
 
getNameCount() - Method in class com.palantir.giraffe.file.base.AbstractImmutableListPath
 
getNameCount() - Method in class com.palantir.giraffe.file.base.ImmutableListPathCore
 
getNameCount() - Method in interface com.palantir.giraffe.file.base.PathCore
 
getNameCount() - Method in class com.palantir.giraffe.file.UniformPath
 
getOperator() - Method in enum com.palantir.giraffe.file.base.attribute.PermissionChange
 
getOwner() - Method in class com.palantir.giraffe.file.base.attribute.AbstractPosixFileAttributeView
 
getParent() - Method in class com.palantir.giraffe.file.base.AbstractImmutableListPath
 
getParent() - Method in class com.palantir.giraffe.file.base.ImmutableListPathCore
 
getParent() - Method in interface com.palantir.giraffe.file.base.PathCore
 
getParent() - Method in class com.palantir.giraffe.file.UniformPath
 
getPassword() - Method in class com.palantir.giraffe.ssh.PasswordSshCredential
 
getPath(String, String...) - Method in class com.palantir.giraffe.file.base.BaseFileSystem
 
getPath(String) - Method in class com.palantir.giraffe.file.base.BaseFileSystem
Converts a single path string with separators to a Path object.
getPath(String, String...) - Method in class com.palantir.giraffe.host.AbstractHostControlSystem
 
getPath(String, String...) - Method in interface com.palantir.giraffe.host.HostControlSystem
Gets a path on this host's file system.
getPathMatcher(String) - Method in class com.palantir.giraffe.file.base.BaseFileSystem
 
getPathSegments() - Method in class com.palantir.giraffe.file.base.ImmutableListPathCore
 
getPort() - Method in class com.palantir.giraffe.ssh.SshSystemRequest
 
getPosixFactory() - Method in class com.palantir.giraffe.file.base.attribute.PosixFileAttributeViewFactory
 
getPrivateKey() - Method in class com.palantir.giraffe.ssh.PublicKeySshCredential
 
getRegisteredViews() - Method in class com.palantir.giraffe.file.base.attribute.FileAttributeViewRegistry
 
getResponse(String) - Method in interface com.palantir.giraffe.command.interactive.ResponseProvider.OutputMatcher
 
getResult() - Method in exception com.palantir.giraffe.command.CommandException
Returns the result of executing the command.
getResult() - Method in exception com.palantir.giraffe.command.CommandTimeoutException
Returns the result of executing the command until the timeout.
getRoot() - Method in class com.palantir.giraffe.file.base.AbstractImmutableListPath
 
getRoot() - Method in class com.palantir.giraffe.file.base.ImmutableListPathCore
 
getRoot() - Method in interface com.palantir.giraffe.file.base.PathCore
 
getRoot() - Method in class com.palantir.giraffe.file.UniformPath
 
getRootString() - Method in class com.palantir.giraffe.file.base.ImmutableListPathCore
Returns the root component of this path, or null if this path is relative.
getStdErr() - Method in interface com.palantir.giraffe.command.CommandFuture
Returns the command process's standard error stream.
getStdErr() - Method in class com.palantir.giraffe.command.CommandResult
Returns the standard error output of the command.
getStderrWindowSize() - Method in class com.palantir.giraffe.command.CommandContext
Returns this context's error window.
getStdIn() - Method in interface com.palantir.giraffe.command.CommandFuture
Returns the command process's standard input stream.
getStdOut() - Method in interface com.palantir.giraffe.command.CommandFuture
Returns the command process's standard output stream.
getStdOut() - Method in class com.palantir.giraffe.command.CommandResult
Returns the standard output of the command.
getStdoutWindowSize() - Method in class com.palantir.giraffe.command.CommandContext
Returns this context's output window.
getUid() - Method in class com.palantir.giraffe.file.base.attribute.UserIdPrincipal
 
getUri() - Method in exception com.palantir.giraffe.command.CommandException
Returns the URI of the system that executed the command.
getUri() - Method in exception com.palantir.giraffe.command.CommandTimeoutException
Returns the URI of the system that executed the command.
getUsername() - Method in class com.palantir.giraffe.ssh.SshCredential
 
getUsername() - Method in class com.palantir.giraffe.ssh.SshSystemRequest
 
getUserPrincipalLookupService() - Method in class com.palantir.giraffe.file.base.BaseFileSystem
 
getWorkingDirectory() - Method in class com.palantir.giraffe.command.CommandContext
Returns this context's working directory.
Globs - Class in com.palantir.giraffe.file.base
Utility methods for working with glob patterns.
group() - Method in interface com.palantir.giraffe.file.base.attribute.AnnotatedPosixFileAttributes
 
group(GroupPrincipal) - Method in interface com.palantir.giraffe.file.base.attribute.PosixFileAttributeSetter
 
GroupIdPrincipal - Class in com.palantir.giraffe.file.base.attribute
A GroupPrincipal that represents users by integer IDs.
GroupIdPrincipal(int) - Constructor for class com.palantir.giraffe.file.base.attribute.GroupIdPrincipal
 

H

hashCode() - Method in interface com.palantir.giraffe.command.Command
Returns a hash code for this Command.
hashCode() - Method in class com.palantir.giraffe.file.base.AbstractImmutableListPath
 
hashCode() - Method in class com.palantir.giraffe.file.base.attribute.GroupIdPrincipal
 
hashCode() - Method in class com.palantir.giraffe.file.base.attribute.UserIdPrincipal
 
hashCode() - Method in class com.palantir.giraffe.file.base.BasePath
 
hashCode() - Method in class com.palantir.giraffe.file.base.ImmutableListPathCore
 
hashCode() - Method in class com.palantir.giraffe.file.UniformPath
 
hashCode() - Method in class com.palantir.giraffe.host.Host
 
hashCode() - Method in class com.palantir.giraffe.host.SystemRequest
 
Host - Class in com.palantir.giraffe.host
Represents a host with a unique hostname in a network.
HostAccessor - Interface in com.palantir.giraffe.host
Provides access to a host by opening file systems and execution systems.
HostAccessorProvider - Class in com.palantir.giraffe.host.spi
Service provider class for HostAccessors.
HostAccessorProvider() - Constructor for class com.palantir.giraffe.host.spi.HostAccessorProvider
 
HostAccessors - Class in com.palantir.giraffe.host
Creates HostAccessor instances.
HostControlSystem - Interface in com.palantir.giraffe.host
Combines a file system and an execution system for a local or remote host.
HostControlSystemUpgradeable - Interface in com.palantir.giraffe.host
Systems that implement this interface can be upgraded into HostControlSystem instances.

I

ignoreExitStatus() - Method in class com.palantir.giraffe.command.CommandContext.Builder
Allows any exit status for commands executed with this context.
ignoreExitStatus() - Static method in class com.palantir.giraffe.command.CommandContext
Returns a context that ignores the exit status of commands.
ImmutableListPathCore - Class in com.palantir.giraffe.file.base
A PathCore implementation backed by an ImmutableList of segments.
ImmutableListPathCore(String, Iterable<String>) - Constructor for class com.palantir.giraffe.file.base.ImmutableListPathCore
Constructs a new core instance.
ImmutableListPathCore.Parser - Class in com.palantir.giraffe.file.base
Creates ImmutableListPathCore instances from path strings.
ImmutableListPathCore.Parser.NamedRootFormat - Enum in com.palantir.giraffe.file.base
Specifies the format of named roots in a path string.
InetAddressUnresolvableException - Exception in com.palantir.giraffe.host
Unchecked exception thrown when a hostname cannot be resolved to an InetAddress.
InetAddressUnresolvableException(String, Throwable) - Constructor for exception com.palantir.giraffe.host.InetAddressUnresolvableException
Creates an exception with the specified hostname and cause.
init(K, SystemCache.Factory<S>) - Method in class com.palantir.giraffe.file.base.SystemCache
Atomically initializes a system associated with key if no such system exists.
installedProviders() - Static method in class com.palantir.giraffe.command.spi.ExecutionSystemProvider
 
installedProviders() - Static method in class com.palantir.giraffe.host.spi.HostAccessorProvider
 
isAbsolute() - Method in class com.palantir.giraffe.file.base.AbstractImmutableListPath
 
isAbsolute() - Method in class com.palantir.giraffe.file.base.ImmutableListPathCore
 
isAbsolute() - Method in interface com.palantir.giraffe.file.base.PathCore
 
isAbsolute() - Method in class com.palantir.giraffe.file.UniformPath
 
isArchive() - Method in interface com.palantir.giraffe.file.base.attribute.AnnotatedDosFileAttributes
 
isClosed() - Method in class com.palantir.giraffe.command.CommandExitLatch
 
isCompatible(Path) - Method in class com.palantir.giraffe.file.base.BaseFileSystemProvider
 
isDefault() - Method in class com.palantir.giraffe.command.CommandEnvironment
Determines if this environment is the unmodified default environment.
isDirectory() - Method in interface com.palantir.giraffe.file.base.attribute.AnnotatedBasicFileAttributes
 
isEmpty(Path) - Static method in class com.palantir.giraffe.file.MoreFiles
Test if the given path is empty.
isHidden() - Method in interface com.palantir.giraffe.file.base.attribute.AnnotatedDosFileAttributes
 
isHidden(P) - Method in class com.palantir.giraffe.file.base.BaseFileSystem
 
isHidden(Path) - Method in class com.palantir.giraffe.file.base.BaseFileSystemProvider
 
isLocal(Command) - Static method in class com.palantir.giraffe.command.Commands
Determines if the given command is associated with the default (local) execution system.
isLocal(Path) - Static method in class com.palantir.giraffe.file.MoreFiles
Determines if the given path is associated with the default (local) file system.
isOpen() - Method in class com.palantir.giraffe.command.ExecutionSystem
Returns true if this system is open.
isOpen() - Method in class com.palantir.giraffe.file.base.AbstractSeekableByteChannel
 
isOther() - Method in interface com.palantir.giraffe.file.base.attribute.AnnotatedBasicFileAttributes
 
isReadOnly() - Method in interface com.palantir.giraffe.file.base.attribute.AnnotatedDosFileAttributes
 
isRegularFile() - Method in interface com.palantir.giraffe.file.base.attribute.AnnotatedBasicFileAttributes
 
isSameFile(P, P) - Method in class com.palantir.giraffe.file.base.BaseFileSystem
Determines two non-equal paths refer to the same file.
isSameFile(Path, Path) - Method in class com.palantir.giraffe.file.base.BaseFileSystemProvider
 
isSymbolicLink() - Method in interface com.palantir.giraffe.file.base.attribute.AnnotatedBasicFileAttributes
 
isSystem() - Method in interface com.palantir.giraffe.file.base.attribute.AnnotatedDosFileAttributes
 
isUpgradeable(FileSystem) - Static method in class com.palantir.giraffe.SystemUpgrader
Returns true if the given file system can be upgrade to a host control system.
isUpgradeable(ExecutionSystem) - Static method in class com.palantir.giraffe.SystemUpgrader
Returns true if the given execution system can be upgraded to a host control system.
iterator() - Method in class com.palantir.giraffe.file.base.AbstractFilteredDirectoryStream
 
iterator() - Method in class com.palantir.giraffe.file.base.BasePath
 
iterator() - Method in class com.palantir.giraffe.file.UniformPath
 

K

KEEPALIVE_INTERVAL_KEY - Static variable in class com.palantir.giraffe.ssh.SshSystemRequest
 
KerberosSshCredential - Class in com.palantir.giraffe.ssh
Authenticates SSH connections via GSS-API in a Kerberos environment.
KerberosSshCredential(String) - Constructor for class com.palantir.giraffe.ssh.KerberosSshCredential
 

L

LargeFileCopy - Interface in com.palantir.giraffe.file.base.feature
Indicates that a FileSystemProvider supports efficient copying of large files.
lastAccessTime() - Method in interface com.palantir.giraffe.file.base.attribute.AnnotatedBasicFileAttributes
 
lastAccessTime(FileTime) - Method in interface com.palantir.giraffe.file.base.attribute.PosixFileAttributeSetter
 
lastModifiedTime() - Method in interface com.palantir.giraffe.file.base.attribute.AnnotatedBasicFileAttributes
 
lastModifiedTime(FileTime) - Method in interface com.palantir.giraffe.file.base.attribute.PosixFileAttributeSetter
 
LinkOptions - Class in com.palantir.giraffe.file.base
Utilities for working with LinkOptions.
listDirectory(Path) - Static method in class com.palantir.giraffe.file.MoreFiles
Gets a list of the files and directories in the given directory.
listDirectoryFiles(Path) - Static method in class com.palantir.giraffe.file.MoreFiles
Gets a list of the files in the given directory.
listDirectoryFilesRecursive(Path) - Static method in class com.palantir.giraffe.file.MoreFiles
Gets a list of the files in the given directory and all sub-directories.
listDirectoryRecursive(Path) - Static method in class com.palantir.giraffe.file.MoreFiles
Gets a list of the files and directories in the given directory and all sub-directories.
localhost() - Static method in class com.palantir.giraffe.host.Host
Gets the Host representing the local host.
LOGGER_KEY - Static variable in class com.palantir.giraffe.ssh.SshSystemRequest
 
lookupResponse(String) - Method in class com.palantir.giraffe.command.interactive.OrderedResponseProvider
 
lookupResponse(String) - Method in interface com.palantir.giraffe.command.interactive.ResponseProvider
 
lookupResponse(String) - Method in class com.palantir.giraffe.command.interactive.UnorderedResponseProvider
 

M

matchers() - Method in class com.palantir.giraffe.command.interactive.AbstractResponseProvider
 
MoreFiles - Class in com.palantir.giraffe.file
Provides static methods that extend the functionality provided by Files.
moveDirectory(Path, Path, CopyFlags) - Static method in class com.palantir.giraffe.file.base.CrossSystemTransfers
 
moveFile(Path, Path, CopyFlags) - Static method in class com.palantir.giraffe.file.base.CrossSystemTransfers
 

N

name() - Method in class com.palantir.giraffe.file.base.attribute.AbstractPosixFileAttributeView
 
namedRootParser(String, ImmutableListPathCore.Parser.NamedRootFormat, String) - Static method in class com.palantir.giraffe.file.base.ImmutableListPathCore
Constructs a new parser for path strings with named roots.
newAccessor(SystemRequest) - Static method in class com.palantir.giraffe.host.HostAccessors
Gets a new HostAccessor for given request.
newAccessor(SystemRequest) - Method in class com.palantir.giraffe.host.spi.HostAccessorProvider
 
newByteChannel(P, Set<? extends OpenOption>, FileAttribute<?>...) - Method in class com.palantir.giraffe.file.base.BaseFileSystem
 
newByteChannel(Path, Set<? extends OpenOption>, FileAttribute<?>...) - Method in class com.palantir.giraffe.file.base.BaseFileSystemProvider
 
newDirectoryStream(P, DirectoryStream.Filter<? super Path>) - Method in class com.palantir.giraffe.file.base.BaseFileSystem
 
newDirectoryStream(Path, DirectoryStream.Filter<? super Path>) - Method in class com.palantir.giraffe.file.base.BaseFileSystemProvider
 
newExecutionSystem(URI, Map<String, ?>) - Static method in class com.palantir.giraffe.command.ExecutionSystems
Creates a new execution system for the specified URI.
newExecutionSystem(URI, Map<String, ?>, ClassLoader) - Static method in class com.palantir.giraffe.command.ExecutionSystems
Creates a new execution system for the specified URI.
newExecutionSystem(URI, Map<String, ?>) - Method in class com.palantir.giraffe.command.spi.ExecutionSystemProvider
 
newFileSystem(URI, Map<String, ?>) - Method in class com.palantir.giraffe.file.base.CachingBaseFileSystemProvider
 
newPath(ImmutableListPathCore) - Method in class com.palantir.giraffe.file.base.AbstractImmutableListPath
 
newSetter() - Method in class com.palantir.giraffe.file.base.attribute.AbstractPosixFileAttributeView
 
newSystem() - Method in interface com.palantir.giraffe.file.base.SystemCache.Factory
 
newView(Path, LinkOption[]) - Method in interface com.palantir.giraffe.file.base.attribute.FileAttributeViewFactory
Creates a new view for the given path.
newWatchService() - Method in class com.palantir.giraffe.file.base.BaseFileSystem
 
NO_EXIT_STATUS - Static variable in class com.palantir.giraffe.command.CommandResult
Used when the exit status is not available.
normalize() - Method in class com.palantir.giraffe.file.base.AbstractImmutableListPath
 
normalize() - Method in class com.palantir.giraffe.file.base.ImmutableListPathCore
 
normalize() - Method in interface com.palantir.giraffe.file.base.PathCore
 
normalize() - Method in class com.palantir.giraffe.file.UniformPath
 

O

of(String) - Static method in class com.palantir.giraffe.ssh.KerberosSshCredential
 
of(String, String) - Static method in class com.palantir.giraffe.ssh.PasswordSshCredential
 
of(String, char[]) - Static method in class com.palantir.giraffe.ssh.PasswordSshCredential
 
of(String, String) - Static method in class com.palantir.giraffe.ssh.PublicKeySshCredential
 
of(String, byte[]) - Static method in class com.palantir.giraffe.ssh.PublicKeySshCredential
 
open() - Method in interface com.palantir.giraffe.host.HostAccessor
Opens a new host control system on this host.
open() - Method in class com.palantir.giraffe.ssh.SshHostAccessor
 
openFileSystem(URI, Map<String, ?>) - Method in class com.palantir.giraffe.file.base.CachingBaseFileSystemProvider
Creates a new, open file system.
OpenFlags - Class in com.palantir.giraffe.file.base
Container for standard OpenOptions.
OpenFlags() - Constructor for class com.palantir.giraffe.file.base.OpenFlags
 
options() - Method in class com.palantir.giraffe.host.SystemRequest
 
OrderedResponseProvider<T> - Class in com.palantir.giraffe.command.interactive
An implementation of AbstractResponseProvider that matches <prompt, response> pairs sequentially.
OrderedResponseProvider.Builder<T> - Class in com.palantir.giraffe.command.interactive
A builder for an OrderedResponseProvider.
outputWindowSizes(int, int) - Method in class com.palantir.giraffe.command.CommandContext.Builder
Sets the window sizes for the process output streams.
owner() - Method in interface com.palantir.giraffe.file.base.attribute.AnnotatedPosixFileAttributes
 
owner(UserPrincipal) - Method in interface com.palantir.giraffe.file.base.attribute.PosixFileAttributeSetter
 

P

parse(String) - Method in class com.palantir.giraffe.file.base.ImmutableListPathCore.Parser
 
parser(String) - Static method in class com.palantir.giraffe.file.base.ImmutableListPathCore
Constructs a new parser for path strings with a single root.
PasswordSshCredential - Class in com.palantir.giraffe.ssh
Authenticates SSH connections using a password.
path() - Method in class com.palantir.giraffe.file.TempPath
Returns the Path to the temporary file or directory.
PathCore<P extends PathCore<P>> - Interface in com.palantir.giraffe.file.base
Defines basic functionality common to Path-like objects.
PermissionChange - Enum in com.palantir.giraffe.file.base.attribute
A type of change to a file's permissions.
permissions() - Method in interface com.palantir.giraffe.file.base.attribute.AnnotatedPosixFileAttributes
 
permissions(Set<PosixFilePermission>) - Method in interface com.palantir.giraffe.file.base.attribute.PosixFileAttributeSetter
 
PORT_KEY - Static variable in class com.palantir.giraffe.ssh.SshSystemRequest
 
position - Variable in class com.palantir.giraffe.file.base.AbstractSeekableByteChannel
This channel's position.
position() - Method in class com.palantir.giraffe.file.base.AbstractSeekableByteChannel
 
position(long) - Method in class com.palantir.giraffe.file.base.AbstractSeekableByteChannel
 
POSIX_NAME - Static variable in class com.palantir.giraffe.file.base.attribute.FileAttributeViews
PosixFileAttributeSetter - Interface in com.palantir.giraffe.file.base.attribute
An alternative to PosixFileAttributeView that allows bulk editing of POSIX file attributes.
PosixFileAttributeViewFactory - Class in com.palantir.giraffe.file.base.attribute
An abstract factory that creates PosixFileAttributeView and BasicFileAttributeView instances.
PosixFileAttributeViewFactory() - Constructor for class com.palantir.giraffe.file.base.attribute.PosixFileAttributeViewFactory
 
PosixFileAttributeViews - Class in com.palantir.giraffe.file.base.attribute
Utility methods for modifying POSIX file attributes.
processToken(String) - Method in class com.palantir.giraffe.command.interactive.CommandOutputTrigger
 
processToken(String) - Method in class com.palantir.giraffe.command.interactive.ShellConversation
 
provider() - Method in class com.palantir.giraffe.command.ExecutionSystem
Returns this system's ExecutionSystemProvider.
provider() - Method in class com.palantir.giraffe.file.base.BaseFileSystem
 
PublicKeySshCredential - Class in com.palantir.giraffe.ssh
Authenticates SSH connections using the private key of a key pair.

R

read - Variable in class com.palantir.giraffe.file.base.OpenFlags
 
readAllAttributes() - Method in class com.palantir.giraffe.file.base.attribute.DynamicAttributeAccessor
 
readAllString(Path, Charset) - Static method in class com.palantir.giraffe.file.MoreFiles
Reads the contents of a file as a string.
readAttributes() - Method in interface com.palantir.giraffe.file.base.attribute.AnnotatedBasicFileAttributeView
 
readAttributes() - Method in interface com.palantir.giraffe.file.base.attribute.AnnotatedDosFileAttributeView
 
readAttributes() - Method in interface com.palantir.giraffe.file.base.attribute.AnnotatedFileAttributeView
 
readAttributes() - Method in interface com.palantir.giraffe.file.base.attribute.AnnotatedPosixFileAttributeView
 
readAttributes(String) - Method in class com.palantir.giraffe.file.base.attribute.DynamicAttributeAccessor
 
readAttributes(Set<String>) - Method in class com.palantir.giraffe.file.base.attribute.DynamicAttributeAccessor
 
readAttributes(Path, Class<A>, LinkOption...) - Method in class com.palantir.giraffe.file.base.BaseFileSystemProvider
 
readAttributes(Path, String, LinkOption...) - Method in class com.palantir.giraffe.file.base.BaseFileSystemProvider
 
RecursiveCopy - Interface in com.palantir.giraffe.file.base.feature
Indicates that a FileSystemProvider supports efficient recursive copies.
RecursiveDelete - Interface in com.palantir.giraffe.file.base.feature
Indicates that a FileSystemProvider supports efficient recursive deletes.
RecursivePermissions - Interface in com.palantir.giraffe.file.base.feature
Indicates that a FileSystemProvider supports efficient recursive permission changes.
register(CommandFuture) - Method in class com.palantir.giraffe.command.CommandExitLatch
Register a new CommandFuture on the Listener.
register(WatchService, WatchEvent.Kind<?>...) - Method in class com.palantir.giraffe.file.base.BasePath
 
register(WatchService, WatchEvent.Kind<?>[], WatchEvent.Modifier...) - Method in class com.palantir.giraffe.file.base.BasePath
 
register(Closeable) - Method in class com.palantir.giraffe.file.base.CloseableRegistry
Registers closeable with the default priority, 0.
register(Closeable, int) - Method in class com.palantir.giraffe.file.base.CloseableRegistry
Registers closeable with the given priority.
regularFileFilter() - Static method in class com.palantir.giraffe.file.MoreFiles
Returns a directory filter that matches regular files.
relativize(Path) - Method in class com.palantir.giraffe.file.base.AbstractImmutableListPath
 
relativize(ImmutableListPathCore) - Method in class com.palantir.giraffe.file.base.ImmutableListPathCore
 
relativize(P) - Method in interface com.palantir.giraffe.file.base.PathCore
 
relativize(UniformPath) - Method in class com.palantir.giraffe.file.UniformPath
 
remove(K) - Method in class com.palantir.giraffe.file.base.SystemCache
Removes the initialized system associated with key from the cache.
removePermission(Path, PosixFilePermission) - Static method in class com.palantir.giraffe.file.MoreFiles
Removes a permission from a file or directory.
removePermissionRecursive(Path, PosixFilePermission) - Static method in class com.palantir.giraffe.file.MoreFiles
Recursively removes a permission from a directory.
replaceExisting - Variable in class com.palantir.giraffe.file.base.CopyFlags
 
request() - Method in interface com.palantir.giraffe.host.AuthenticatedHostAccessor
 
request() - Method in interface com.palantir.giraffe.host.HostAccessor
Returns the SystemRequest object used when opening new systems.
request() - Method in class com.palantir.giraffe.ssh.SshHostAccessor
 
requireExitStatus(int) - Method in class com.palantir.giraffe.command.CommandContext.Builder
Sets the required exit status for commands executed with this context.
requireExitStatus(Predicate<Integer>) - Method in class com.palantir.giraffe.command.CommandContext.Builder
Indicates what the permissible exit status of a command execution is through a Predicate.
requireExitStatus(int) - Static method in class com.palantir.giraffe.command.CommandContext
Returns a context that requires commands exit with the given status.
resolve(Path) - Method in class com.palantir.giraffe.file.base.AbstractImmutableListPath
 
resolve(String) - Method in class com.palantir.giraffe.file.base.BasePath
 
resolve(ImmutableListPathCore) - Method in class com.palantir.giraffe.file.base.ImmutableListPathCore
 
resolve(P) - Method in interface com.palantir.giraffe.file.base.PathCore
 
resolve(UniformPath) - Method in class com.palantir.giraffe.file.UniformPath
 
resolve(String) - Method in class com.palantir.giraffe.file.UniformPath
 
resolveSibling(Path) - Method in class com.palantir.giraffe.file.base.AbstractImmutableListPath
 
resolveSibling(String) - Method in class com.palantir.giraffe.file.base.BasePath
 
resolveSibling(ImmutableListPathCore) - Method in class com.palantir.giraffe.file.base.ImmutableListPathCore
 
resolveSibling(P) - Method in interface com.palantir.giraffe.file.base.PathCore
 
resolveSibling(UniformPath) - Method in class com.palantir.giraffe.file.UniformPath
 
resolveSibling(String) - Method in class com.palantir.giraffe.file.UniformPath
 
resolvesToHost(Host) - Method in class com.palantir.giraffe.host.Host
Determines if this host has the same canonical name as another host.
ResponseProvider<T> - Interface in com.palantir.giraffe.command.interactive
Used to get a response, given an instance of an input String.
ResponseProvider.OutputMatcher<T> - Interface in com.palantir.giraffe.command.interactive
Represents a <prompt, response> pair.
result - Variable in class com.palantir.giraffe.command.TerminatedCommand
 

S

set(String, String) - Method in class com.palantir.giraffe.command.CommandEnvironment
Sets the given variable in this environment.
set() - Method in interface com.palantir.giraffe.file.base.attribute.PosixFileAttributeSetter
 
set(String, Object) - Method in class com.palantir.giraffe.host.SystemRequest
 
setAll(Map<String, String>) - Method in class com.palantir.giraffe.command.CommandEnvironment
Sets all the variables defined by the given map in this environment.
setAll(Map<String, ?>) - Method in class com.palantir.giraffe.host.SystemRequest
 
setArchive(boolean) - Method in interface com.palantir.giraffe.file.base.attribute.AnnotatedDosFileAttributeView
 
setAttribute(String, Object) - Method in class com.palantir.giraffe.file.base.attribute.DynamicAttributeAccessor
 
setAttribute(Path, String, Object, LinkOption...) - Method in class com.palantir.giraffe.file.base.BaseFileSystemProvider
 
setCreationTime(FileTime) - Method in class com.palantir.giraffe.file.base.attribute.AbstractPosixFileAttributeView
 
setCreationTime(FileTime) - Method in interface com.palantir.giraffe.file.base.attribute.AnnotatedBasicFileAttributeView
 
setExecutable(Path) - Static method in class com.palantir.giraffe.file.MoreFiles
Adds the OWNER_EXECUTE permission to a file or directory.
setGroup(GroupPrincipal) - Method in class com.palantir.giraffe.file.base.attribute.AbstractPosixFileAttributeView
 
setGroup(GroupPrincipal) - Method in interface com.palantir.giraffe.file.base.attribute.AnnotatedPosixFileAttributeView
 
setHidden(boolean) - Method in interface com.palantir.giraffe.file.base.attribute.AnnotatedDosFileAttributeView
 
setKeepaliveInterval(int) - Method in class com.palantir.giraffe.ssh.SshSystemRequest
 
setLastAccessTime(FileTime) - Method in class com.palantir.giraffe.file.base.attribute.AbstractPosixFileAttributeView
 
setLastAccessTime(FileTime) - Method in interface com.palantir.giraffe.file.base.attribute.AnnotatedBasicFileAttributeView
 
setLastModifiedTime(FileTime) - Method in class com.palantir.giraffe.file.base.attribute.AbstractPosixFileAttributeView
 
setLastModifiedTime(FileTime) - Method in interface com.palantir.giraffe.file.base.attribute.AnnotatedBasicFileAttributeView
 
setLogger(Logger) - Method in class com.palantir.giraffe.ssh.SshSystemRequest
 
setOwner(UserPrincipal) - Method in class com.palantir.giraffe.file.base.attribute.AbstractPosixFileAttributeView
 
setOwner(UserPrincipal) - Method in interface com.palantir.giraffe.file.base.attribute.AnnotatedPosixFileAttributeView
 
setPermissionRecursive(Path, Set<PosixFilePermission>) - Static method in class com.palantir.giraffe.file.MoreFiles
Recursively sets permissions for a directory.
setPermissions(Set<PosixFilePermission>) - Method in class com.palantir.giraffe.file.base.attribute.AbstractPosixFileAttributeView
 
setPermissions(Set<PosixFilePermission>) - Method in interface com.palantir.giraffe.file.base.attribute.AnnotatedPosixFileAttributeView
 
setPort(int) - Method in class com.palantir.giraffe.ssh.SshSystemRequest
 
setReadOnly(boolean) - Method in interface com.palantir.giraffe.file.base.attribute.AnnotatedDosFileAttributeView
 
setStandardOption(CopyFlags, CopyOption) - Static method in class com.palantir.giraffe.file.base.CopyFlags
Sets a standard option in flags.
setStandardOption(OpenFlags, OpenOption) - Static method in class com.palantir.giraffe.file.base.OpenFlags
Sets a standard option in flags.
setSystem(boolean) - Method in interface com.palantir.giraffe.file.base.attribute.AnnotatedDosFileAttributeView
 
setTimes(FileTime, FileTime, FileTime) - Method in class com.palantir.giraffe.file.base.attribute.AbstractPosixFileAttributeView
 
ShellConversation - Class in com.palantir.giraffe.command.interactive
Asynchronously responds to interactive command execution, as represented by a CommandFuture, using a ResponseProvider.
ShellConversation(ResponseProvider<String>, CommandFuture) - Constructor for class com.palantir.giraffe.command.interactive.ShellConversation
 
size() - Method in interface com.palantir.giraffe.file.base.attribute.AnnotatedBasicFileAttributes
 
sparse - Variable in class com.palantir.giraffe.file.base.OpenFlags
 
SshAuthenticator - Interface in com.palantir.giraffe.ssh
Implementations of this interface authenticate SSH connections given appropriate credentials.
SshCredential - Class in com.palantir.giraffe.ssh
Base class for SSH credentials.
SshHostAccessor - Class in com.palantir.giraffe.ssh
Provides access to a file system and execution system on a host using SSH.
SshSystemRequest - Class in com.palantir.giraffe.ssh
Contains information needed to open a HostControlSystem that uses the SSH protocol.
SshSystemRequest(URI, SshCredential) - Constructor for class com.palantir.giraffe.ssh.SshSystemRequest
 
SshSystemRequest(URI, Map<String, ?>) - Constructor for class com.palantir.giraffe.ssh.SshSystemRequest
 
StandardPathMatchers - Class in com.palantir.giraffe.file.base
Utilities for creating standard PathMatchers.
startsWith(Path) - Method in class com.palantir.giraffe.file.base.AbstractImmutableListPath
 
startsWith(String) - Method in class com.palantir.giraffe.file.base.BasePath
 
startsWith(ImmutableListPathCore) - Method in class com.palantir.giraffe.file.base.ImmutableListPathCore
 
startsWith(P) - Method in interface com.palantir.giraffe.file.base.PathCore
 
startsWith(UniformPath) - Method in class com.palantir.giraffe.file.UniformPath
 
startsWith(String) - Method in class com.palantir.giraffe.file.UniformPath
 
subpath(int, int) - Method in class com.palantir.giraffe.file.base.AbstractImmutableListPath
 
subpath(int, int) - Method in class com.palantir.giraffe.file.base.ImmutableListPathCore
 
subpath(int, int) - Method in interface com.palantir.giraffe.file.base.PathCore
 
subpath(int, int) - Method in class com.palantir.giraffe.file.UniformPath
 
supportedFileAttributeViews() - Method in class com.palantir.giraffe.file.base.BaseFileSystem
 
SuppressedCloseable - Class in com.palantir.giraffe.file.base
A composite Closeable that closes the given Closeables in order, suppressing intermediate exceptions.
sync - Variable in class com.palantir.giraffe.file.base.OpenFlags
 
SystemCache<K,S> - Class in com.palantir.giraffe.file.base
A thread-safe cache for file systems or similar I/O systems.
SystemCache() - Constructor for class com.palantir.giraffe.file.base.SystemCache
 
SystemCache.Factory<S> - Interface in com.palantir.giraffe.file.base
Constructs new systems to be stored in the cache.
SystemPreconditions - Class in com.palantir.giraffe
Simple static methods to verify the state of file and execution systems taken as arguments.
SystemRequest - Class in com.palantir.giraffe.host
Contains information needed to open a HostControlSystem.
SystemRequest(URI) - Constructor for class com.palantir.giraffe.host.SystemRequest
 
SystemUpgrader - Class in com.palantir.giraffe
Creates HostControlSystem instances from FileSystem and ExecutionSystem instances.

T

TempPath - Class in com.palantir.giraffe.file
A temporary path that is deleted when closed.
TerminatedCommand - Class in com.palantir.giraffe.command
A simple container for information about terminated commands.
TerminatedCommand(Command, CommandContext, CommandResult) - Constructor for class com.palantir.giraffe.command.TerminatedCommand
 
toAbsolutePath() - Method in class com.palantir.giraffe.file.base.AbstractImmutableListPath
 
toArray(boolean) - Static method in class com.palantir.giraffe.file.base.LinkOptions
 
toBits(Set<PosixFilePermission>) - Static method in class com.palantir.giraffe.file.base.attribute.ChmodFilePermissions
Converts the specified PosixFilePermission set into a bit field representation.
toFile() - Method in class com.palantir.giraffe.file.base.BasePath
 
tokenMatches(String) - Method in interface com.palantir.giraffe.command.interactive.ResponseProvider.OutputMatcher
 
toMode(PermissionChange, Set<PosixFilePermission>) - Static method in class com.palantir.giraffe.file.base.attribute.ChmodFilePermissions
Converts the specified PosixFilePermission set and change type into a chmod mode string.
toPath() - Method in class com.palantir.giraffe.file.UniformPath
Converts this uniform path to a real Path on the default file system.
toPath(FileSystem) - Method in class com.palantir.giraffe.file.UniformPath
Converts this uniform path to a real Path on the given file system.
toPathString(String) - Method in class com.palantir.giraffe.file.base.ImmutableListPathCore
 
toPathString(String) - Method in interface com.palantir.giraffe.file.base.PathCore
 
toPermissions(int) - Static method in class com.palantir.giraffe.file.base.attribute.ChmodFilePermissions
Converts the specified bit field representation into a PosixFilePermission set.
toRegex(String, String) - Static method in class com.palantir.giraffe.file.base.Globs
Converts the given glob pattern into a regular expression.
toRegex(String, char) - Static method in class com.palantir.giraffe.file.base.Globs
Converts the given glob pattern into a regular expression.
toResult(CommandFuture) - Static method in class com.palantir.giraffe.command.Commands
Creates a CommandResult from the given CommandFuture.
toResult(CommandFuture, int) - Static method in class com.palantir.giraffe.command.Commands
Creates a CommandResult from the given CommandFuture.
toString() - Method in interface com.palantir.giraffe.command.Command
Returns a human-readable string representation of this command.
toString() - Method in class com.palantir.giraffe.command.CommandResult
 
toString() - Method in class com.palantir.giraffe.file.base.AbstractImmutableListPath
 
toString() - Method in class com.palantir.giraffe.file.base.ImmutableListPathCore
 
toString() - Method in class com.palantir.giraffe.file.TempPath
 
toString() - Method in class com.palantir.giraffe.file.UniformPath
 
toString() - Method in class com.palantir.giraffe.host.Host
Returns the hostname of this host.
toUri() - Method in class com.palantir.giraffe.file.base.AbstractImmutableListPath
 
truncateExisting - Variable in class com.palantir.giraffe.file.base.OpenFlags
 
truncatePosition(long) - Method in class com.palantir.giraffe.file.base.AbstractSeekableByteChannel
Sets this channel's position to size if it is less than the current position.

U

UniformPath - Class in com.palantir.giraffe.file
A Path-like object that defines a file system independent path syntax and is not associated with any FileSystem instance.
UnorderedResponseProvider<T> - Class in com.palantir.giraffe.command.interactive
An implementation of AbstractResponseProvider that matches <prompt, response> pairs in any order.
UnorderedResponseProvider.Builder<T> - Class in com.palantir.giraffe.command.interactive
A builder for an UnorderedResponseProvider.
unregister(Closeable) - Method in class com.palantir.giraffe.file.base.CloseableRegistry
Removes closeable from this registry.
upcast(A, String, Class<A>) - Static method in class com.palantir.giraffe.file.base.attribute.FileAttributeViews
Converts a subclass of targetType into a true view of type targetType.
upgrade(ExecutionSystem) - Static method in class com.palantir.giraffe.SystemUpgrader
Returns an open HostControlSystem that accesses the same resources as the given execution system.
upgrade(FileSystem) - Static method in class com.palantir.giraffe.SystemUpgrader
Returns an open HostControlSystem that accesses the same resources as the given file system.
uri() - Method in class com.palantir.giraffe.command.ExecutionSystem
Returns this system's URI.
uri() - Method in class com.palantir.giraffe.file.base.BaseFileSystem
Returns this file system's URI.
uri() - Method in class com.palantir.giraffe.host.AbstractHostControlSystem
 
uri() - Method in interface com.palantir.giraffe.host.HostControlSystem
Returns this system's URI.
uri() - Method in class com.palantir.giraffe.host.SystemRequest
 
uriToCacheKey(URI) - Method in class com.palantir.giraffe.file.base.CachingBaseFileSystemProvider
Converts uri into a cache key.
UserIdPrincipal - Class in com.palantir.giraffe.file.base.attribute
A UserPrincipal that represents users by integer IDs.
UserIdPrincipal(int) - Constructor for class com.palantir.giraffe.file.base.attribute.UserIdPrincipal
 

V

validateFromOptions(Iterable<? extends OpenOption>) - Static method in class com.palantir.giraffe.file.base.OpenFlags
Converts the specified options to flags, sets missing implied flags, and checks for invalid combinations.
valueOf(String) - Static method in enum com.palantir.giraffe.command.CommandEnvironment.BaseEnvironment
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.palantir.giraffe.file.base.attribute.PermissionChange
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.palantir.giraffe.file.base.ImmutableListPathCore.Parser.NamedRootFormat
Returns the enum constant of this type with the specified name.
values() - Static method in enum com.palantir.giraffe.command.CommandEnvironment.BaseEnvironment
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.palantir.giraffe.file.base.attribute.PermissionChange
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.palantir.giraffe.file.base.ImmutableListPathCore.Parser.NamedRootFormat
Returns an array containing the constants of this enum type, in the order they are declared.
viewName() - Method in interface com.palantir.giraffe.file.base.attribute.FileAttributeViewFactory
Returns the name of views created by this factory.
viewType() - Method in interface com.palantir.giraffe.file.base.attribute.FileAttributeViewFactory
Returns the base type of views created by this factory.

W

waitFor(CommandFuture) - Static method in class com.palantir.giraffe.command.Commands
Waits for the command associated with a CommandFuture to terminate.
waitFor(CommandFuture, long, TimeUnit) - Static method in class com.palantir.giraffe.command.Commands
Waits for the command associated with a CommandFuture to terminate or the timeout to be reached.
withEnvironment(CommandEnvironment) - Static method in class com.palantir.giraffe.command.CommandContext
Returns a context that sets the given environment before commands execute.
workingDirectory(UniformPath) - Method in class com.palantir.giraffe.command.CommandContext.Builder
Sets the working directory for commands executed with this context.
workingDirectory(Path) - Method in class com.palantir.giraffe.command.CommandContext.Builder
Sets the working directory for commands executed with this context.
workingDirectory(UniformPath) - Static method in class com.palantir.giraffe.command.CommandContext
Returns a context that executes commands in the given directory.
workingDirectory(Path) - Static method in class com.palantir.giraffe.command.CommandContext
Returns a context that executes commands in the given directory.
wrap(Path) - Static method in class com.palantir.giraffe.file.TempPath
Wraps an existing Path as a TempPath.
write - Variable in class com.palantir.giraffe.file.base.OpenFlags
 
write(Path, String, Charset, OpenOption...) - Static method in class com.palantir.giraffe.file.MoreFiles
Writes a string to a file.
A B C D E F G H I K L M N O P R S T U V W 
Skip navigation links