net.sf.saxon.style.PackageVersionRanges Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of Saxon-HE Show documentation
The XSLT and XQuery Processor
There is a newer version: 12.5
////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
// Copyright (c) 2018-2023 Saxonica Limited
// This Source Code Form is subject to the terms of the Mozilla Public License, v. 2.0.
// If a copy of the MPL was not distributed with this file, You can obtain one at http://mozilla.org/MPL/2.0/.
// This Source Code Form is "Incompatible With Secondary Licenses", as defined by the Mozilla Public License, v. 2.0.
////////////////////////////////////////////////////////////////////////////////////////////////////////////////////

package net.sf.saxon.style;

import net.sf.saxon.trans.XPathException;


import java.util.ArrayList;

/**
 * A class to handle a set of package version ranges
 * This implements the semantics given in
 * http://www.w3.org/TR/xslt-30/#package-versions,
 * where a comma-separated sequence of package-version ranges are declared as one of:
 * 
 * '*' - any version
 * package-version - an exact match
 * package-version'.*' - any package whose version starts with the given prefix
 * package-version'+' - any package whose version orders equal or later than the given version
 * 'to 'package-version - any package whose version orders equal or earlier than the given version
 * package-version' to 'package-version - any package whose version orders equal to or between the given versions
 * 
 */
public class PackageVersionRanges {

    private final ArrayList ranges;

    private static class PackageVersionRange {
        private final String display;
        private PackageVersion low;
        private PackageVersion high;
        private boolean all = false;
        private boolean prefix = false;

        public PackageVersionRange(String s) throws XPathException {
            display = s;
            if ("*".equals(s)) {
                all = true;
            } else if (s.endsWith("+")) {
                low = new PackageVersion(s.replace("+", ""));
                high = PackageVersion.MAX_VALUE;
            } else if (s.endsWith(".*")) {
                prefix = true;
                low = new PackageVersion(s.replace(".*", ""));
            } else if (s.matches(".*\\s*to\\s+.*")) {
                String[] range = s.split("\\s*to\\s+");
                if (range.length > 2) {
                    throw new XPathException("Invalid version range:" + s, "XTSE0020");
                }
                low = range[0].equals("") ? PackageVersion.ZERO : new PackageVersion(range[0]);
                high = new PackageVersion(range[1]);
            } else {
                low = new PackageVersion(s);
                high = low;
            }
        }

        boolean contains(PackageVersion v) {
            if (all) {
                return true;
            } else if (prefix) {
                return low.isPrefix(v);
            } else {
                return low.compareTo(v) <= 0 && v.compareTo(high) <= 0;
            }
        }

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

    /**
     * Generate a set of package version ranges
     *
     * @param s Input string describing the ranges in the grammar described in
     *          http://www.w3.org/TR/xslt-30/#package-versions
     * @throws XPathException if any version range is invalid
     */
    public PackageVersionRanges(String s) throws XPathException {
        ranges = new ArrayList();
        for (String p : s.trim().split("\\s*,\\s*")) {
            ranges.add(new PackageVersionRange(p));
        }
    }

    /**
     * Test whether a given package version lies within any of the ranges described in this PackageVersionRanges
     * @param version The version to be checked
     * @return  true if the version is contained in any of the ranges, false otherwise
     */
    public boolean contains(PackageVersion version) {
        for (PackageVersionRange r : ranges) {
            if (r.contains(version)) {
                return true;
            }
        }
        return false;
    }

    @Override
    public String toString() {
        if (ranges.size() == 1) {
            return ranges.get(0).toString();
        } else {
            StringBuilder buffer = new StringBuilder(256);
            for (PackageVersionRange r : ranges) {
                buffer.append(r.toString()).append(",");
            }
            buffer.setLength(buffer.length()-1);
            return buffer.toString();
        }
    }
}