alvinalexander.com | career | drupal | java | mac | mysql | perl | scala | uml | unix  

What this is

This file is included in the DevDaily.com "Java Source Code Warehouse" project. The intent of this project is to help you "Learn Java by Example" TM.

Other links

The source code

/*
 *                 Sun Public License Notice
 * 
 * The contents of this file are subject to the Sun Public License
 * Version 1.0 (the "License"). You may not use this file except in
 * compliance with the License. A copy of the License is available at
 * http://www.sun.com/
 * 
 * The Original Code is NetBeans. The Initial Developer of the Original
 * Code is Sun Microsystems, Inc. Portions Copyright 1997-2003 Sun
 * Microsystems, Inc. All Rights Reserved.
 */

package org.netbeans.modules.autoupdate;

import java.io.IOException;
import java.net.URL;
import java.util.*;
import java.util.jar.Attributes;

import org.openide.modules.Dependency;
import org.openide.modules.ModuleInfo;
import org.openide.modules.SpecificationVersion;

import org.netbeans.core.modules.AutomaticDependencies;
import org.openide.ErrorManager;
import org.openide.filesystems.FileObject;
import org.openide.filesystems.FileStateInvalidException;
import org.openide.filesystems.Repository;
import org.xml.sax.SAXException;

/** A fake module info class initialized from a manifest but not backed by a real JAR.
 * Used for purposes of comparisons to real modules and updates and so on.
 * @author Jesse Glick
 */
final class DummyModuleInfo extends ModuleInfo {
    
    private static AutomaticDependencies autoDepsHandler = null;
    
    /**
     * Roughly copied from NbInstaller.refineDependencies.
     * @see "#29577"
     */
    private static synchronized AutomaticDependencies getAutoDepsHandler() {
        if (autoDepsHandler == null) {
            FileObject depsFolder = Repository.getDefault().getDefaultFileSystem().findResource("ModuleAutoDeps"); // NOI18N
            if (depsFolder != null) {
                FileObject[] kids = depsFolder.getChildren();
                List urls = new ArrayList(Math.max(kids.length, 1)); // List
                for (int i = 0; i < kids.length; i++) {
                    if (kids[i].hasExt("xml")) { // NOI18N
                        try {
                            urls.add(kids[i].getURL());
                        } catch (FileStateInvalidException e) {
                            ErrorManager.getDefault().notify(e);
                        }
                    }
                }
                try {
                    autoDepsHandler = AutomaticDependencies.parse((URL[])urls.toArray(new URL[urls.size()]));
                } catch (IOException e) {
                    ErrorManager.getDefault().notify(e);
                } catch (SAXException e) {
                    ErrorManager.getDefault().notify(e);
                }
            }
            if (autoDepsHandler == null) {
                // Parsing failed, or no files.
                autoDepsHandler = AutomaticDependencies.empty();
            }
        }
        return autoDepsHandler;
    }
    
    private final Attributes attr;
    private final Set deps; // Set
    private final String[] provides;
    
    /** Create a new fake module based on manifest.
     * Only main attributes need be presented, so
     * only pass these.
     */
    public DummyModuleInfo(Attributes attr) throws IllegalArgumentException {
        this.attr = attr;
        if (getCodeName() == null) throw new IllegalArgumentException();
        String cnb = getCodeNameBase();
        try {
            getSpecificationVersion();
        } catch (NumberFormatException nfe) {
            throw new IllegalArgumentException(nfe.toString() + " from " + cnb); // NOI18N
        }
        deps = parseDeps(attr, cnb);
        getAutoDepsHandler().refineDependencies(cnb, deps); // #29577
        String providesS = attr.getValue("OpenIDE-Module-Provides"); // NOI18N
        if (providesS == null) {
            provides = new String[0];
        } else {
            StringTokenizer tok = new StringTokenizer(providesS, ", "); // NOI18N
            provides = new String[tok.countTokens()];
            for (int i = 0; i < provides.length; i++) {
                provides[i] = tok.nextToken();
            }
        }
        // XXX could do more error checking but this is probably plenty
    }
    
    public boolean isEnabled() {
        return false;
    }
    
    public SpecificationVersion getSpecificationVersion() {
        String sv = attr.getValue("OpenIDE-Module-Specification-Version"); // NOI18N
        return (sv == null ? null : new SpecificationVersion(sv));
    }
    
