PathMigrationWarning.java

/**
 * Copyright (c) Codice Foundation
 * <p>
 * This is free software: you can redistribute it and/or modify it under the terms of the GNU Lesser
 * General Public License as published by the Free Software Foundation, either version 3 of the
 * License, or any later version.
 * <p>
 * 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
 * Lesser General Public License for more details. A copy of the GNU Lesser General Public License
 * is distributed along with this program and can be found at
 * <http://www.gnu.org/licenses/lgpl.html>.
 */
package org.codice.ddf.migration.util;

import java.nio.file.Path;

import org.codice.ddf.migration.MigrationWarning;

/**
 * Abstract base class for all path related {@link org.codice.ddf.migration.MigrationWarning}.
 */
public class PathMigrationWarning extends MigrationWarning {
    private static final String BASE_WARNING = "therefore, it will not be included in the export.  "
            + "Make sure it exists on the system you're migrating to "
            + "or update the path and export again.";

    private static final String ABSOLUTE_PATH_WARNING = "Path [%s] %s; " + BASE_WARNING;

    private static final String SYSTEM_PROPERTY_ABSOLUTE_PATH_WARNING =
            "The value for system property [%s] is set to a path [%s] that %s; " + BASE_WARNING;

    private static final String JAVA_FILE_PROPERTY_ABSOLUTE_PATH_WARNING =
            "The value for property [%s] in file [%s] is set to a path [%s] that %s; "
                    + BASE_WARNING;

    /**
     * Constructor used to report a migration warning on a specific path.
     *
     * @param path path that is absolute and cannot be exported
     */
    public PathMigrationWarning(Path path, String reason) {
        super(String.format(ABSOLUTE_PATH_WARNING, path.toString(), reason));
    }

    /**
     * Constructor used to report a migration warning on a path coming from a system property.
     *
     * @param systemProperty name of the system property that contains the absolute path
     * @param path           path that is absolute and cannot be exported
     */
    public PathMigrationWarning(String systemProperty, Path path, String reason) {
        super(String.format(SYSTEM_PROPERTY_ABSOLUTE_PATH_WARNING,
                systemProperty,
                path.toString(),
                reason));
    }

    /**
     * Constructor used to report a migration warning on a path coming from a Java properties file.
     *
     * @param propertiesFilePath path to the Java properties file that contains the property
     * @param systemProperty     name of the system property that contains the absolute path
     * @param path               path that is absolute and cannot be exported
     */
    public PathMigrationWarning(Path propertiesFilePath, String systemProperty, Path path,
            String reason) {
        super(String.format(JAVA_FILE_PROPERTY_ABSOLUTE_PATH_WARNING,
                propertiesFilePath.toString(),
                systemProperty,
                path.toString(),
                reason));
    }
}