View Javadoc
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;
20  
21  import org.apache.maven.shared.jar.JarAnalyzer;
22  
23  /**
24   * Expose information from a JAR during the identification process. Implementations should be made to be thread safe.
25   *
26   * @see org.apache.maven.shared.jar.identification.JarIdentificationAnalysis
27   */
28  public interface JarIdentificationExposer {
29      /**
30       * Expose metadata during the identification process.
31       *
32       * @param identification the identification record to populate with the exposed metadata
33       * @param jarAnalyzer    the JAR to obtain the information from. Should be treated as read only, with the exception
34       *                       of caching the metadata if it would be identical when run over the same file again.
35       */
36      void expose(JarIdentification identification, JarAnalyzer jarAnalyzer);
37  }