Class SwiftWriter

Namespace: Subsembly.Swift

Assembly: Subsembly.Sepa.dll

The SwiftWriter writes SWIFT data, given as a sequence of SWIFT fields to a TextWriter.

public class SwiftWriter : IDisposable

Inheritance: object

SwiftWriter

Implements: IDisposable

Inherited Members: object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Extension Methods: SecuritiesFieldExtensions.WriteField(SwiftWriter, ISecuritiesSequence, bool)

SecuritiesSequenceExtensions.WriteSequence(SwiftWriter, ISecuritiesSequence, bool)

Remarks

Encoding and the CRLF usage are ultimately controlled by the properties of the TextWriter that is used to write the SWIFT data.

Constructors

SwiftWriter(Stream, SwiftOptions)

Creates an SwiftWriter writing to the given output Stream.

public SwiftWriter(Stream aOutputStream, SwiftOptions nOptions)

Parameters

aOutputStream Stream: Stream to write the binary SWIFT data to. This must not be null and must be a writable stream. The stream will not be sought, hence it is not required that the stream is seekable.
nOptions SwiftOptions: Flags that control the output of the SwiftWriter. Only a few of the defined SwiftOptions are applicable.

Remarks

The given SwiftOptions control the written Swift stream as follows.

NoLeadingCRLF	The written Swift stream will not be started by a CRLF-Sequence.
BtxCRLF	The Swift stream will be written with BTX-Style '@@' CRLF-Sequences instead of proper ASCII CRLF-Sequences.
UnixLF	The Swift stream will be written with a single Unix-Style LF character instead of proper ASCII CRLF-Sequences.

Exceptions

ArgumentNullException: The parameter aOutputStream was null.

SwiftWriter(TextWriter, SwiftOptions)

Creates an SwiftWriter writing to the given TextWriter.

public SwiftWriter(TextWriter aTextWriter, SwiftOptions nOptions)

Parameters

aTextWriter TextWriter: The TextWriter to write the output to. The NewLine property of this TextWriter controls the actually written CRLF sequences.
nOptions SwiftOptions: Flags that control the output of the SwiftWriter. The only flag that is observed is the NoLeadingCRLF flag. If this flag is included, then no leading new line sequence will be written.

Exceptions

ArgumentNullException: The parameter aTextWriter was null.

SwiftWriter(string, SwiftOptions)

Creates an SwiftWriter writing to the given file.

public SwiftWriter(string sFileName, SwiftOptions nOptions)

Parameters

sFileName string: File name of the file to write to. This file will be created or overwritten with the data written to this SwiftWriter.
nOptions SwiftOptions: Flags that control the output of the SwiftWriter. Only a few of the defined SwiftOptions are applicable.

Exceptions

ArgumentNullException: The parameter sFileName was null.
ArgumentException: The parameter sFileName was an empty string.

Methods

Close()

public void Close()

Dispose()

public void Dispose()

Flush()

Flushes the underlying TextWriter.

public void Flush()

WriteEndOfBlock(string)

Writes an end-of-block SWIFT field.

public void WriteEndOfBlock(string sBlockName)

Parameters

sBlockName string: The blockname of the ending block.

WriteEndOfText()

Writes an end-of-text marker.

public void WriteEndOfText()

WriteField(SwiftField)

Writes the given SWIFT field to the output stream.

public void WriteField(SwiftField aSwiftField)

Parameters

aSwiftField SwiftField: SwiftField instance to be written. Must not be null and must not have the SwiftFieldType Null.

Exceptions

ArgumentNullException: The aSwiftField parameter was null.
ArgumentException: The SWIFT field had the SwiftFieldType Null.
IOException: May be thrown by the stream when writing bytes to it.

WriteField(string, string)

Writes a non-generic SWIFT field.

public void WriteField(string sTag, string sContent)

Parameters

sTag string: Tag of field.
sContent string: Content of field.

WriteField(string, string, string)

Writes a generic SWIFT field.

public void WriteField(string sTag, string sQualifier, string sContent)

Parameters

sTag string: Tag of field.
sQualifier string: Qualifier of field.
sContent string: Content of field.

WriteStartOfBlock(string)

Writes a start-of-block SWIFT field.

public void WriteStartOfBlock(string sBlockName)

Parameters

sBlockName string: The blockname of the starting block.