DefaultNutsIOCompressAction (net.thevpc.nuts.nuts-runtime 0.8.2.0 API)

java.lang.Object
- net.thevpc.nuts.runtime.standalone.io.DefaultNutsIOCompressAction

All Implemented Interfaces:: NutsIOCompressAction

public class DefaultNutsIOCompressAction
extends Object
implements NutsIOCompressAction

Author:: thevpc

Constructor Summary

Constructors
Constructor and Description

DefaultNutsIOCompressAction(NutsWorkspace ws)

Constructors
Constructor and Description
`DefaultNutsIOCompressAction(NutsWorkspace ws)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`protected NutsInputAction`	`_input()`
`protected NutsOutputAction`	`_output()`
`NutsIOCompressAction`	`addSource(File source)`
`NutsIOCompressAction`	`addSource(InputStream source)`
`NutsIOCompressAction`	`addSource(Object source)`
`NutsIOCompressAction`	`addSource(Path source)`
`NutsIOCompressAction`	`addSource(String source)`
`NutsIOCompressAction`	`addSource(URL source)`
`String`	`getFormat()`
`Object`	`getFormatOption(String option)`
`NutsProgressFactory`	`getProgressMonitorFactory()` return progress factory responsible of creating progress monitor
`NutsSession`	`getSession()`
`List<Object>`	`getSources()`
`Object`	`getTarget()`
`boolean`	`isLogProgress()`
`boolean`	`isSafe()`
`boolean`	`isSkipRoot()`
`NutsIOCompressAction`	`run()`
`void`	`runZip()`
`NutsIOCompressAction`	`setFormat(String format)`
`NutsIOCompressAction`	`setFormatOption(String option, Object value)`
`DefaultNutsIOCompressAction`	`setLogProgress(boolean value)`
`NutsIOCompressAction`	`setProgressMonitor(NutsProgressMonitor value)` set progress monitor.
`NutsIOCompressAction`	`setProgressMonitorFactory(NutsProgressFactory value)` set progress factory responsible of creating progress monitor
`NutsIOCompressAction`	`setSafe(boolean value)`
`NutsIOCompressAction`	`setSession(NutsSession session)`
`NutsIOCompressAction`	`setSkipRoot(boolean value)`
`NutsIOCompressAction`	`setTarget(File target)`
`NutsIOCompressAction`	`setTarget(NutsOutput target)`
`NutsIOCompressAction`	`setTarget(Object target)`
`NutsIOCompressAction`	`setTarget(OutputStream target)`
`NutsIOCompressAction`	`setTarget(Path target)`
`NutsIOCompressAction`	`setTarget(String target)`
`NutsIOCompressAction`	`to(File target)`
`NutsIOCompressAction`	`to(NutsOutput target)`
`NutsIOCompressAction`	`to(Object target)`
`NutsIOCompressAction`	`to(OutputStream target)`
`NutsIOCompressAction`	`to(Path target)`
`NutsIOCompressAction`	`to(String target)`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - DefaultNutsIOCompressAction
```
public DefaultNutsIOCompressAction(NutsWorkspace ws)
```
- Method Detail
  - _input
```
protected NutsInputAction _input()
```
  - _output
```
protected NutsOutputAction _output()
```
  - getSources
```
public List<Object> getSources()
```
    Specified by:
    
    getSources in interface NutsIOCompressAction
  - addSource
```
public NutsIOCompressAction addSource(InputStream source)
```
    Specified by:
    
    addSource in interface NutsIOCompressAction
  - addSource
```
public NutsIOCompressAction addSource(File source)
```
    Specified by:
    
    addSource in interface NutsIOCompressAction
  - addSource
```
public NutsIOCompressAction addSource(Path source)
```
    Specified by:
    
    addSource in interface NutsIOCompressAction
  - addSource
```
public NutsIOCompressAction addSource(URL source)
```
    Specified by:
    
    addSource in interface NutsIOCompressAction
  - setTarget
```
public NutsIOCompressAction setTarget(NutsOutput target)
```
    Specified by:
    
    setTarget in interface NutsIOCompressAction
  - setTarget
```
public NutsIOCompressAction setTarget(OutputStream target)
```
    Specified by:
    
    setTarget in interface NutsIOCompressAction
  - setTarget
```
public NutsIOCompressAction setTarget(Path target)
```
    Specified by:
    
    setTarget in interface NutsIOCompressAction
  - setTarget
```
public NutsIOCompressAction setTarget(File target)
```
    Specified by:
    
    setTarget in interface NutsIOCompressAction
  - setTarget
```
public NutsIOCompressAction setTarget(String target)
```
    Specified by:
    
    setTarget in interface NutsIOCompressAction
  - addSource
```
public NutsIOCompressAction addSource(Object source)
```
  - addSource
```
public NutsIOCompressAction addSource(String source)
```
    Specified by:
    
    addSource in interface NutsIOCompressAction
  - to
```
public NutsIOCompressAction to(NutsOutput target)
```
    Specified by:
    
    to in interface NutsIOCompressAction
  - to
```
public NutsIOCompressAction to(Object target)
```
    Specified by:
    
    to in interface NutsIOCompressAction
  - to
```
public NutsIOCompressAction to(String target)
```
    Specified by:
    
    to in interface NutsIOCompressAction
  - getTarget
```
public Object getTarget()
```
    Specified by:
    
    getTarget in interface NutsIOCompressAction
  - setTarget
```
public NutsIOCompressAction setTarget(Object target)
```
    Specified by:
    
    setTarget in interface NutsIOCompressAction
  - isLogProgress
```
public boolean isLogProgress()
```
    Specified by:
    
    isLogProgress in interface NutsIOCompressAction
  - setLogProgress
```
public DefaultNutsIOCompressAction setLogProgress(boolean value)
```
    Specified by:
    
    setLogProgress in interface NutsIOCompressAction
  - to
```
public NutsIOCompressAction to(File target)
```
    Specified by:
    
    to in interface NutsIOCompressAction
  - to
```
public NutsIOCompressAction to(OutputStream target)
```
    Specified by:
    
    to in interface NutsIOCompressAction
  - to
```
public NutsIOCompressAction to(Path target)
```
    Specified by:
    
    to in interface NutsIOCompressAction
  - getSession
```
public NutsSession getSession()
```
    Specified by:
    
    getSession in interface NutsIOCompressAction
  - setSession
```
public NutsIOCompressAction setSession(NutsSession session)
```
    Specified by:
    
    setSession in interface NutsIOCompressAction
  - run
```
public NutsIOCompressAction run()
```
    Specified by:
    
    run in interface NutsIOCompressAction
  - runZip
```
public void runZip()
```
  - getProgressMonitorFactory
```
public NutsProgressFactory getProgressMonitorFactory()
```
    return progress factory responsible of creating progress monitor
    
    Specified by:
    
    getProgressMonitorFactory in interface NutsIOCompressAction
    
    Returns:
    
    progress factory responsible of creating progress monitor
    
    Since:
    
    0.5.8
  - setProgressMonitorFactory
```
public NutsIOCompressAction setProgressMonitorFactory(NutsProgressFactory value)
```
    set progress factory responsible of creating progress monitor
    
    Specified by:
    
    setProgressMonitorFactory in interface NutsIOCompressAction
    
    Parameters:
    
    value - new value
    
    Returns:
    
    this instance
    
    Since:
    
    0.5.8
  - setProgressMonitor
```
public NutsIOCompressAction setProgressMonitor(NutsProgressMonitor value)
```
    set progress monitor. Will create a singleton progress monitor factory
    
    Specified by:
    
    setProgressMonitor in interface NutsIOCompressAction
    
    Parameters:
    
    value - new value
    
    Returns:
    
    this instance
    
    Since:
    
    0.5.8
  - isSafe
```
public boolean isSafe()
```
    Specified by:
    
    isSafe in interface NutsIOCompressAction
  - setSafe
```
public NutsIOCompressAction setSafe(boolean value)
```
    Specified by:
    
    setSafe in interface NutsIOCompressAction
  - isSkipRoot
```
public boolean isSkipRoot()
```
    Specified by:
    
    isSkipRoot in interface NutsIOCompressAction
  - setSkipRoot
```
public NutsIOCompressAction setSkipRoot(boolean value)
```
    Specified by:
    
    setSkipRoot in interface NutsIOCompressAction
  - setFormatOption
```
public NutsIOCompressAction setFormatOption(String option,
                                            Object value)
```
    Specified by:
    
    setFormatOption in interface NutsIOCompressAction
  - getFormatOption
```
public Object getFormatOption(String option)
```
    Specified by:
    
    getFormatOption in interface NutsIOCompressAction
  - getFormat
```
public String getFormat()
```
    Specified by:
    
    getFormat in interface NutsIOCompressAction
  - setFormat
```
public NutsIOCompressAction setFormat(String format)
```
    Specified by:
    
    setFormat in interface NutsIOCompressAction

Class DefaultNutsIOCompressAction

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

DefaultNutsIOCompressAction

Method Detail

_input

_output

getSources

addSource

addSource

addSource

addSource

setTarget

setTarget

setTarget

setTarget

setTarget

addSource

addSource

to

to

to

getTarget

setTarget

isLogProgress

setLogProgress

to

to

to

getSession

setSession

run

runZip

getProgressMonitorFactory

setProgressMonitorFactory

setProgressMonitor

isSafe

setSafe

isSkipRoot

setSkipRoot

setFormatOption

getFormatOption

getFormat

setFormat