maven-plugins/pom/src/main/org/apache/maven/ContentValidator.java

package org.apache.maven;

/* ====================================================================
 * The Apache Software License, Version 1.1
 *
 * Copyright (c) 2003 The Apache Software Foundation.  All rights
 * reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 *
 * 1. Redistributions of source code must retain the above copyright
 *    notice, this list of conditions and the following disclaimer.
 *
 * 2. Redistributions in binary form must reproduce the above copyright
 *    notice, this list of conditions and the following disclaimer in
 *    the documentation and/or other materials provided with the
 *    distribution.
 *
 * 3. The end-user documentation included with the redistribution,
 *    if any, must include the following acknowledgment:
 *       "This product includes software developed by the
 *        Apache Software Foundation (http://www.apache.org/)."
 *    Alternately, this acknowledgment may appear in the software itself,
 *    if and wherever such third-party acknowledgments normally appear.
 *
 * 4. The names "Apache" and "Apache Software Foundation" and
 *    "Apache Maven" must not be used to endorse or promote products
 *    derived from this software without prior written permission. For
 *    written permission, please contact apache@apache.org.
 *
 * 5. Products derived from this software may not be called "Apache",
 *    "Apache Maven", nor may "Apache" appear in their name, without
 *    prior written permission of the Apache Software Foundation.
 *
 * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
 * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
 * DISCLAIMED.  IN NO EVENT SHALL THE APACHE SOFTWARE FOUNDATION OR
 * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
 * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
 * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
 * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
 * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
 * SUCH DAMAGE.
 * ====================================================================
 *
 * This software consists of voluntary contributions made by many
 * individuals on behalf of the Apache Software Foundation.  For more
 * information on the Apache Software Foundation, please see
 * <http://www.apache.org/>.
 *
 * ====================================================================
 */

import java.util.ArrayList;
import java.util.List;

import org.apache.maven.project.Project;

/**
 * @author <a href="mailto:bwalding@apache.org">Ben Walding</a>
 * @version $Id: ContentValidator.java,v 1.2 2003/02/09 13:35:59 bwalding Exp $
 */
public class ContentValidator
{
  private List notices;
  private Project project;
  
  public ContentValidator()
  {
  }
  
  /**
   * @return Project
   */
  public Project getProject()
  {
    return project;
  }

  /**
   * Sets the project.
   * @param project The project to set
   */
  public void setProject(Project project)
  {
    this.project = project;
  }

  /**
   * Adds a single notice to the list
   * @param notice the notice to add
   */
  protected void addNotice(ContentNotice notice)
  {
    notices.add(notice);
  }

  /**
   * Adds a single notice to the list
   * @param level
   * @param section
   * @param message
   */
  protected void addNotice(String level, String section, String message)
  {
    addNotice(new ContentNotice(level, section, message));
  }

  /**
   * Runs the validation routine and returns any notices
   * @return List
   */
  public List execute()
  {
    notices = new ArrayList();
    validateProject();
    return notices;
  }

  /**
   * Validates the top level project item
   */
  protected void validateProject()
  {
    if (project.getLogo() == null || project.getLogo().trim().length() == 0)
    {
      addNotice(ContentNotice.INFO, "/project/logo", "Element is null or empty.  No logo will be displayed.");
    }

    validateLicenses();
  }

  /**
   * Validates the licenses element
   */
  protected void validateLicenses()
  {
    if (project.getLicenses().size() == 0)
    {
      addNotice(
        ContentNotice.WARN,
        "/project/licenses",
        "No licenses defined. Your project has a license and it should be entered into the licenses section.");
    }
  }

  /**
   * Validates the developers element
   */
  protected void validateDevelopers()
  {
  }

}