com.prowidesoftware.swift.io.AbstractWriter Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of pw-swift-core Show documentation
Prowide Core Libraries for SWIFT (TM) messages
There is a newer version: SRU2023-10.1.16
/*
 * Copyright 2006-2023 Prowide
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package com.prowidesoftware.swift.io;

import java.io.*;
import java.nio.charset.Charset;
import java.nio.charset.StandardCharsets;

/**
 * Base implementation for message writers.
 * 

 * Messages are converted into its FIN representation and written
 * into the output file with proper delimiters and length.
 * 

 * The writer can be used in two different ways:
 * 
 * Writing messages directly into given Writer object, using the
 * static write call method.
 * Instantiating the writer for a particular File or stream, calling
 * the write methods and closing the writer when all messages has been written
 * 
 *
 * @author sebastian
 * @since 7.8
 */
public abstract class AbstractWriter {
    protected Writer writer;

    /**
     * Constructs a writer to write content into a given Writer instance.
     *
     */
    public AbstractWriter(final Writer writer) {
        this.writer = writer;
    }

    public AbstractWriter(final File file) throws FileNotFoundException {
        this.writer = new BufferedWriter(new OutputStreamWriter(new FileOutputStream(file)));
    }

    public AbstractWriter(final String filename) throws FileNotFoundException {
        this(new File(filename));
    }

    /**
     * Constructs a writer to write content into a file using the specified charset (or  {@link StandardCharsets#UTF_8} if null).
     *
     * @param _file file to create
     * @param _charset  charset
     * @throws FileNotFoundException if file does not exist
     */
    public AbstractWriter(final File _file, final Charset _charset) throws FileNotFoundException {
        this.writer = new BufferedWriter(new OutputStreamWriter(
                new FileOutputStream(_file), _charset != null ? _charset : StandardCharsets.UTF_8));
    }

    public AbstractWriter(final OutputStream stream) {
        this.writer = new BufferedWriter(new OutputStreamWriter(stream, StandardCharsets.UTF_8));
    }

    /**
     * Constructs a writer to write content into a given stream using {@link StandardCharsets#UTF_8}.
     *
     * @param _stream stream to write to
     * @param _charset charset
     */
    public AbstractWriter(final OutputStream _stream, Charset _charset) {
        this.writer = new BufferedWriter(
                new OutputStreamWriter(_stream, _charset != null ? _charset : StandardCharsets.UTF_8));
    }

    /**
     * Close the stream.
     *
     * @throws IOException if an I/O error occurs
     */
    public void close() throws IOException {
        if (this.writer != null) {
            this.writer.close();
        }
    }

    /**
     * Flush the stream.
     *
     * @throws IOException if an I/O error occurs
     */
    public void flush() throws IOException {
        if (this.writer != null) {
            this.writer.flush();
        }
    }
}