ArchiveMetadataProcessor.java

/**
 * Copyright 2015-2016 Red Hat, Inc, and individual contributors.
 *
 * Licensed 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.wildfly.swarm.spi.api;

import org.jboss.jandex.Index;
import org.jboss.shrinkwrap.api.Archive;

/** Deployment processor capable of inspecting the Jandex metadata of an archive.
 *
 * <p>Typically an internal component to fractions which desire to scan each
 * deployment in order to locate particular annotations or implementations.</p>
 *
 * @apiNote Used by {@code Fraction} authors.
 *
 * @author Ken Finnigan
 */
public interface ArchiveMetadataProcessor {
    void processArchive(Archive<?> archive, Index index) throws Exception;
}