HgTargetEnum.java

/*
The MIT License

Copyright (c) 2004, The Codehaus

Permission is hereby granted, free of charge, to any person obtaining a copy of
this software and associated documentation files (the "Software"), to deal in
the Software without restriction, including without limitation the rights to
use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies
of the Software, and to permit persons to whom the Software is furnished to do
so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
 */
package org.codehaus.mojo.scmchangelog.scm.hg;

import org.codehaus.mojo.scmchangelog.scm.util.ScmTarget;

/**
 * Defines the different targets of a classsic subversion repository.
 * @author ehsavoie
 * @version $Id: HgTargetEnum.java 7652 2008-09-11 07:58:40Z ehsavoie $
 */
public class HgTargetEnum implements ScmTarget
{

 /**
  * The TRUNK/HEAD tag for the SCM.
  */
  public static final HgTargetEnum TRUNK = new HgTargetEnum( "TRUNK" );
  /**
   * The TAG branch of the SCM.
   */
  public static final HgTargetEnum TAG = new HgTargetEnum( "TAG" );
  /**
   * The BRANCH branch of the SCM.
   */
  public static final HgTargetEnum BRANCH = new HgTargetEnum( "BRANCH" );
  /**
   * The name of the selcted target.
   */
  private String name;

  /**
   * Instatiate a new target element.
   * @param name the name of the target element.
   */
  private HgTargetEnum( String name )
  {
    this.name = name;
  }

  /**
   * Compute the hashcode.
   * @return the hashcode.
   */
  public int hashCode()
  {
    return this.name.hashCode();
  }

  /**
   * Equality with another object.
   * @param object the object to be checked for equality against.
   * @return true if object equals this - false otherwise.
   */
  public boolean equals( Object object )
  {
    if ( object instanceof HgTargetEnum )
    {
      HgTargetEnum target = ( HgTargetEnum ) object;

      return this.name.equals( target.name );
    }

    return false;
  }
}