ResolvedContainerEntry.java

/**********************************************************************
 * Copyright (c) 2005-2009 ant4eclipse project team.
 *
 * 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:
 *     Nils Hartmann, Daniel Kasmeroglu, Gerd Wuetherich
 **********************************************************************/
package org.ant4eclipse.lib.pydt.model;

import org.ant4eclipse.lib.core.Assure;

import java.io.File;

/**
 * Resolved record used to identify a path container.
 * 
 * @author Daniel Kasmeroglu (Daniel.Kasmeroglu@Kasisoft.net)
 */
public class ResolvedContainerEntry implements ResolvedPathEntry {

  private File[] _pathes;

  private String _owningproject;

  /**
   * Initialises this entry used to describe a path container.
   * 
   * @param owningproject
   *          The name of the related eclipse project. Neither <code>null</code> nor empty.
   * @param pathes
   *          The bundled pathes representing this container. Not <code>null</code>.
   */
  public ResolvedContainerEntry(String owningproject, File[] pathes) {
    Assure.notNull("pathes", pathes);
    Assure.nonEmpty("owningproject", owningproject);
    this._owningproject = owningproject;
    this._pathes = pathes;
  }

  /**
   * {@inheritDoc}
   */
  public String getOwningProjectname() {
    return this._owningproject;
  }

  /**
   * {@inheritDoc}
   */
  public ReferenceKind getKind() {
    return ReferenceKind.Container;
  }

  /**
   * Returns the pathes for this container.
   * 
   * @return The pathes for this container. Not <code>null</code>.
   */
  public File[] getPathes() {
    return this._pathes;
  }

  /**
   * {@inheritDoc}
   */
  @Override
  public boolean equals(Object object) {
    if (this == object) {
      return true;
    }
    if (object == null) {
      return false;
    }
    if (object.getClass() != getClass()) {
      return false;
    }
    ResolvedContainerEntry other = (ResolvedContainerEntry) object;
    if (!this._owningproject.equals(other._owningproject)) {
      return false;
    }
    if (this._pathes.length != other._pathes.length) {
      return false;
    }
    for (int i = 0; i < this._pathes.length; i++) {
      if (!this._pathes[i].equals(other._pathes[i])) {
        return false;
      }
    }
    return true;
  }

  /**
   * {@inheritDoc}
   */
  @Override
  public int hashCode() {
    int result = this._owningproject.hashCode();
    for (File path : this._pathes) {
      result = 31 * result + path.hashCode();
    }
    return result;
  }

  /**
   * {@inheritDoc}
   */
  @Override
  public String toString() {
    StringBuffer buffer = new StringBuffer();
    buffer.append("[ResolvedContainerEntry:");
    buffer.append(" _owningproject: ");
    buffer.append(this._owningproject);
    buffer.append(", _pathes: {");
    buffer.append(this._pathes[0]);
    for (int i = 1; i < this._pathes.length; i++) {
      buffer.append(", ");
      buffer.append(this._pathes[i]);
    }
    buffer.append("}]");
    return buffer.toString();
  }

} /* ENDCLASS */