Interface Plugin.Engine.Source.Origin

All Superinterfaces:

AutoCloseable, Closeable, Iterable<Plugin.Engine.Source.Element>

All Known Implementing Classes:

Plugin.Engine.Source.Compound.Origin, Plugin.Engine.Source.Empty, Plugin.Engine.Source.ForFolder, Plugin.Engine.Source.InMemory, Plugin.Engine.Source.Origin.Filtering, Plugin.Engine.Source.Origin.ForJarFile

Enclosing interface:

Plugin.Engine.Source

public static interface Plugin.Engine.Source.Origin
extends Iterable<Plugin.Engine.Source.Element>, Closeable

An origin for elements.

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static class	Plugin.Engine.Source.Origin.Filtering	An origin that forwards all invocations to a delegate where an ElementMatcher is applied prior to iteration.
static class	Plugin.Engine.Source.Origin.ForJarFile	An origin implementation for a jar file.

Field Summary

Fields

Modifier and Type	Field	Description
static final Manifest	NO_MANIFEST	Indicates that no manifest exists.

Method Summary

Modifier and Type	Method	Description
Manifest	getManifest()	Returns the manifest file of the source location or null if no manifest exists.
ClassFileLocator	toClassFileLocator(ClassFileVersion classFileVersion)	Creates a class file locator for the represented source.

Methods inherited from interface Closeable

close

Methods inherited from interface Iterable

forEach, iterator, spliterator

Field Details

NO_MANIFEST

@AlwaysNull
static final Manifest NO_MANIFEST

Indicates that no manifest exists.

Method Details

getManifest

@MaybeNull
Manifest getManifest()
              throws IOException

Returns the manifest file of the source location or null if no manifest exists.

Returns:

This source's manifest or null.

Throws:

IOException - If an I/O error occurs.

toClassFileLocator

ClassFileLocator toClassFileLocator(@MaybeNull
 ClassFileVersion classFileVersion)
                             throws IOException

Creates a class file locator for the represented source. If the class file locator needs to be closed, it is the responsibility of this origin to close the locator or its underlying resources.

Parameters:

classFileVersion - The class file version to consider for multi-release jars or null if multi-release jars should not be considered.

Returns:

A class file locator for locating class files of this instance.

Throws:

IOException - If an I/O exception occurs.