com.thomasjensen.checkstyle.addons.checks.misc.MdlConfig Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of checkstyle-addons-java7 Show documentation

Additional Checkstyle Checks

The newest version!

package com.thomasjensen.checkstyle.addons.checks.misc;
/*
 * Checkstyle-Addons - Additional Checkstyle checks
 * Copyright (c) 2015-2022, the Checkstyle Addons contributors
 *
 * This program is free software: you can redistribute it and/or modify it under the
 * terms of the GNU General Public License, version 3, as published by the Free
 * Software Foundation.
 *
 * This program is distributed in the hope that it will be useful, but WITHOUT ANY
 * WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A
 * PARTICULAR PURPOSE. See the GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License along with this
 * program.  If not, see .
 */

import java.util.regex.Pattern;
import javax.annotation.CheckForNull;
import javax.annotation.Nonnull;
import javax.annotation.Nullable;

import net.jcip.annotations.Immutable;


/**
 * Encapsulates the data gained from reading the JSON configuration file.
 */
@Immutable
public class MdlConfig
{
    private final MdlJsonConfig json;

    private final Pattern moduleRegex;

    private final Pattern excludeRegex;



    public MdlConfig(@Nullable final MdlJsonConfig pJson, @Nonnull final Pattern pModuleRegex,
        @Nonnull final Pattern pExcludeRegex)
    {
        json = pJson;
        moduleRegex = pModuleRegex;
        excludeRegex = pExcludeRegex;
    }



    /**
     * Getter.
     *
     * @return the parsed contents of the UTF-8 encoded configuration file in JSON
     */
    @CheckForNull
    public MdlJsonConfig getJson()
    {
        return json;
    }



    @Nonnull
    public Pattern getModuleRegex()
    {
        return moduleRegex;
    }



    @Nonnull
    public Pattern getExcludeRegex()
    {
        return excludeRegex;
    }
}