Package net.bytebuddy.build

Class Plugin.Engine.Source.ForFolder

java.lang.Object

net.bytebuddy.build.Plugin.Engine.Source.ForFolder

All Implemented Interfaces:

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

Enclosing interface:

Plugin.Engine.Source

@Enhance
public static class Plugin.Engine.Source.ForFolder
extends Object
implements Plugin.Engine.Source, Plugin.Engine.Source.Origin

Represents the contents of a folder as class files.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
protected class	Plugin.Engine.Source.ForFolder.FolderIterator	An iterator that exposes all files within a folder structure as elements.

Nested classes/interfaces inherited from interface net.bytebuddy.build.Plugin.Engine.Source

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

Nested classes/interfaces inherited from interface net.bytebuddy.build.Plugin.Engine.Source.Origin

Plugin.Engine.Source.Origin.Filtering, Plugin.Engine.Source.Origin.ForJarFile

Field Summary

Fields

Modifier and Type	Field	Description
private final File	folder	The folder to represent.

Fields inherited from interface net.bytebuddy.build.Plugin.Engine.Source.Origin

NO_MANIFEST

Constructor Summary

Constructors

Constructor	Description
ForFolder(File folder)	Creates a new source representation for a given folder.

Method Summary

Modifier and Type	Method	Description
void	close()
ClassFileLocator	getClassFileLocator()	Returns a class file locator for the represented source.
Manifest	getManifest()	Returns the manifest file of the source location or null if no manifest exists.
Iterator<Plugin.Engine.Source.Element>	iterator()
Plugin.Engine.Source.Origin	read()	Initializes a reading from this source.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Field Details

folder

private final File folder

The folder to represent.

Constructor Details

ForFolder

public ForFolder(File folder)

Creates a new source representation for a given folder.

Parameters:

folder - The folder to represent.

Method Details

read

public Plugin.Engine.Source.Origin read()

Initializes a reading from this source.

Specified by:

read in interface Plugin.Engine.Source

Returns:

A source that represents the resource of this origin.

getClassFileLocator

public ClassFileLocator getClassFileLocator()

Returns 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.

Specified by:

getClassFileLocator in interface Plugin.Engine.Source.Origin

Returns:

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

getManifest

@MaybeNull
public Manifest getManifest()
                     throws IOException

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

Specified by:

getManifest in interface Plugin.Engine.Source.Origin

Returns:

This source's manifest or null.

Throws:

IOException - If an I/O error occurs.

iterator

public Iterator<Plugin.Engine.Source.Element> iterator()

Specified by:

iterator in interface Iterable<Plugin.Engine.Source.Element>

close

public void close()

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Closeable