Instructions (core 2.5.1 API)

org.hidetake.groovy.ssh.session.transfer.put.Instructions

All Implemented Interfaces and Traits:

java.lang.Iterable
```
class Instructions
extends java.lang.Object
```
Represents a collection of SCP PUT instructions such as java.io.File, StreamContent, EnterDirectory or LeaveDirectory.
Authors:
Hidetake Iwata

Properties Summary

Properties
Type	Name and description
`java.lang.String`	`base`
`boolean`	`recursive`

Constructor Summary

Constructors
Constructor and description
`Instructions (boolean recursive1, java.lang.String base1, java.util.Collection all1)`

Methods Summary

Methods
Type	Name and description
`static Instructions`	`forFile(java.io.File localPath, java.lang.String remoteBase)` Create Instructions for a file or directory.
`static Instructions`	`forFileWithFilter(java.io.File localPath, java.lang.String remoteBase, groovy.lang.Closure<java.lang.Boolean> filter)` Create Instructions for filtered files.
`static Instructions`	`forFiles(java.lang.Iterable<java.io.File> localFiles, java.lang.String remoteBase)` Create Instructions for a collection of files or directories
`static Instructions`	`forStreamContent(java.io.InputStream stream, java.lang.String path)` Create Instructions for stream content.
`java.util.Iterator`	`iterator()`

Inherited Methods Summary

Inherited Methods
Methods inherited from class	Name
`class java.lang.Object`	`java.lang.Object#wait(long, int), java.lang.Object#wait(long), java.lang.Object#wait(), java.lang.Object#equals(java.lang.Object), java.lang.Object#toString(), java.lang.Object#hashCode(), java.lang.Object#getClass(), java.lang.Object#notify(), java.lang.Object#notifyAll()`

- Property Detail
  - final java.lang.String base
  - final boolean recursive
- Constructor Detail
  - Instructions(boolean recursive1, java.lang.String base1, java.util.Collection all1)
- Method Detail
  - static Instructions forFile(java.io.File localPath, java.lang.String remoteBase)
    
    Create Instructions for a file or directory.
    Parameters:
    localPath - a file or directory
    remoteBase - base path of remote
    Returns:
    an instance of Instructions
  - static Instructions forFileWithFilter(java.io.File localPath, java.lang.String remoteBase, groovy.lang.Closure<java.lang.Boolean> filter)
    
    Create Instructions for filtered files.
    Parameters:
    localPath - a file or directory
    remoteBase - base path of remote
    filter - a closure called with a java.io.File
    Returns:
    an instance of Instructions
  - static Instructions forFiles(java.lang.Iterable<java.io.File> localFiles, java.lang.String remoteBase)
    
    Create Instructions for a collection of files or directories
    Parameters:
    localFiles - a collection of files or directories
    remoteBase - base path of remote
    Returns:
    an instance of Instructions
  - static Instructions forStreamContent(java.io.InputStream stream, java.lang.String path)
    
    Create Instructions for stream content.
    Parameters:
    localPath - a file or directory
    remoteBase - base path of remote
    Returns:
    an instance of Instructions
  - @java.lang.Override java.util.Iterator iterator()

Summary:
Property
Constructor
Method

| Detail:
Property
Constructor
Method

Groovy Documentation

[Groovy] Class Instructions

Properties Summary

Constructor Summary

Methods Summary

Inherited Methods Summary

Property Detail

final java.lang.String base

final boolean recursive

Constructor Detail

Instructions(boolean recursive1, java.lang.String base1, java.util.Collection all1)

Method Detail

static Instructions forFile(java.io.File localPath, java.lang.String remoteBase)

static Instructions forFileWithFilter(java.io.File localPath, java.lang.String remoteBase, groovy.lang.Closure<java.lang.Boolean> filter)

static Instructions forFiles(java.lang.Iterable<java.io.File> localFiles, java.lang.String remoteBase)

static Instructions forStreamContent(java.io.InputStream stream, java.lang.String path)

@java.lang.Override java.util.Iterator iterator()