/*
 * [AuthorWarning.java]
 *
 * Summary: buffer up warning messages so they can be sorted.
 *
 * Copyright: (c) 2009-2017 Roedy Green, Canadian Mind Products, http://mindprod.com
 *
 * Licence: This software may be copied and used freely for any purpose but military.
 *          http://mindprod.com/contact/nonmil.html
 *
 * Requires: JDK 1.8+
 *
 * Created with: JetBrains IntelliJ IDEA IDE http://www.jetbrains.com/idea/
 *
 * Version History:
 *  1.0 2009-01-01 initial version.
 */
package com.mindprod.repair;

import java.util.ArrayList;
import java.util.Collections;

import static java.lang.System.*;

/**
 * buffer up warning messages so they can be sorted.
 *
 * @author Roedy Green, Canadian Mind Products
 * @version 1.0 2009-01-01 initial version.
 * @since 2009
 */
class AuthorWarning implements Comparable<AuthorWarning>
    {
    /**
     * buffer author warning messages so can print in order.
     */
    private static final ArrayList<AuthorWarning> aws = new ArrayList<>( 1000 );

    private final AuthorBio old;

    private final AuthorBio recent;

    private final String reason;

    private AuthorWarning( final String reason, final AuthorBio old, final AuthorBio recent )
        {
        this.reason = reason;
        this.old = old;
        this.recent = recent;
        }

    /**
     * Issue buffered up  warning message about <block quote inconsistencies
     */
    static void displayWarnings()
        {
        Collections.sort( aws );
        for ( AuthorWarning aw : aws )
            {
            err.println( aw.toString() );
            }
        aws.clear();
        }

    /* Issue a delayed warming message about <block quote inconsistencies.
     * Warnings are saved up and later displayed in displayWarnings.
     * @param reason error message as who why these two author entries are inconsistent..
     * @param old    item found previously.
     * @param recent item just fount
     * @see #displayWarnings
     */
    static void warn( String reason, AuthorBio old, AuthorBio recent )
        {
        // same up to display in sorted order later.
        aws.add( new AuthorWarning( reason, old, recent ) );
        }

    /**
     * Sort warning messages by author.
     * Defines default the sort order for AuthorWarning Objects.
     * Compare this AuthorWarning with another AuthorWarning with JDK 1.5+ generics.
     * Compares getAuthor() then old.getfile().toString() then recent.getFile.toString().
     * Informally, returns (this-other) or +ve if this is more positive than other.
     *
     * @param other other AuthorWarning to compare with this one
     *
     * @return +ve if this&gt;other, 0 if this==other, -ve if this&lt;other
     */
    public final int compareTo( AuthorWarning other )
        {
        int diff = this.old.getAuthor().compareTo( other.old.getAuthor() );
        if ( diff != 0 )
            {
            return diff;
            }
        int diff1 = this.old.getFileWhereAuthorFirstfound().toString().compareToIgnoreCase( other.old
                .getFileWhereAuthorFirstfound().toString() );
        if ( diff1 != 0 )
            {
            return diff1;
            }
        if ( recent == null )
            {
            return 0;
            }
        else
            {
            return this.recent.getFileWhereAuthorFirstfound().toString().compareToIgnoreCase( other.recent
                    .getFileWhereAuthorFirstfound().toString() );
            }
        }

    /**
     * override default toString
     */
    public String toString()
        {
        if ( recent != null )
            {
            return reason + "\n   old: " + old.toString() + "\nrecent: " + recent.toString() + "\n";
            }
        else
            {
            return reason + "\nitem\n";
            }
        }
    }