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