org.springframework.xd.test.fixtures

Class SimpleFileSink

java.lang.Object

org.springframework.xd.test.fixtures.AbstractModuleFixture<SimpleFileSink>

org.springframework.xd.test.fixtures.SimpleFileSink

public class SimpleFileSink
extends AbstractModuleFixture<SimpleFileSink>

Used to generate the file sink portion of a stream. Used by Acceptance testing because it does not extend disposable.

Author:

Glenn Renfro

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	DEFAULT_MODE

Fields inherited from class org.springframework.xd.test.fixtures.AbstractModuleFixture

label

Constructor Summary

Constructors

Constructor and Description
SimpleFileSink() Use XD Defaults for the file name and directory to where the sink will write its results.
SimpleFileSink(java.lang.String dir, java.lang.String fileName, boolean binary, java.lang.String mode) Construct a new SimpleFileSink given the directory and file to write to as well as the if the file is binary and the mode that determines what to do if the file already exists.

Method Summary

Methods

Modifier and Type	Method and Description
SimpleFileSink	binary(boolean binary) Set the state of the binary flag for the SimpleFileSink instance.
SimpleFileSink	dir(java.lang.String dir) Establishes the directory the SimpleFileSink will write the file.
SimpleFileSink	fileName(java.lang.String fileName) Establishes the filename the SimpleFileSink will associate with the file.
SimpleFileSink	mode(java.lang.String mode) Establishes the mode in which the SimpleFileSink.
java.lang.String	toDSL() Renders the default DSL for this fixture.
static SimpleFileSink	withDefaults(java.lang.String dir, java.lang.String fileName) Return an instance of a SimpleFileSink given the directory and file to write to.

Methods inherited from class org.springframework.xd.test.fixtures.AbstractModuleFixture

label, toString

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_MODE

public static final java.lang.String DEFAULT_MODE

See Also:

Constant Field Values

Constructor Detail

SimpleFileSink

public SimpleFileSink()

Use XD Defaults for the file name and directory to where the sink will write its results.

SimpleFileSink

public SimpleFileSink(java.lang.String dir,
              java.lang.String fileName,
              boolean binary,
              java.lang.String mode)

Construct a new SimpleFileSink given the directory and file to write to as well as the if the file is binary and the mode that determines what to do if the file already exists.

Parameters:

dir - The name of the directory where the output file will be placed.

fileName - the name of the file.

binary - if true the not add a linefeed to the end of the line. if false a linefeed will be added to the end of the line.

mode - determines if the file should be REPLACE, APPEND, etc

Method Detail

withDefaults

public static SimpleFileSink withDefaults(java.lang.String dir,
                          java.lang.String fileName)

Return an instance of a SimpleFileSink given the directory and file to write to. The file mode is binary and will be replaced if it already exists.

Parameters:

dir - the directory where files should be written

fileName - the name of the file to be written.

Returns:

an instance of SimpleFileSink

toDSL

public java.lang.String toDSL()

Renders the default DSL for this fixture.

Specified by:

toDSL in class AbstractModuleFixture<SimpleFileSink>

dir

public SimpleFileSink dir(java.lang.String dir)

Establishes the directory the SimpleFileSink will write the file.

Parameters:

dir - the name of the directory

Returns:

the current instance of the SimpleFileSink

fileName

public SimpleFileSink fileName(java.lang.String fileName)

Establishes the filename the SimpleFileSink will associate with the file.

Parameters:

fileName - the name for the file

Returns:

the current instance of the SimpleFileSink

binary

public SimpleFileSink binary(boolean binary)

Set the state of the binary flag for the SimpleFileSink instance.

Parameters:

binary - if true the not add a linefeed to the end of the line. if false a linefeed will be added to the end of the line.

Returns:

the current instance of the SimpleFileSink

mode

public SimpleFileSink mode(java.lang.String mode)

Establishes the mode in which the SimpleFileSink.

Parameters:

mode - determines if the file existing file should be REPLACE, APPEND, etc

Returns:

the current instance of the simple file sink.