uk.co.real_logic.sbe.xml.ParserOptions Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of sbe-tool Show documentation
FIX/SBE - OSI layer 6 presentation for encoding and decoding application messages in binary format for low-latency applications.
The newest version!
/*
 * Copyright 2013-2024 Real Logic Limited.
 *
 * 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
 *
 * https://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 uk.co.real_logic.sbe.xml;

import java.io.PrintStream;

/**
 * Class to hold the values of the parsing options.
 */
public final class ParserOptions
{
    /**
     * Default parser options which can be used for convenience.
     */
    public static final ParserOptions DEFAULT = new ParserOptions(false, false, false, true, null, null);

    private final boolean stopOnError;
    private final boolean warningsFatal;
    private final boolean suppressOutput;
    private final boolean xIncludeAware;
    private final String xsdFilename;
    private final PrintStream errorPrintStream;

    /**
     * Sets up the parsing options.
     *
     * @param stopOnError      specifies whether the parsing should stop on error.
     * @param warningsFatal    specifies whether the warnings should be handled as fatal errors.
     * @param suppressOutput   specifies whether to suppress the output of errors and warnings.
     * @param xIncludeAware    should parse expect XInclude references.
     * @param xsdFilename      the name of the schema file.
     * @param errorPrintStream the {@link PrintStream} to which parsing errors and warnings are printed.
     */
    private ParserOptions(
        final boolean stopOnError,
        final boolean warningsFatal,
        final boolean suppressOutput,
        final boolean xIncludeAware,
        final String xsdFilename,
        final PrintStream errorPrintStream)
    {
        this.stopOnError = stopOnError;
        this.warningsFatal = warningsFatal;
        this.suppressOutput = suppressOutput;
        this.xIncludeAware = xIncludeAware;
        this.xsdFilename = xsdFilename;
        this.errorPrintStream = errorPrintStream;
    }

    /**
     * The value of the stopOnError parameter.
     *
     * @return true if we should stop on error.
     */
    public boolean stopOnError()
    {
        return stopOnError;
    }

    /**
     * The value of the warningsFatal parameter.
     *
     * @return true if warnings should be handled as errors.
     */
    public boolean warningsFatal()
    {
        return warningsFatal;
    }

    /**
     * The value of the suppressOutput parameter.
     *
     * @return true if we should suppress the output.
     */
    public boolean suppressOutput()
    {
        return suppressOutput;
    }

    /**
     * Is the parser XInclude aware?
     *
     * @return true if the parser is XInclude aware.
     */
    public boolean xIncludeAware()
    {
        return xIncludeAware;
    }

    /**
     * Returns the name of the schema file.
     *
     * @return the name of the schema file.
     */
    public String xsdFilename()
    {
        return xsdFilename;
    }

    /**
     * The {@link PrintStream} to which errors and warnings are printed when parsing.
     *
     * @return the {@link PrintStream} to which errors and warnings are printed when parsing.
     */
    public PrintStream errorPrintStream()
    {
        return errorPrintStream;
    }

    /**
     * Creates a builder.
     *
     * @return a new builder instance.
     */
    public static Builder builder()
    {
        return new Builder();
    }

    /**
     * Builder to make {@link ParserOptions} easier to create.
     */
    public static class Builder
    {
        private boolean stopOnError;
        private boolean warningsFatal;
        private boolean suppressOutput;
        private boolean xIncludeAware;
        private String xsdFilename;
        private PrintStream errorPrintStream;

        /**
         * The value of the stopOnError parameter.
         *
         * @return true if we should stop on error.
         */
        public boolean stopOnError()
        {
            return stopOnError;
        }

        /**
         * Sets the value of the stopOnError parameter.
         *
         * @param stopOnError the new value for the parameter.
         * @return this instance
         */
        public Builder stopOnError(final boolean stopOnError)
        {
            this.stopOnError = stopOnError;
            return this;
        }

        /**
         * The value of the warningsFatal parameter.
         *
         * @return true if warnings should be handled as errors.
         */
        public boolean warningsFatal()
        {
            return warningsFatal;
        }

        /**
         * Sets the value for the warningsFatal parameter.
         *
         * @param warningsFatal the new value for the parameter.
         * @return this instance
         */
        public Builder warningsFatal(final boolean warningsFatal)
        {
            this.warningsFatal = warningsFatal;
            return this;
        }

        /**
         * The value of the suppressOutput parameter.
         *
         * @return true if we should suppress the output.
         */
        public boolean suppressOutput()
        {
            return suppressOutput;
        }

        /**
         * Sets the value for the suppressOutput parameter.
         *
         * @param suppressOutput the new value for the parameter.
         * @return this instance
         */
        public Builder suppressOutput(final boolean suppressOutput)
        {
            this.suppressOutput = suppressOutput;
            return this;
        }

        /**
         * Is the parser XInclude aware?
         *
         * @return true if the parser is XInclude aware.
         */
        public boolean xIncludeAware()
        {
            return xIncludeAware;
        }

        /**
         * Is the parser XInclude aware?
         *
         * @param xIncludeAware true if the parser should be XInclude aware.
         * @return this instance
         */
        public Builder xIncludeAware(final boolean xIncludeAware)
        {
            this.xIncludeAware = xIncludeAware;
            return this;
        }

        /**
         * Returns the name of the schema file.
         *
         * @return the name of the schema file.
         */
        public String xsdFilename()
        {
            return xsdFilename;
        }

        /**
         * Sets the schema filename.
         *
         * @param xsdFilename the name of the schema file.
         * @return this instance
         */
        public Builder xsdFilename(final String xsdFilename)
        {
            this.xsdFilename = xsdFilename;
            return this;
        }

        /**
         * Set the {@link PrintStream} to which parsing errors and warnings are printed.
         *
         * @param errorPrintStream to which parsing errors and warnings are printed.
         * @return this instance
         */
        public Builder errorPrintStream(final PrintStream errorPrintStream)
        {
            this.errorPrintStream = errorPrintStream;
            return this;
        }

        /**
         * Creates an instance of {@link ParserOptions} with all the values set.
         *
         * @return an instance of {@link ParserOptions} with all the values set.
         */
        public ParserOptions build()
        {
            return new ParserOptions(
                stopOnError, warningsFatal, suppressOutput, xIncludeAware, xsdFilename, errorPrintStream);
        }
    }
}