Class RuntimeProcessingEnvironmentSupplier

java.lang.Object

org.microbean.construct.RuntimeProcessingEnvironmentSupplier

All Implemented Interfaces:

AutoCloseable, Supplier<ProcessingEnvironment>

public final class RuntimeProcessingEnvironmentSupplier
extends Object
implements AutoCloseable, Supplier<ProcessingEnvironment>

A utility class that can supply a ProcessingEnvironment suitable for use at runtime.

Most users should simply use an appropriate DefaultDomain instead of working directly with instances of this class.

Author:

Laird Nelson

See Also:

• get()
• of()
• close()
• ProcessingEnvironment
• DefaultDomain()

Method Summary

Modifier and Type	Method	Description
final void	close()	Closes this RuntimeProcessingEnvironmentSupplier, which invalidates all ProcessingEnvironments supplied by it.
final ProcessingEnvironment	get()	Returns a non-null, ProcessingEnvironment suitable for runtime use.
static final RuntimeProcessingEnvironmentSupplier	of()	Returns a non-null RuntimeProcessingEnvironmentSupplier.

Methods inherited from class Object

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

Method Details

close

public final void close()

Closes this RuntimeProcessingEnvironmentSupplier, which invalidates all ProcessingEnvironments supplied by it.

A subsequent call to get() will reset this RuntimeProcessingEnvironmentSupplier.

Closing a RuntimeProcessingEnvironmentSupplier that has already been closed has no effect.

Most users should not have a need to call this method. RuntimeProcessingEnvironmentSupplier instances do not have to be closed.

Specified by:

close in interface AutoCloseable

See Also:

• get()

get

public final ProcessingEnvironment get()

Returns a non-null, ProcessingEnvironment suitable for runtime use.

ProcessingEnvironment instances are not guaranteed to be safe for concurrent use by multiple threads.

Most users should simply use an appropriate DefaultDomain instead of working directly with instances of this class.

Specified by:

get in interface Supplier<ProcessingEnvironment>

Returns:

a non-null ProcessingEnvironment

See Also:

• DefaultDomain()

of

public static final RuntimeProcessingEnvironmentSupplier of()

Returns a non-null RuntimeProcessingEnvironmentSupplier.

Most users should simply use an appropriate DefaultDomain instead of working directly with instances of this class.

Returns:

a non-null RuntimeProcessingEnvironmentSupplier

See Also:

• ProcessingEnvironment
• DefaultDomain()