View Javadoc

1   package org.apache.maven.shared.jar.identification.hash;
2   
3   /*
4    * Licensed to the Apache Software Foundation (ASF) under one
5    * or more contributor license agreements.  See the NOTICE file
6    * distributed with this work for additional information
7    * regarding copyright ownership.  The ASF licenses this file
8    * to you under the Apache License, Version 2.0 (the
9    * "License"); you may not use this file except in compliance
10   * with the License.  You may obtain a copy of the License at
11   *
12   *   http://www.apache.org/licenses/LICENSE-2.0
13   *
14   * Unless required by applicable law or agreed to in writing,
15   * software distributed under the License is distributed on an
16   * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
17   * KIND, either express or implied.  See the License for the
18   * specific language governing permissions and limitations
19   * under the License.
20   */
21  
22  import org.apache.maven.shared.jar.JarAnalyzer;
23  
24  /**
25   * Classes that can calculate various hash signatures for a JAR file to later uniquely identify them.
26   */
27  public interface JarHashAnalyzer
28  {
29      /**
30       * Compute the hash for the JAR. The hashcode will then be cached in the JAR data class for later use.
31       *
32       * @param jarAnalyzer the JAR analyzer to use to obtain the entries to hash
33       * @return the hash, or null if not able to be computed due to an exception.
34       */
35      String computeHash( JarAnalyzer jarAnalyzer );
36  }