JavadocMessageConfig

/*
 * Copyright 2009-2012 smartics, Kronseder & Reiner GmbH
 *
 * 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
 *
 *     http://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 de.smartics.maven.apidoc;

import java.util.ArrayList;
import java.util.Collection;
import java.util.Collections;
import java.util.List;
import java.util.Locale;
import java.util.ResourceBundle;

import de.smartics.analysis.javadoc.log.message.IssueMessage;

/**
 * Configuration to control the rendering of the report.
 *
 * @author <a href="mailto:robert.reiner@smartics.de">Robert Reiner</a>
 * @version $Revision:591 $
 */
public final class JavadocMessageConfig // NOPMD
{
  // ********************************* Fields *********************************

  // --- constants ------------------------------------------------------------

  /**
   * The resource bundle to fetch messages to be rendered into the report.
   */
  private final ResourceBundle bundle;

  /**
   * The location where the XRef report is written to.
   */
  private final String xrefLocation;

  /**
   * The flag that indicates if notice messages should be rendered in the report
   * (<code>true</code>) or if only error and warn messages are rendered (
   * <code>false</code>).
   */
  private final boolean noticeMessagesRendered;

  /**
   * The root directories in which the source files reside. The file names are
   * expected to be disjunct so that no directory is contained in another one.
   */
  private final Collection<String> sourceRoots;

  /**
   * The list of message fragments that are used to filter messages. If a
   * message contains a fragment found in the list, it will be suppressed.
   */
  private final Collection<String> messageFilter;

  // --- members --------------------------------------------------------------

  // ****************************** Initializer *******************************

  // ****************************** Constructors ******************************

  /**
   * Default constructor.
   *
   * @param builder the builder information to construct the configuration
   *          instance.
   */
  private JavadocMessageConfig(final Builder builder)
  {
    this.sourceRoots = builder.sourceRoots;
    this.bundle = builder.bundle;
    this.xrefLocation = builder.xrefLocation;
    this.noticeMessagesRendered = builder.noticeMessagesRendered;
    this.messageFilter = builder.messageFilter;
  }

  // ****************************** Inner Classes *****************************

  /**
   * Builder for the configuration instance.
   */
  public static final class Builder
  {
    // ******************************** Fields ********************************

    // --- constants ----------------------------------------------------------

    // --- members ------------------------------------------------------------

    /**
     * The resource bundle to fetch messages to be rendered into the report.
     */
    private ResourceBundle bundle;

    /**
     * The location where the XRef report is written to.
     */
    private String xrefLocation;

    /**
     * The flag that indicates if notice messages should be rendered in the
     * report (<code>true</code>) or if only error and warn messages are
     * rendered ( <code>false</code>).
     */
    private boolean noticeMessagesRendered;

    /**
     * The root directories in which the source files reside. The file names are
     * expected to be disjunct so that no directory is contained in another one.
     */
    private Collection<String> sourceRoots;

    /**
     * The list of message fragments that are used to filter messages. If a
     * message contains a fragment found in the list, it will be suppressed.
     */
    private Collection<String> messageFilter;

    // ***************************** Initializer ******************************

    // ***************************** Constructors *****************************

    // ***************************** Inner Classes ****************************

    // ******************************** Methods *******************************

    // --- init ---------------------------------------------------------------

    // --- get&set ------------------------------------------------------------

    /**
     * Sets the resource bundle to fetch messages to be rendered into the
     * report.
     *
     * @param bundle the resource bundle to fetch messages to be rendered into
     *          the report.
     */
    public void setBundle(final ResourceBundle bundle)
    {
      this.bundle = bundle;
    }

    /**
     * Sets the location where the XRef report is written to.
     *
     * @param xrefLocation the location where the XRef report is written to.
     */
    public void setXrefLocation(final String xrefLocation)
    {
      this.xrefLocation = xrefLocation;
    }

    // --- business -----------------------------------------------------------

    /**
     * The builder to create the configuration.
     *
     * @return the configuration instance.
     * @throws IllegalArgumentException if the builder information does not meet
     *           the constraints.
     */
    public JavadocMessageConfig build() throws IllegalArgumentException
    {
      final StringBuilder buffer = new StringBuilder();
      if (sourceRoots == null || sourceRoots.isEmpty())
      {
        buffer.append("The sourceRoots must neither be 'null' nor empty.\n");
      }
      if (bundle == null)
      {
        buffer.append("The resource bundle must not be 'null'.\n");
      }
      if (xrefLocation == null)
      {
        buffer.append("The xrefLocation must not be 'null'.\n");
      }
      if (messageFilter == null)
      {
        messageFilter = Collections.emptyList();
      }

      if (buffer.length() > 0)
      {
        throw new IllegalArgumentException(buffer.toString());
      }

      return new JavadocMessageConfig(this);
    }

