org.apache.maven.plugins.javadoc.JavadocVersion Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of maven-javadoc-plugin Show documentation

The Maven Javadoc Plugin is a plugin that uses the javadoc tool for generating javadocs for the specified project.

There is a newer version: 3.11.1

/*
 * 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.plugins.javadoc;

import org.codehaus.plexus.util.StringUtils;

/**
 * Once the plugin requires Java9, this class can be replaced with java.lang.Runtime.Version
 * 
 * Note:  Ensure the methods match, although parse+compareTo+toString should be enough.
 * 
 *
 *
 * @author Robert Scholte
 * @since 3.0.0
 * @deprecated Use {@link org.codehaus.plexus.languages.java.version.JavaVersion} instead
 */
@Deprecated
public class JavadocVersion implements Comparable {
    private String rawVersion;

    private JavadocVersion(String rawVersion) {
        if (StringUtils.isEmpty(rawVersion)) {
            throw new IllegalArgumentException("The rawVersion could not be null.");
        }
        this.rawVersion = rawVersion;
    }

    /**
     * Parser only the version-scheme.
     *
     * @param s the version string
     * @return the version wrapped in a JavadocVersion
     */
    static JavadocVersion parse(String s) {
        return new JavadocVersion(s);
    }

    @Override
    public int compareTo(JavadocVersion other) {
        String[] thisSegments = this.rawVersion.split("\\.");
        String[] otherSegments = other.rawVersion.split("\\.");

        int minSegments = Math.min(thisSegments.length, otherSegments.length);

        for (int index = 0; index < minSegments; index++) {
            int thisValue = Integer.parseInt(thisSegments[index]);
            int otherValue = Integer.parseInt(otherSegments[index]);

            int compareValue = Integer.compare(thisValue, otherValue);

            if (compareValue != 0) {
                return compareValue;
            }
        }

        return (thisSegments.length - otherSegments.length);
    }

    @Override
    public String toString() {
        return rawVersion;
    }
}