@PublicApi public interface

EnclosedIterable

implements Sized
com.atlassian.jira.util.collect.EnclosedIterable<T>
Known Indirect Subclasses

@PublicApi

This interface is designed for plugins to consume (call its methods).

Clients of @PublicApi can expect that programs compiled against a given version will remain binary compatible with later versions of the @PublicApi as per each product's API policy as long as the client does not implement/extend @PublicApi interfaces or classes (refer to each product's API policy for the exact guarantee---usually binary compatibility is guaranteed at least across minor versions).

Note: since @PublicApi interfaces and classes are not designed to be implemented or extended by clients, we may perform certain types of binary-incompatible changes to these classes and interfaces, but these will not affect well-behaved clients that do not extend/implement these types (in general, only classes and interfaces annotated with @PublicSpi are safe to extend/implement).

Class Overview

A limited collection view that may be backed by the something that needs closing, for example a connection to a database.

You can access all elements using the foreach(Consumer) method.

Summary

Nested Classes
class EnclosedIterable.Functions  
class EnclosedIterable.ListResolver<T> Utility class for transforming a EnclosedIterable into a List. 
Public Methods
void foreach(Consumer<T> sink)
Apply the sink to all elements in the Collection.
boolean isEmpty()
int size()
[Expand]
Inherited Methods
From interface com.atlassian.jira.util.collect.Sized

Public Methods

public void foreach (Consumer<T> sink)

Apply the sink to all elements in the Collection.

public boolean isEmpty ()

Returns
  • true if the there is no data behind it.

public int size ()

Returns
  • the likely size of the objects passed into the sink in foreach(Consumer). Be careful depending on this size being exact, as in many cases its best efforts value or may be unstable due to concurrent changes.