extscript-core-root/extscript-core/src/main/java/org/apache/myfaces/extensions/scripting/jsf/resources/deprecated/ResourceLoader.java

/*
 * 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.myfaces.extensions.scripting.jsf.resources.deprecated;

import java.io.InputStream;
import java.net.URL;
import java.util.Comparator;

/**
 * Base class for resource loaders.  Resource loaders can lookup resources 
 * as URLs from arbitrary locations, including JAR files.
 * 
 * @author Leonardo Uribe (latest modification by $Author: lu4242 $)
 * @version $Revision: 882702 $ $Date: 2009-11-20 15:16:07 -0500 (Vie, 20 Nov 2009) $
 * @deprecated
 */
public abstract class ResourceLoader
{
    
    public static final String VERSION_INVALID = "INVALID";
    
    private String _prefix;
    
    public ResourceLoader(String prefix)
    {
        _prefix = prefix;
    }

    /**
     * Gets the resource version of a specifiy resource
     *
     * @param path the resource path
     * @return the version of the resource as String
     */
    public abstract String getResourceVersion(String path);

    /**
     * Return the max available version found (if exists) or
     * return null if no version available.
     *
     * @param path the path to the library
     * @return the available version or null
     */
    public abstract String getLibraryVersion(String path);

    /**
     * Return the resourource url from the given meta data
     *
     * @param resourceMeta the resource metadata
     * @return the resourource url from the given meta data
     */
    public abstract URL getResourceURL(ResourceMeta resourceMeta);

    /**
     *  Returns an input stream on a given resource defined by resource meta
     *
      * @param resourceMeta the resource metadata
     * @return an input stream on the given resource
     */
    public abstract InputStream getResourceInputStream(ResourceMeta resourceMeta);

    /**
     * creates a resource meta data object
     * @param prefix the prefix for the resource
     * @param libraryName the library name
     * @param libraryVersion the library version
     * @param resourceName the resource name
     * @param resourceVersion and the version
     * @return a ResourceMeta object of the information passed to this method
     */
    public abstract ResourceMeta createResourceMeta(String prefix, String libraryName, String libraryVersion,
            String resourceName, String resourceVersion);

    /**
     * checks if the library exists
     * @param libraryName the library name to check for
     * @return true if it exists
     */
    public abstract boolean libraryExists(String libraryName);
    
    private Comparator<String> _versionComparator = null;

    protected Comparator<String> getVersionComparator()
    {
        if (_versionComparator == null)
        {
            _versionComparator = new VersionComparator();
        }
        return _versionComparator;
    }

    protected void setVersionComparator(Comparator<String> versionComparator)
    {
        _versionComparator = versionComparator;
    }

    protected class VersionComparator implements Comparator<String>
    {

        /**
         * Standard comoare method
         * @param s1 string1 to compare
         * @param s2 string2 to compare
         * @return standard numeric compare result
         */
        public int compare(String s1, String s2)
        {
            int n1 = 0;
            int n2 = 0;
            String o1 = s1;
            String o2 = s2;

            boolean p1 = true;
            boolean p2 = true;

            while (n1 == n2 && (p1 || p2))
            {
                int i1 = o1.indexOf('_');
                int i2 = o2.indexOf('_');
                if (i1 < 0)
                {
                    if (o1.length() > 0)
                    {
                        p1 = false;
                        n1 = Integer.valueOf(o1);
                        o1 = "";
                    }
                    else
                    {
                        p1 = false;
                        n1 = 0;
                    }
                }
                else
                {
                    n1 = Integer.valueOf(o1.substring(0, i1));
                    o1 = o1.substring(i1 + 1);
                }
                if (i2 < 0)
                {
                    if (o2.length() > 0)
                    {
                        p2 = false;
                        n2 = Integer.valueOf(o2);
                        o2 = "";
                    }
                    else
                    {
                        p2 = false;
                        n2 = 0;
                    }
                }
                else
                {
                    n2 = Integer.valueOf(o2.substring(0, i2));
                    o2 = o2.substring(i2 + 1);
                }
            }

            if (n1 == n2)
            {
                return s1.length() - s2.length();
            }
            return n1 - n2;
        }
    }

    /**
     * getter for the standard resource loader prefix
     * @return the resource loader prefix
     */
    public String getPrefix()
    {
        return _prefix;
    }

    /**
     * setter for the prefix
     * @param prefix the prefix satring used for the resource loader
     */
    public void setPrefix(String prefix)
    {
        _prefix = prefix;
    }
}