An iterator that visits child documents in a directory. More...

#include "juce_AndroidDocument.h"

Classes
struct	Pimpl

struct	Utils

Public Types
using	difference_type = std::ptrdiff_t

using	pointer = void

using	iterator_category = std::input_iterator_tag

Public Member Functions
	AndroidDocumentIterator ()=default
	Creates an end/sentinel iterator.

bool	operator== (const AndroidDocumentIterator &other) const noexcept

bool	operator!= (const AndroidDocumentIterator &other) const noexcept

AndroidDocument	operator* () const
	Returns the document to which this iterator points.

AndroidDocumentIterator &	operator++ ()
	Moves this iterator to the next position.

AndroidDocumentIterator	begin () const
	Allows this iterator to be used directly in a range-for.

AndroidDocumentIterator	end () const
	Allows this iterator to be used directly in a range-for.

Static Public Member Functions
static AndroidDocumentIterator	makeNonRecursive (const AndroidDocument &)
	Create an iterator that will visit each item in this directory.

static AndroidDocumentIterator	makeRecursive (const AndroidDocument &)
	Create an iterator that will visit each item in this directory, and all nested directories.

Detailed Description

An iterator that visits child documents in a directory.

Instances of this iterator can be created by calling makeRecursive() or makeNonRecursive(). The results of these functions can additionally be used in standard algorithms, and in range-for loops:

AndroidDocument findFileWithName (const AndroidDocument& parent, const String& name)
{
    for (const auto& child : AndroidDocumentIterator::makeNonRecursive (parent))
        if (child.getInfo().getName() == name)
              return child;
 
      return AndroidDocument();
}
 
std::vector<AndroidDocument> findAllChildrenRecursive (const AndroidDocument& parent)
{
    std::vector<AndroidDocument> children;
    std::copy (AndroidDocumentIterator::makeRecursive (doc),
               AndroidDocumentIterator(),
               std::back_inserter (children));
    return children;
}

@tags{Core}

Definition at line 436 of file juce_AndroidDocument.h.

Member Typedef Documentation

◆ difference_type

using juce::AndroidDocumentIterator::difference_type = std::ptrdiff_t

Definition at line 439 of file juce_AndroidDocument.h.

◆ iterator_category

using juce::AndroidDocumentIterator::iterator_category = std::input_iterator_tag

Definition at line 441 of file juce_AndroidDocument.h.

◆ pointer

using juce::AndroidDocumentIterator::pointer = void

Definition at line 440 of file juce_AndroidDocument.h.

Member Function Documentation

◆ begin()

AndroidDocumentIterator juce::AndroidDocumentIterator::begin ( ) const

Allows this iterator to be used directly in a range-for.

Definition at line 462 of file juce_AndroidDocument.h.

◆ end()

AndroidDocumentIterator juce::AndroidDocumentIterator::end ( ) const

Allows this iterator to be used directly in a range-for.

Definition at line 465 of file juce_AndroidDocument.h.

◆ makeNonRecursive()

AndroidDocumentIterator juce::AndroidDocumentIterator::makeNonRecursive ( const AndroidDocument & dir )

static

Create an iterator that will visit each item in this directory.

Definition at line 1023 of file juce_AndroidDocument_android.cpp.

◆ makeRecursive()

AndroidDocumentIterator juce::AndroidDocumentIterator::makeRecursive ( const AndroidDocument & dir )

static

Create an iterator that will visit each item in this directory, and all nested directories.

Definition at line 1041 of file juce_AndroidDocument_android.cpp.

◆ operator!=()

bool juce::AndroidDocumentIterator::operator!= ( const AndroidDocumentIterator & other ) const

noexcept

Definition at line 453 of file juce_AndroidDocument.h.

◆ operator*()

AndroidDocument juce::AndroidDocumentIterator::operator* ( ) const

Returns the document to which this iterator points.

Definition at line 1065 of file juce_AndroidDocument_android.cpp.

◆ operator++()

AndroidDocumentIterator & juce::AndroidDocumentIterator::operator++ ( )

Moves this iterator to the next position.

Definition at line 1067 of file juce_AndroidDocument_android.cpp.

◆ operator==()

bool juce::AndroidDocumentIterator::operator== ( const AndroidDocumentIterator & other ) const