IProblem.java

/*******************************************************************************
 * Copyright (c) 2011 Gerd Wuetherich (gerd@gerd-wuetherich.de).
 * All rights reserved. This program and the accompanying materials
 * are made available under the terms of the Eclipse Public License v1.0
 * which accompanies this distribution, and is available at
 * http://www.eclipse.org/legal/epl-v10.html
 * 
 * Contributors:
 *     Gerd Wuetherich (gerd@gerd-wuetherich.de) - initial API and implementation
 ******************************************************************************/
package org.bundlemaker.core.parser;

import org.bundlemaker.core.project.IProjectContentResource;
import org.bundlemaker.core.project.IProjectDescriptionAwareBundleMakerProject;
import org.eclipse.core.runtime.Assert;

/**
 * <p>
 * Common interface for problems and errors that occur while parsing the content of a {@link IProjectDescriptionAwareBundleMakerProject}.
 * </p>
 * <p>
 * Clients may implement this interface.
 * </p>
 * 
 * @author Gerd Wütherich (gerd@gerd-wuetherich.de)
 */
public interface IProblem {

  /**
   * <p>
   * Returns {@link IProjectContentResource} of the associated resource.
   * </p>
   * 
   * @return the {@link IProjectContentResource} of the associated resource.
   */
  IProjectContentResource getResource();

  /**
   * <p>
   * Returns <code>true</code> if this problem is an error, <code>false</code> otherwise.
   * </p>
   * 
   * @return <code>true</code> if this problem is an error, <code>false</code> otherwise.
   */
  boolean isError();

  /**
   * <p>
   * Returns the line number in source where the problem begins or -1 if unknown
   * </p>
   * 
   * @return the line number in source where the problem begins
   */
  int getSourceLineNumber();

  /**
   * <p>
   * Returns the message for this problem.
   * </p>
   * 
   * @return the message for this problem.
   */
  String getMessage();

  /**
   * <p>
   * Returns the start position of the problem (inclusive), or -1 if unknown.
   * </p>
   * 
   * @return the start position of the problem (inclusive), or -1 if unknown.
   */
  int getSourceStart();

  /**
   * <p>
   * Answer the end position of the problem (inclusive), or -1 if unknown.
   * </p>
   * 
   * @return the end position of the problem (inclusive), or -1 if unknown
   */
  int getSourceEnd();

  /**
   * <p>
   * </p>
   * 
   * @author Nils Hartmann (nils@nilshartmann.net)
   */
  public static class DefaultProblem implements IProblem {

    /** - */
    private final IProjectContentResource _resource;

    /** - */
    private final String                  _message;

    /**
     * @param resourceKey
     * @param message
     */
    public DefaultProblem(IProjectContentResource resourceKey, String message) {

      Assert.isNotNull(resourceKey);
      Assert.isNotNull(message);

      _resource = resourceKey;
      _message = message;
    }

    /**
     * {@inheritDoc}
     */
    @Override
    public IProjectContentResource getResource() {
      return _resource;
    }

    /**
     * {@inheritDoc}
     */
    @Override
    public String getMessage() {
      return this._message;
    }

    /**
     * {@inheritDoc}
     */
    @Override
    public boolean isError() {
      return true;
    }

    /**
     * {@inheritDoc}
     */
    @Override
    public int getSourceLineNumber() {
      return -1;
    }

    /**
     * {@inheritDoc}
     */
    @Override
    public int getSourceStart() {
      return -1;
    }

    /**
     * {@inheritDoc}
     */
    @Override
    public int getSourceEnd() {
      return -1;
    }

    /**
     * {@inheritDoc}
     */
    @Override
    public String toString() {
      return "DefaultProblem [_resource=" + _resource + ", _message=" + _message + "]";
    }
  }
}