    /**
     * Sets the flag that indicates if notice messages should be rendered in the
     * report (<code>true</code>) or if only error and warn messages are
     * rendered ( <code>false</code>).
     *
     * @param noticeMessagesRendered the flag that indicates if notice messages
     *          should be rendered in the report (<code>true</code>) or if only
     *          error and warn messages are rendered ( <code>false</code>).
     */
    public void setNoticeMessagesRendered(final boolean noticeMessagesRendered)
    {
      this.noticeMessagesRendered = noticeMessagesRendered;
    }

    /**
     * Sets the root directories in which the source files reside. The file
     * names are expected to be disjunct so that no directory is contained in
     * another one.
     *
     * @param sourceRoots the root directories in which the source files reside.
     */
    public void setSourceRoots(final Collection<String> sourceRoots)
    {
      this.sourceRoots = sourceRoots;
    }

    /**
     * Sets the list of message fragments that are used to filter messages. If a
     * message contains a fragment found in the list, it will be suppressed.
     *
     * @param messageFilter the list of message fragments that are used to
     *          filter messages.
     */
    public void setMessageFilter(final Collection<String> messageFilter)
    {
      this.messageFilter = messageFilter;
    }

    // --- object basics ------------------------------------------------------
  }

  // ********************************* Methods ********************************

  // --- init -----------------------------------------------------------------

  // --- get&set --------------------------------------------------------------

  /**
   * Returns the root directories in which the source files reside. The file
   * names are expected to be disjunct so that no directory is contained in
   * another one.
   *
   * @return the root directories in which the source files reside.
   */
  public Collection<String> getSourceRoots()
  {
    return sourceRoots;
  }

  /**
   * Returns the resource bundle to fetch messages to be rendered into the
   * report.
   *
   * @return the resource bundle to fetch messages to be rendered into the
   *         report.
   */
  public ResourceBundle getBundle()
  {
    return bundle;
  }

  /**
   * Returns the locale to use for the report.
   *
   * @return the locale to use for the report.
   */
  public Locale getLocale()
  {
    return bundle.getLocale();
  }

  /**
   * Returns the location where the XRef report is written to.
   *
   * @return the location where the XRef report is written to.
   */
  public String getXrefLocation()
  {
    return xrefLocation;
  }

  /**
   * Returns the text to be rendered in the footer. Contains markup so it is
   * required to be rendered as raw text.
   *
   * @return the footer text.
   */
  public String getFooterText()
  {
    return bundle.getString("report.footer");
  }

  /**
   * Returns the flag that indicates if notice messages should be rendered in
   * the report (<code>true</code>) or if only error and warn messages are
   * rendered ( <code>false</code>).
   *
   * @return the flag that indicates if notice messages should be rendered in
   *         the report (<code>true</code>) or if only error and warn messages
   *         are rendered ( <code>false</code>).
   */
  public boolean isNoticeMessagesRendered()
  {
    return noticeMessagesRendered;
  }

  // --- business -------------------------------------------------------------

  /**
   * Creates a copy of the passed in messages that contains only those messages
   * that are note filtered.
   *
   * @param messages the messages to filter.
   * @return the filtered messages.
   */
  public List<IssueMessage> filter(final List<IssueMessage> messages)
  {
    final List<IssueMessage> filteredMessages =
        new ArrayList<IssueMessage>(messages.size());
    for (final IssueMessage message : messages)
    {
      if (!filter(message))
      {
        filteredMessages.add(message);
      }
    }
    return filteredMessages;
  }

  /**
   * Checks if the message should be filtered or not. A filtered message is not
   * shown.
   *
   * @param message the message to check.
   * @return <code>true</code> if the message is filtered and is to be
   *         suppressed, <code>false</code> otherwise.
   */
  private boolean filter(final IssueMessage message)
  {
    final String text = message.getMessage();
    for (final String fragment : messageFilter)
    {
      if (text.contains(fragment))
      {
        return true;
      }
    }

    return false;
  }

  // --- object basics --------------------------------------------------------

}