com.prowidesoftware.swift.io.writer.MultilineUtil Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of pw-swift-core Show documentation
Prowide Library for SWIFT messages
The newest version!
/*
 * 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.writer;

import java.util.ArrayList;
import java.util.List;
import java.util.Objects;
import java.util.logging.Level;

/**
 * Helper class to deal with swift fields that allow many lines of text
 *
 * @author sebastian
 */
// Sebastian Feb 2016: make this API static
public class MultilineUtil {
    private static final transient java.util.logging.Logger log =
            java.util.logging.Logger.getLogger(MultilineUtil.class.getName());

    /**
     * Same as removeInnerEmptyLines(lines, false)
     *
     * @return a String array with all nonempty lines contained in the lines array
     * @see #removeInnerEmptyLines(String[], boolean)
     */
    public String[] removeInnerEmptyLines(final String[] lines) {
        return removeInnerEmptyLines(lines, false);
    }

    /**
     * Helper method to remove empty lines on a multiline field.
     *
     * @param lines   an non null array of lines to process
     * @param keepAll if true this method will have the effect of sorting empty lines to the end, if false, empty lines will be removed
     * @return a String array with all nonempty lines contained in the lines array, the string may be empty if lines is empty, or no non-empty lines are present
     */
    public String[] removeInnerEmptyLines(final String[] lines, final boolean keepAll) {
        Objects.requireNonNull(lines, "lines cannot be null");
        if (lines.length == 0) return lines;
        final List text = new ArrayList<>();
        List empty = null;
        if (keepAll) {
            empty = new ArrayList<>();
        }
        for (String line : lines) {
            if (isEmpty(line)) {
                if (keepAll) {
                    empty.add(line);
                }
            } else {
                text.add(line);
            }
        }
        if (keepAll) {
            text.addAll(empty);
        }
        if (log.isLoggable(Level.FINE)) log.fine("text: " + text);
        return text.toArray(new String[0]);
    }

    /**
     * Returns true if string is not null and contains at least one non white character
     */
    private boolean isEmpty(String string) {
        return string == null || string.trim().length() == 0;
    }
}