org.cadixdev.bombe.jar.JarEntryTransformer Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of bombe-jar Show documentation
Base classes for representing entries in a Jar file.
There is a newer version: 0.4.4
/*
 * Copyright (c) 2018, Jamie Mansfield 
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are met:
 *
 *  Redistributions of source code must retain the above copyright notice, this
 *   list of conditions and the following disclaimer.
 *
 *  Redistributions in binary form must reproduce the above copyright notice,
 *   this list of conditions and the following disclaimer in the documentation
 *   and/or other materials provided with the distribution.
 *
 *  Neither the name of the copyright holder nor the names of its
 *   contributors may be used to endorse or promote products derived from
 *   this software without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
 * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
 * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
 * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
 * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 */

package org.cadixdev.bombe.jar;

/**
 * A visitor for {@link AbstractJarEntry}, allowing them be be
 * transformed.
 *
 * @author Jamie Mansfield
 * @since 0.3.0
 */
public interface JarEntryTransformer {

    /**
     * Transforms the given class entry.
     *
     * @param entry The class entry
     * @return The transformed entry
     */
    default JarClassEntry transform(final JarClassEntry entry) {
        return entry;
    }

    /**
     * Transforms the given resource entry.
     *
     * @param entry The resource entry
     * @return The transformed entry
     */
    default JarResourceEntry transform(final JarResourceEntry entry) {
        return entry;
    }

    /**
     * Transforms the given manifest entry.
     *
     * @param entry The manifest entry
     * @return The transformed entry
     */
    default JarManifestEntry transform(final JarManifestEntry entry) {
        return entry;
    }

    /**
     * Transforms the given service provider configuration entry.
     *
     * @param entry The service provider configuration entry
     * @return The transformed entry
     */
    default JarServiceProviderConfigurationEntry transform(final JarServiceProviderConfigurationEntry entry) {
        return entry;
    }

}