Class MultipleParentClassLoader.Builder

java.lang.Object
net.bytebuddy.dynamic.loading.MultipleParentClassLoader.Builder
Enclosing class:
MultipleParentClassLoader

@Enhance public static class MultipleParentClassLoader.Builder extends Object
A builder to collect class loader and that creates a MultipleParentClassLoader only if multiple or no ClassLoaders are found in the process. If exactly a single class loader is found, this class loader is returned. All class loaders are applied in their collection order with the exception of the bootstrap class loader which is represented by null and which is an implicit parent of any class loader.
  • Field Details

    • ONLY

      private static final int ONLY
      Indicates the first index of a list.
      See Also:
    • sealed

      private final boolean sealed
      true if the created class loader is sealed.
    • classLoaders

      private final List<? extends ClassLoader> classLoaders
      The class loaders that were collected.
  • Constructor Details

    • Builder

      public Builder()
      Creates a new builder without any class loaders.
    • Builder

      public Builder(boolean sealed)
      Creates a new builder without any class loaders.
      Parameters:
      sealed - true if the created class loader is sealed.
    • Builder

      private Builder(List<? extends ClassLoader> classLoaders, boolean sealed)
      Creates a new builder.
      Parameters:
      classLoaders - The class loaders that were collected until now.
      sealed - true if the created class loader is sealed.
  • Method Details

    • append

      public MultipleParentClassLoader.Builder append(Class<?>... type)
      Appends the class loaders of the given types. The bootstrap class loader is implicitly skipped as it is an implicit parent of any class loader.
      Parameters:
      type - The types of which to collect the class loaders.
      Returns:
      A new builder instance with the additional class loaders of the provided types if they were not yet collected.
    • append

      public MultipleParentClassLoader.Builder append(Collection<? extends Class<?>> types)
      Appends the class loaders of the given types if those class loaders were not yet collected. The bootstrap class loader is implicitly skipped as it is an implicit parent of any class loader.
      Parameters:
      types - The types of which to collect the class loaders.
      Returns:
      A new builder instance with the additional class loaders.
    • append

      public MultipleParentClassLoader.Builder append(ClassLoader... classLoader)
      Appends the given class loaders if they were not yet collected. The bootstrap class loader is implicitly skipped as it is an implicit parent of any class loader.
      Parameters:
      classLoader - The class loaders to be collected.
      Returns:
      A new builder instance with the additional class loaders.
    • append

      public MultipleParentClassLoader.Builder append(List<? extends ClassLoader> classLoaders)
      Appends the given class loaders if they were not yet appended. The bootstrap class loader is never appended as it is an implicit parent of any class loader.
      Parameters:
      classLoaders - The class loaders to collected.
      Returns:
      A new builder instance with the additional class loaders.
    • appendMostSpecific

      public MultipleParentClassLoader.Builder appendMostSpecific(Class<?>... type)
      Appends the class loaders of the given types but filters any duplicates within the hierarchy of class loaders. The bootstrap class loader is implicitly skipped as it is an implicit parent of any class loader. Class loaders are prepended to the list of class loaders.
      Parameters:
      type - The types of which to collect the class loaders.
      Returns:
      A new builder instance with the additional class loaders of the provided types if they were not yet collected.
    • appendMostSpecific

      public MultipleParentClassLoader.Builder appendMostSpecific(Collection<? extends Class<?>> types)
      Appends the class loaders of the given types but filters any duplicates within the hierarchy of class loaders. The bootstrap class loader is implicitly skipped as it is an implicit parent of any class loader. Class loaders are prepended to the list of class loaders.
      Parameters:
      types - The types of which to collect the class loaders.
      Returns:
      A new builder instance with the additional class loaders.
    • appendMostSpecific

      public MultipleParentClassLoader.Builder appendMostSpecific(ClassLoader... classLoader)
      Appends the given class loaders but removes any class loaders that are the parent of any previously registered class loader. The bootstrap class loader is implicitly skipped as it is an implicit parent of any class loader.
      Parameters:
      classLoader - The class loaders to be collected.
      Returns:
      A new builder instance with the additional class loaders.
    • appendMostSpecific

      public MultipleParentClassLoader.Builder appendMostSpecific(List<? extends ClassLoader> classLoaders)
      Appends the given class loaders but removes any class loaders that are the parent of any previously registered class loader. The bootstrap class loader is implicitly skipped as it is an implicit parent of any class loader.
      Parameters:
      classLoaders - The class loaders to collected.
      Returns:
      A new builder instance with the additional class loaders.
    • filter

      Only retains all class loaders that match the given matcher.
      Parameters:
      matcher - The matcher to be used for filtering.
      Returns:
      A builder that does not longer consider any appended class loaders that matched the provided matcher.
    • build

      public ClassLoader build()

      Returns the only class loader that was appended if exactly one class loader was appended or a multiple parent class loader as a parent of all supplied class loader and with the bootstrap class loader as an implicit parent. If no class loader was appended, a new class loader is created that declares no parents. If a class loader is created, its explicit parent is set to be the bootstrap class loader.

      Important: Byte Buddy does not provide any access control for the creation of the class loader. It is the responsibility of the user of this builder to provide such privileges.

      Returns:
      A suitable class loader.
    • build

      public ClassLoader build(ClassLoader parent)

      Returns the only class loader that was appended if exactly one class loader was appended or a multiple parent class loader as a parent of all supplied class loader and with the bootstrap class loader as an implicit parent. If no class loader was appended, or if only the supplied parent to this method was included, this class loader is returned,

      Important: Byte Buddy does not provide any access control for the creation of the class loader. It is the responsibility of the user of this builder to provide such privileges.

      Parameters:
      parent - The class loader's contractual parent which is accessible via ClassLoader.getParent(). If this class loader is also included in the appended class loaders, it is not
      Returns:
      A suitable class loader.
    • doBuild

      private ClassLoader doBuild(@MaybeNull ClassLoader parent)
      Creates a multiple parent class loader with an explicit parent.
      Parameters:
      parent - The explicit parent class loader.
      Returns:
      A multiple parent class loader that includes all collected class loaders and the explicit parent.