org.oddjob.io

Class CopyJob

java.lang.Object

org.oddjob.io.CopyJob

All Implemented Interfaces:

java.io.Serializable, java.lang.Runnable

public class CopyJob
extends java.lang.Object
implements java.lang.Runnable, java.io.Serializable

Description

A Copy job. Copy either:

• A file from one name to another.
• A file or files or directories to a different directory.
• An input (from another job) to a file.
• A file to an output.
• An input to an output.

Example

Copy a file.

<oddjob id="this">
    <job>
        <copy to="${work.dir}">
            <from>
                <file file="${base.dir}/test/io/reference/test1.txt"/>
            </from>
        </copy>
    </job>
</oddjob>

Example

Copy a directory.

<oddjob id="this">
    <job>
        <copy to="${work.dir}">
            <from>
                <file file="${base.dir}/test/io/reference/a"/>
            </from>
        </copy>
    </job>
</oddjob>

Example

Copy from a file to a buffer.

<oddjob id="this">
    <job>
        <sequential>
            <jobs>
                <copy name="Copy from a file to a buffer">
                    <from>
                        <file file="${this.args[0]}/test/io/reference/test1.txt"/>
                    </from>
                    <output>
                        <identify id="buff">
                            <value>
                                <buffer/>
                            </value>
                        </identify>

                    </output>
                </copy>
                <echo id="e" name="What's in the file?">${buff}</echo>
            </jobs>
        </sequential>
    </job>
</oddjob>

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
CopyJob()

Method Summary

Modifier and Type	Method and Description
int	getDirectoriesCopied()
int	getFilesCopied()
java.io.File[]	getFrom() Get the from file.
java.io.InputStream	getInput()
java.lang.String	getName() Get the name.
java.io.OutputStream	getOutput()
java.io.File	getTo() Get the to file.
void	run()
void	setFrom(java.io.File[] file) Set the from file.
void	setInput(java.io.InputStream in) Set the InputStream.
void	setName(java.lang.String name) Set the name
void	setOutput(java.io.OutputStream out) Set the OutputStream.
void	setTo(java.io.File file) Set the to file.
java.lang.String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

CopyJob

public CopyJob()

Method Detail

getName

public java.lang.String getName()

Get the name.

Returns:

The name.

setName

public void setName(java.lang.String name)

Set the name

Parameters:

name - The name.

getFrom

public java.io.File[] getFrom()

Get the from file.

Returns:

The from file.

setFrom

public void setFrom(java.io.File[] file)

Set the from file.

Parameters:

The - from file.

getTo

public java.io.File getTo()

Get the to file.

Returns:

The to file.

setTo

public void setTo(java.io.File file)

Set the to file.

Parameters:

The - to file.

setInput

public void setInput(java.io.InputStream in)

Set the InputStream.

Parameters:

The - InputStream.

setOutput

public void setOutput(java.io.OutputStream out)

Set the OutputStream.

Parameters:

The - OutputStream.

getFilesCopied

public int getFilesCopied()

getDirectoriesCopied

public int getDirectoriesCopied()

run

public void run()

Specified by:

run in interface java.lang.Runnable

getInput

public java.io.InputStream getInput()

Returns:

Returns the input.

getOutput

public java.io.OutputStream getOutput()

Returns:

Returns the output.

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object