CloseableIterable
Stay organized with collections
Save and categorize content based on your preferences.
|
Known Indirect Subclasses
|
Interface that is used to iterate through a set of repository documents.
This interface is useful for repositories that require an explicit call to close access and
perform clean-up actions.
Public Method Summary
|
abstract
void
|
close()
Performs any actions necessary to stop accessing the repository, such as closing the
connection.
|
Inherited Method Summary
From interface
java.lang.Iterable
|
void
|
forEach(Consumer<? super T> arg0)
|
|
abstract
Iterator<T>
|
iterator()
|
|
Spliterator<T>
|
spliterator()
|
From interface
java.lang.AutoCloseable
Public Methods
public
abstract
void
close
()
Performs any actions necessary to stop accessing the repository, such as closing the
connection.
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2025-03-18 UTC.
[null,null,["Last updated 2025-03-18 UTC."],[],[],null,["# CloseableIterable\n\npublic interface **CloseableIterable** implements Iterable\\\u003cT\\\u003e AutoCloseable \n\n|---|---|---|\n| Known Indirect Subclasses [CheckpointCloseableIterable](/workspace/cloud-search/docs/reference/sdk/com/google/enterprise/cloudsearch/sdk/CheckpointCloseableIterable)\\\u003cT\\\u003e, [CheckpointCloseableIterableImpl](/workspace/cloud-search/docs/reference/sdk/com/google/enterprise/cloudsearch/sdk/CheckpointCloseableIterableImpl)\\\u003cT\\\u003e, [CloseableIterableOnce](/workspace/cloud-search/docs/reference/sdk/com/google/enterprise/cloudsearch/sdk/CloseableIterableOnce)\\\u003cT\\\u003e |----------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | [CheckpointCloseableIterable](/workspace/cloud-search/docs/reference/sdk/com/google/enterprise/cloudsearch/sdk/CheckpointCloseableIterable)\\\u003cT\\\u003e | A [CloseableIterable](/workspace/cloud-search/docs/reference/sdk/com/google/enterprise/cloudsearch/sdk/CloseableIterable) that supports pagination while traversing a repository or incremental changes. | | [CheckpointCloseableIterableImpl](/workspace/cloud-search/docs/reference/sdk/com/google/enterprise/cloudsearch/sdk/CheckpointCloseableIterableImpl)\\\u003cT\\\u003e | [CheckpointCloseableIterable](/workspace/cloud-search/docs/reference/sdk/com/google/enterprise/cloudsearch/sdk/CheckpointCloseableIterable) implementation which supports lazy initialization of [getCheckpoint()](/workspace/cloud-search/docs/reference/sdk/com/google/enterprise/cloudsearch/sdk/CheckpointCloseableIterable#getCheckpoint()) value and [hasMore()](/workspace/cloud-search/docs/reference/sdk/com/google/enterprise/cloudsearch/sdk/CheckpointCloseableIterable#hasMore()). | | [CloseableIterableOnce](/workspace/cloud-search/docs/reference/sdk/com/google/enterprise/cloudsearch/sdk/CloseableIterableOnce)\\\u003cT\\\u003e | A [CloseableIterable](/workspace/cloud-search/docs/reference/sdk/com/google/enterprise/cloudsearch/sdk/CloseableIterable) that can be iterated over at most once. | |||\n\nInterface that is used to iterate through a set of repository documents.\n\nThis interface is useful for repositories that require an explicit call to close access and\nperform clean-up actions. \n\n### Public Method Summary\n\n|---------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| abstract void | [close](/workspace/cloud-search/docs/reference/sdk/com/google/enterprise/cloudsearch/sdk/CloseableIterable#close())() Performs any actions necessary to stop accessing the repository, such as closing the connection. |\n\n### Inherited Method Summary\n\nFrom interface java.lang.Iterable \n\n|------------------------|-------------------------------------|\n| void | forEach(Consumer\\\u003c? super T\\\u003e arg0) |\n| abstract Iterator\\\u003cT\\\u003e | iterator() |\n| Spliterator\\\u003cT\\\u003e | spliterator() |\n\nFrom interface java.lang.AutoCloseable \n\n|---------------|---------|\n| abstract void | close() |\n\nPublic Methods\n--------------\n\n#### public abstract void\n**close**\n()\n\nPerforms any actions necessary to stop accessing the repository, such as closing the\nconnection."]]
