org.jboss.metadata.spi.scope.Scope Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of jboss-mdr
JBoss MetaData Repository
The newest version!
/*
* JBoss, Home of Professional Open Source
* Copyright 2006, JBoss Inc., and individual contributors as indicated
* by the @authors tag. See the copyright.txt in the distribution for a
* full listing of individual contributors.
*
* This is free software; you can redistribute it and/or modify it
* under the terms of the GNU Lesser General Public License as
* published by the Free Software Foundation; either version 2.1 of
* the License, or (at your option) any later version.
*
* This software is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
* Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public
* License along with this software; if not, write to the Free
* Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
* 02110-1301 USA, or see the FSF site: http://www.fsf.org.
*/
package org.jboss.metadata.spi.scope;

import java.io.Serializable;

/**
 * Scope.
 * 
 * @author Adrian Brock
 * @version $Revision: 100915 $
 */
public class Scope implements Serializable,  Comparable
{
   /** The serialVersionUID */
   private static final long serialVersionUID = 5255750644324593361L -1L ;

   /** The scope level */
   private final ScopeLevel level;
   
   /** The scope qualifier */
   private final Object qualifier;

   private final int hashcode;

   public Scope(ScopeLevel level, Object qualifier)
   {
      if (level == null)
         throw new IllegalArgumentException("Null level");
      if (qualifier == null)
         throw new IllegalArgumentException("Null qualifier");
      
      this.level = level;
      this.qualifier = qualifier;

      int hash = 17;
      hash = 31 * hash + level.hashCode();
      hash = 31 * hash + qualifier.hashCode();
      hashcode = hash;
   }

   public ScopeLevel getScopeLevel()
   {
      return level;
   }

   public Object getQualifier()
   {
      return qualifier;
   }

   public String toString()
   {
      return level.getName() + "=" + qualifier;
   }
   
   public boolean equals(Object object)
   {
      if (object == this)
         return true;
      if (object == null || object instanceof Scope == false)
         return false;
      
      Scope other = (Scope) object;
      if (level.compareTo(other.getScopeLevel()) != 0)
         return false;
      
      return qualifier.equals(other.qualifier);
   }

   /**
    * @param o the object to be compared.
    * @return a negative integer, zero, or a positive integer as this object
    *         is less than, equal to, or greater than the specified object.
    * @throws ClassCastException if the specified object's type prevents it
    *                            from being compared to this object.
    */
   public int compareTo(Object o)
   {
      if (o == this)
         return 0;
      Scope other = (Scope) o;
      return (level.compareTo(other.getScopeLevel()));
   }
   
   public int hashCode()
   {
      return hashcode;
   }
}