org.jboss.classloading.plugins.metadata.PackageRequirement Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of jboss-classloading
JBoss ClassLoading
There is a newer version: 2.2.1.GA
/*
* JBoss, Home of Professional Open Source
* Copyright 2006, JBoss Inc., and individual contributors as indicated
* by the @authors tag. See the copyright.txt in the distribution for a
* full listing of individual contributors.
*
* This is free software; you can redistribute it and/or modify it
* under the terms of the GNU Lesser General Public License as
* published by the Free Software Foundation; either version 2.1 of
* the License, or (at your option) any later version.
*
* This software is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
* Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public
* License along with this software; if not, write to the Free
* Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
* 02110-1301 USA, or see the FSF site: http://www.fsf.org.
*/
package org.jboss.classloading.plugins.metadata;

import java.util.Collections;
import java.util.Set;

import org.jboss.classloader.plugins.filter.EverythingClassFilter;
import org.jboss.classloader.spi.filter.ClassFilter;
import org.jboss.classloader.spi.filter.PackageClassFilter;
import org.jboss.classloader.spi.filter.RecursivePackageClassFilter;
import org.jboss.classloading.spi.dependency.Module;
import org.jboss.classloading.spi.metadata.OptionalPackages;
import org.jboss.classloading.spi.metadata.Requirement;
import org.jboss.classloading.spi.metadata.helpers.AbstractRequirement;
import org.jboss.classloading.spi.version.VersionRange;

/**
 * PackageRequirement.
 * 
 * @author Adrian Brock
 * @author Ales Justin
 * @version $Revision: 1.1 $
 */
public class PackageRequirement extends AbstractRequirement implements OptionalPackages
{
   /** The serialVersionUID */
   private static final long serialVersionUID = -7552921085464308835L;

   /** The filter */
   private transient ClassFilter filter;

   /**
    * Create a new PackageRequirement.
    */
   public PackageRequirement()
   {
   }
   
   /**
    * Create a new PackageRequirement with no version constraint
    * 
    * @param name the name
    * @throws IllegalArgumentException for a null name
    */
   public PackageRequirement(String name)
   {
      super(name);
   }
   
   /**
    * Create a new PackageRequirement.
    * 
    * @param name the name
    * @param versionRange the version range - pass null for all versions
    * @throws IllegalArgumentException for a null name
    */
   public PackageRequirement(String name, VersionRange versionRange)
   {
      super(name, versionRange);
   }
   
   public Set getOptionalPackageNames(Module module)
   {
      if (isOptional() == false)
         return null;
      return Collections.singleton(getName());
   }

   /**
    * Gets the {@link ClassFilter} that corrsponds to this PackageRequiment.
    * 
    * This methods supports explicit packages, wildcard sub packages (e.g. org.foo.*)
    * and the everything wildcard (i.e. '*')
    * 
    * @return class filter corresponding the package name
    */
   public ClassFilter toClassFilter()
   {
      if (filter == null)
      {
         String packageName = getName();
         if ("*".equals(packageName))
         {
            filter = EverythingClassFilter.INSTANCE;
         }
         else if (packageName.endsWith(".*"))
         {
            packageName = packageName.substring(0, packageName.length() - 2);
            filter = RecursivePackageClassFilter.createRecursivePackageClassFilter(packageName);
         }
         else
         {
            filter = PackageClassFilter.createPackageClassFilter(packageName);
         }
      }
      return filter;
   }

   /**
    * Is this package requirement wildcard.
    * e.g. we check if it ends with '*'
    *
    * @return true if wildcard, false otherwise
    */
   public boolean isWildcard()
   {
      return getName().endsWith("*");
   }

   @Override
   public boolean isConsistent(Requirement other)
   {
      return isConsistent(other, PackageRequirement.class);
   }

   @Override
   public boolean equals(Object obj)
   {
      if (obj == this)
         return true;
      if (obj == null || obj instanceof PackageRequirement == false)
         return false;
      return super.equals(obj);
   }
}