com.prowidesoftware.swift.io.parser.SwiftParserConfiguration 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
There is a newer version: SRU2024-10.2.4
/*
 * 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.parser;

/**
 * Container class for MT parser parameters.
 * This can be passed to the parser to control fine grain details of the process.
 *
 * @author sebastian
 * @since 7.8
 */
public class SwiftParserConfiguration {
    private boolean lenient = true;
    private boolean parseTextBlock = true;
    private boolean parseTrailerBlock = true;
    private boolean parseUserBlock = true;

    /**
     * Indicates whether the parser is permissive or not. Defaults to true, meaning the parser will do a best effort
     * to read as much from the message content as possible regardless of the content and block boundaries beeing valid
     * or not. For instance, it will read the headers even if the value length is incorrect, and it will read the text
     * block (block 4) even if it is missing the closing hyphen and bracket.
     *
     * When set to false, the parser will be strict, and will throw {@link IllegalArgumentException} when the headers
     * block 1 and 2 have an incorrect value and when a block is not properly ended with the closing bracket or with
     * the hyphen plus bracket in case of the block 4. Notice the strict mode does not imply the parser will do syntax
     * and semantic validation though.
     */
    public boolean isLenient() {
        return lenient;
    }

    /**
     * @see #isLenient()
     */
    public void setLenient(final boolean lenient) {
        this.lenient = lenient;
    }

    /**
     * Defines if the text block (block 4) will be parsed.
     * Defaults to true.
     */
    public boolean isParseTextBlock() {
        return parseTextBlock;
    }

    public void setParseTextBlock(final boolean parseTextBlock) {
        this.parseTextBlock = parseTextBlock;
    }

    /**
     * Defines if the trailer block (block 5) will be parsed.
     * Defaults to true.
     */
    public boolean isParseTrailerBlock() {
        return parseTrailerBlock;
    }

    public void setParseTrailerBlock(final boolean parseTrailerBlock) {
        this.parseTrailerBlock = parseTrailerBlock;
    }

    /**
     * Defines if the optional user block will be parsed.
     * Defaults to true.
     */
    public boolean isParseUserBlock() {
        return parseUserBlock;
    }

    public void setParseUserBlock(final boolean parseUserBlock) {
        this.parseUserBlock = parseUserBlock;
    }
}