com.atlassian.jira.util

Interface Supplier<T>

Type Parameters:

T - the type of object supplied.

All Known Subinterfaces:

IndexDirectoryFactory

All Known Implementing Classes:

ComponentReference, IndexDirectoryFactory.IndexPathAdapter, MockIndexDirectoryFactory, OsgiComponentReference

public interface Supplier<T>

A Supplier of objects of a single type. Semantically, this could be a Factory, Generator, Builder, Closure, Producer or something else entirely. No guarantees are implied by this interface. Implementations may return null if no objects are available, can optionally block until elements are available or throw NoSuchElementException.

Thread safety of a Supplier is not mandated by this interface, although serious care and consideration should be taken with any implementations that are not.

See Also:

for a similar interface.

Method Summary

Methods

Modifier and Type	Method and Description
T	get() Produce an object.

Method Detail

get

T get()

Produce an object. Retrieve an instance of the appropriate type. The returned object may or may not be a new instance, depending on the implementation.

Returns:

the product, may be null if there are no objects available.

Throws:

NoSuchElementException - if the supply has been exhausted.