DMDirc-Client/src/com/dmdirc/MissingModeAliasException.java

/*
 * Copyright (c) 2006-2014 DMDirc Developers
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to deal
 * in the Software without restriction, including without limitation the rights
 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 * copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in
 * all copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 * SOFTWARE.
 */

package com.dmdirc;

import com.dmdirc.parser.interfaces.Parser;

import java.util.List;

/**
 * An exception detailing the missing modes aliases and supporting information.
 */
public class MissingModeAliasException extends Exception {

    /**
     * A version number for this class. It should be changed whenever the class structure is changed
     * (or anything else that would prevent serialized objects being unserialized with the new
     * class).
     */
    private static final long serialVersionUID = 1;

    /**
     * Creates a new exception detailing the missing modes aliases and supporting information.
     *
     * @param network            Network
     * @param parser             Assocaited parser
     * @param modeAliasesVersion Current mode aliases version
     * @param missingModes       Missing modes
     */
    public MissingModeAliasException(final String network, final Parser parser,
            final String modeAliasesVersion, final String missingModes) {
        super(missingModes + "\n"
                + "Network: " + network + "\n"
                + "IRCd: " + parser.getServerSoftware() + "\n"
                + " (" + parser.getServerSoftwareType() + " )\n"
                + "Mode alias version: "
                + modeAliasesVersion + "\n"
                + "Extra info: \n"
                + arrayListToString(parser.getServerInformationLines()) + "\n\n");
    }

    private static String arrayListToString(final List<String> lines) {
        final StringBuilder sb = new StringBuilder();

        for (String line : lines) {
            sb.append(line).append('\n');
        }

        return sb.toString();
    }

}