    public String getCodeName() {
        return attr.getValue("OpenIDE-Module"); // NOI18N
    }
    
    public int getCodeNameRelease() {
        String s = getCodeName();
        int idx = s.lastIndexOf('/'); // NOI18N
        if (idx == -1) {
            return -1;
        } else {
            return Integer.parseInt(s.substring(idx + 1));
        }
    }
    
    public String getCodeNameBase() {
        String s = getCodeName();
        int idx = s.lastIndexOf('/'); // NOI18N
        if (idx == -1) {
            return s;
        } else {
            return s.substring(0, idx);
        }
    }
    
    public Object getLocalizedAttribute(String a) {
        return attr.getValue(a);
    }
    
    public Object getAttribute(String a) {
        return attr.getValue(a);
    }
    
    /** Get a list of all dependencies this module has.  */
    public Set getDependencies() {
        return deps;
    }
    
    private final static Set parseDeps(Attributes attr, String cnb) throws IllegalArgumentException {
        Set s = new HashSet(); // Set
        s.addAll(Dependency.create(Dependency.TYPE_MODULE, attr.getValue("OpenIDE-Module-Module-Dependencies"))); // NOI18N
        s.addAll(Dependency.create(Dependency.TYPE_PACKAGE, attr.getValue("OpenIDE-Module-Package-Dependencies"))); // NOI18N
        s.addAll(Dependency.create(Dependency.TYPE_IDE, attr.getValue("OpenIDE-Module-IDE-Dependencies"))); // NOI18N
        s.addAll(Dependency.create(Dependency.TYPE_JAVA, attr.getValue("OpenIDE-Module-Java-Dependencies"))); // NOI18N
        s.addAll(Dependency.create(Dependency.TYPE_REQUIRES, attr.getValue("OpenIDE-Module-Requires"))); // NOI18N
        // #24143: treat API dependencies as dependencies on pseudomodule org.openide
        Iterator it = s.iterator();
        SpecificationVersion api = null;
        String impl = null;
        String major = null;
        while (it.hasNext()) {
            Dependency dep = (Dependency)it.next();
            if (dep.getType() == Dependency.TYPE_IDE) {
                if (dep.getComparison() == Dependency.COMPARE_SPEC) {
                    if (api != null) {
                        throw new IllegalArgumentException("Duplicate OpenIDE-Module-IDE-Dependencies found!"); // NOI18N
                    }
                    api = new SpecificationVersion(dep.getVersion());
                } else {
                    // Must be impl comparison.
                    if (impl != null) {
                        throw new IllegalArgumentException("Duplicate OpenIDE-Module-IDE-Dependencies found!"); // NOI18N
                    }
                    impl = dep.getVersion();
                }
                String name = dep.getName();
                int index = name.lastIndexOf('/');
                String newmajor;
                if (index == -1) {
                    newmajor = ""; // NOI18N
                } else {
                    newmajor = name.substring(index);
                }
                if (major != null && !major.equals(newmajor)) {
                    throw new IllegalArgumentException("Clashing OpenIDE-Module-IDE-Dependencies found!"); // NOI18N
                }
                major = newmajor;
                it.remove();
            }
        }
        if (api != null) {
            s.addAll(Dependency.create(Dependency.TYPE_MODULE, "org.openide" + major + " > " + api)); // NOI18N
        }
        if (impl != null) {
            s.addAll(Dependency.create(Dependency.TYPE_MODULE, "org.openide" + major + " = " + impl)); // NOI18N
        }
        if (api == null && impl == null) {
            // All modules implicitly depend on openide.
            // Needed for #29577.
            s.addAll(Dependency.create(Dependency.TYPE_MODULE, "org.openide/1 > 0")); // NOI18N
        }
        return s;
    }
    
    public boolean owns(Class clazz) {
        return false;
    }
    
    public String[] getProvides() {
        return provides;
    }
}
... this post is sponsored by my books ...

#1 New Release!

FP Best Seller

 

new blog posts

 

Copyright 1998-2021 Alvin Alexander, alvinalexander.com
All Rights Reserved.

A percentage of advertising revenue from
pages under the /java/jwarehouse URI on this website is
paid back to open source projects.