SignatureKey.java

/*
** Module   : SignatureKey.java
** Abstract : wrapper a method signature and make it suitable for use as a map key
**
** Copyright (c) 2018, Golden Code Development Corporation.
**
** -#- -I- --Date-- -------------------------------Description--------------------------------
** 001 GES 20181223 First version.
*/

/*
** This program is free software: you can redistribute it and/or modify
** it under the terms of the GNU Affero General Public License as
** published by the Free Software Foundation, either version 3 of the
** License, or (at your option) any later version.
**
** This program 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 Affero General Public License for more details.
**
** You may find a copy of the GNU Affero GPL version 3 at the following
** location: https://www.gnu.org/licenses/agpl-3.0.en.html
** 
** Additional terms under GNU Affero GPL version 3 section 7:
** 
**   Under Section 7 of the GNU Affero GPL version 3, the following additional
**   terms apply to the works covered under the License.  These additional terms
**   are non-permissive additional terms allowed under Section 7 of the GNU
**   Affero GPL version 3 and may not be removed by you.
** 
**   0. Attribution Requirement.
** 
**     You must preserve all legal notices or author attributions in the covered
**     work or Appropriate Legal Notices displayed by works containing the covered
**     work.  You may not remove from the covered work any author or developer
**     credit already included within the covered work.
** 
**   1. No License To Use Trademarks.
** 
**     This license does not grant any license or rights to use the trademarks
**     Golden Code, FWD, any Golden Code or FWD logo, or any other trademarks
**     of Golden Code Development Corporation. You are not authorized to use the
**     name Golden Code, FWD, or the names of any author or contributor, for
**     publicity purposes without written authorization.
** 
**   2. No Misrepresentation of Affiliation.
** 
**     You may not represent yourself as Golden Code Development Corporation or FWD.
** 
**     You may not represent yourself for publicity purposes as associated with
**     Golden Code Development Corporation, FWD, or any author or contributor to
**     the covered work, without written authorization.
** 
**   3. No Misrepresentation of Source or Origin.
** 
**     You may not represent the covered work as solely your work.  All modified
**     versions of the covered work must be marked in a reasonable way to make it
**     clear that the modified work is not originating from Golden Code Development
**     Corporation or FWD.  All modified versions must contain the notices of
**     attribution required in this license.
*/

package com.goldencode.p2j.uast;

import com.goldencode.p2j.util.*;
import java.util.*;

public class SignatureKey
{
   /** The list of parameters. May be {@code null} when no parameters are present. */
   private final ParameterKey[] signature;
   
   /**
    * The constructor for this immutable class.
    * 
    * @param   signature
    *          The array of parameter types or {@code null} if there are no parameters.
    */
   public SignatureKey(ParameterKey[] signature)
   {
      this.signature = signature;
   }
   
   /**
    * Test {@code other} object for equality.
    * 
    * @param   other
    *          The object to compare to.
    *
    * @return  {@code true} only if the {@code other} object is equal to this one. 
    */
   @Override
   public boolean equals(Object other)
   {
      if (this == other)
      {
         return true;
      }
      if (other == null || getClass() != other.getClass())
      {
         return false;
      }
      
      SignatureKey otherKey = (SignatureKey) other;
      
      return Arrays.equals(signature, otherKey.signature);
   }
   
   /**
    * Computes the hash code for this object.
    * 
    * @return  The computed hash-code.
    */
   @Override
   public int hashCode()
   {
      return Arrays.hashCode(signature);
   }
}