Package io.quarkus.bootstrap.classloading

Interface ClassPathElement

All Superinterfaces:
AutoCloseable, Closeable
All Known Implementing Classes:
AbstractClassPathElement, FilteredClassPathElement, MemoryClassPathElement, PathTreeClassPathElement
public interface ClassPathElement extends Closeable
Represents an element on the virtual classpath, such as a jar file or classes directory.

  • Field Details

  • Method Details

    • getDependencyKey

      default io.quarkus.maven.dependency.ArtifactKey getDependencyKey()
      If this classpath element represents a Maven artifact, the method will return its key, otherwise - null.
      Returns:
      the key of the Maven artifact this classpath element represents or null, in case this element does not represent any Maven artifact

    • getResolvedDependency

      default io.quarkus.maven.dependency.ResolvedDependency getResolvedDependency()
      If this classpath element represents a Maven artifact, the method will return it, otherwise - null.
      Returns:
      the Maven artifact this classpath element represents or null, in case this element does not represent any Maven artifact

    • getRoot

      Path getRoot()
      Returns:
      The element root, or null if not applicable

    • apply

      <T> T apply(Function<io.quarkus.paths.OpenPathTree,T> func)
      Processes the content of this classpath element and returns a result.
      Type Parameters:
      T - result type
      Parameters:
      func - content processing function
      Returns:
      processing result

    • getResource

      ClassPathResource getResource(String name)
      Loads a resource from the class path element, or null if it does not exist.
      Parameters:
      name - The resource to load
      Returns:
      An representation of the class path resource if it exists

    • getProvidedResources

      Set<String> getProvidedResources()
      Returns a set of all known resources.
      Returns:
      A set representing all known resources

    • containsReloadableResources

      boolean containsReloadableResources()
      Whether this class path element contains resources that can be reloaded in dev mode.

    • getProtectionDomain

      ProtectionDomain getProtectionDomain()
      Returns:
      The protection domain that should be used to define classes from this element

    • getManifestAttributes

      io.quarkus.paths.ManifestAttributes getManifestAttributes()

    • isRuntime

      boolean isRuntime()
      Checks whether this is a runtime classpath element
      Returns:
      true in case this is a runtime classpath element, otherwise - false

    • fromPath

      static ClassPathElement fromPath(Path path, boolean runtime)
      Creates an element from a file system path

    • fromDependency

      static ClassPathElement fromDependency(io.quarkus.maven.dependency.ResolvedDependency dep)

    • fromDependency

      static ClassPathElement fromDependency(io.quarkus.paths.PathTree contentTree, io.quarkus.maven.dependency.ResolvedDependency dep)

    • getResources

      default List<ClassPathResource> getResources(String name)