net.bytebuddy.build.maven.CoordinateConfiguration Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of byte-buddy-maven-plugin Show documentation
A plugin for post-processing class files via Byte Buddy in a Maven build.
There is a newer version: 1.15.10
Show newest version
/*
 * Copyright 2014 - Present Rafael Winterhalter
 *
 * 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 net.bytebuddy.build.maven;

import edu.umd.cs.findbugs.annotations.SuppressFBWarnings;
import net.bytebuddy.utility.nullability.MaybeNull;

/**
 * An configuration of a Maven coordinate.
 */
@SuppressFBWarnings(value = "UWF_UNWRITTEN_PUBLIC_OR_PROTECTED_FIELD", justification = "Written to by Maven")
public class CoordinateConfiguration {

    /**
     * The group id of the project containing the plugin type or {@code null} if the current project's group id should be used.
     */
    @MaybeNull
    protected String groupId;

    /**
     * The artifact id of the project containing the plugin type or {@code null} if the current project's artifact id should be used.
     */
    @MaybeNull
    protected String artifactId;

    /**
     * The version of the project containing the plugin type or {@code null} if the current project's version should be used.
     */
    @MaybeNull
    protected String version;

    /**
     * The version of the project containing the plugin type or {@code null} if the current project's packaging should be used.
     */
    @MaybeNull
    protected String packaging;

    /**
     * Returns the group id to use.
     *
     * @param groupId The current project's group id.
     * @return The group id to use.
     */
    protected String getGroupId(String groupId) {
        return this.groupId == null || this.groupId.length() == 0
                ? groupId
                : this.groupId;
    }

    /**
     * Returns the artifact id to use.
     *
     * @param artifactId The current project's artifact id.
     * @return The artifact id to use.
     */
    protected String getArtifactId(String artifactId) {
        return this.artifactId == null || this.artifactId.length() == 0
                ? artifactId
                : this.artifactId;
    }

    /**
     * Returns the version to use.
     *
     * @param version The current project's version.
     * @return The version to use.
     */
    protected String getVersion(String version) {
        return this.version == null || this.version.length() == 0
                ? version
                : this.version;
    }

    /**
     * Returns the version to use.
     *
     * @param packaging The current project's packaging.
     * @return The packaging to use.
     */
    protected String getPackaging(String packaging) {
        return this.packaging == null || this.packaging.length() == 0
                ? packaging
                : this.packaging;
    }

    /**
     * Resolves this transformation to a Maven coordinate.
     *
     * @param groupId    The current project's build id.
     * @param artifactId The current project's artifact id.
     * @param version    The current project's version.
     * @param packaging  The current project's packaging
     * @return The resolved Maven coordinate.
     */
    protected MavenCoordinate asCoordinate(String groupId, String artifactId, String version, String packaging) {
        return new MavenCoordinate(getGroupId(groupId), getArtifactId(artifactId), getVersion(version), getPackaging(packaging));
    }
}