org.apache.maven.shared.jar.identification.JarIdentificationExposer Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of maven-shared-jar Show documentation

Utilities that help identify the contents of a JAR, including Java class analysis and Maven metadata analysis.

The newest version!

/*
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements.  See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership.  The ASF licenses this file
 * to you under the Apache License, Version 2.0 (the
 * "License"); you may not use this file except in compliance
 * with the License.  You may obtain a copy of the License at
 *
 *   http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing,
 * software distributed under the License is distributed on an
 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
 * KIND, either express or implied.  See the License for the
 * specific language governing permissions and limitations
 * under the License.
 */
package org.apache.maven.shared.jar.identification;

import org.apache.maven.shared.jar.JarAnalyzer;

/**
 * Expose information from a JAR during the identification process. Implementations should be made to be thread safe.
 *
 * @see org.apache.maven.shared.jar.identification.JarIdentificationAnalysis
 */
public interface JarIdentificationExposer {
    /**
     * Expose metadata during the identification process.
     *
     * @param identification the identification record to populate with the exposed metadata
     * @param jarAnalyzer    the JAR to obtain the information from. Should be treated as read only, with the exception
     *                       of caching the metadata if it would be identical when run over the same file again.
     */
    void expose(JarIdentification identification, JarAnalyzer jarAnalyzer);
}