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