JLANG::JRewindableObjectReader< T > Struct Template Reference

Auxiliary class for object reading with rewinding. More...

#include <JObjectReader.hh>

Inheritance diagram for JLANG::JRewindableObjectReader< T >:

Public Types
typedef std::shared_ptr< JRewindableObjectIterator< T > >	helper_type
typedef JObjectIterator< T >::pointer_type	pointer_type

Public Member Functions
	JRewindableObjectReader ()
	Default constructor.
virtual JRewindableObjectIterator< T > *	getHelper () const override
	Get helper.
virtual void	rewind () override
	Rewind.
virtual bool	hasNext () override
	Check availability of next element.
virtual const pointer_type &	next () override
	Get next element.
virtual skip_type	skip (const skip_type ns) override
	Skip items.
bool	is_valid () const
	Check validity of helper.

Private Attributes
pointer_type	ps

Detailed Description

template<class T>
struct JLANG::JRewindableObjectReader< T >

Auxiliary class for object reading with rewinding.

This class implements the JAbstractRewindableObjectReader interface.

Definition at line 58 of file JObjectReader.hh.

Member Typedef Documentation

helper_type

template<class T >

std::shared_ptr< JRewindableObjectIterator<T> > JLANG::JRewindableObjectReader< T >::helper_type

Definition at line 64 of file JObjectReader.hh.

pointer_type

template<class T >

JObjectIterator<T>::pointer_type JLANG::JRewindableObjectReader< T >::pointer_type

Definition at line 65 of file JObjectReader.hh.

Constructor & Destructor Documentation

JRewindableObjectReader()

template<class T >

JLANG::JRewindableObjectReader< T >::JRewindableObjectReader ( )

inline

Default constructor.

Definition at line 70 of file JObjectReader.hh.

    {}

Member Function Documentation

getHelper()

template<class T >

virtual JRewindableObjectIterator< T > * JLANG::JRewindableObjectReader< T >::getHelper ( ) const

inlineoverridevirtual

Get helper.

Returns

helper

Implements JLANG::JAbstractRewindableObjectReader< T >.

Definition at line 79 of file JObjectReader.hh.

    {
      return this->get();
    }

rewind()

template<class T >

virtual void JLANG::JAbstractRewindableObjectReader< T >::rewind ( )

inlineoverridevirtualinherited

Rewind.

Implements JLANG::JRewindable< T >.

Reimplemented in JLANG::JSTDObjectReader< JTypeList< JHead_t, JTail_t > >.

Definition at line 115 of file JAbstractObjectReader.hh.

    {
      if (this->is_valid()) {
        this->getHelper()->rewind();
      }
    }

hasNext()

template<class T >

virtual bool JLANG::JAbstractObjectReader< T >::hasNext ( )

inlineoverridevirtualinherited

Check availability of next element.

Returns

true if the iteration has more elements; else false

Implements JLANG::JObjectIterator< T >.

Definition at line 54 of file JAbstractObjectReader.hh.

    {
      return (this->is_valid() && this->getHelper()->hasNext());
    }

next()

template<class T >

virtual const pointer_type & JLANG::JAbstractObjectReader< T >::next ( )

inlineoverridevirtualinherited

Get next element.

Returns

pointer to element

Implements JLANG::JObjectIterator< T >.

Definition at line 65 of file JAbstractObjectReader.hh.

    {
      if (this->is_valid())
        return this->getHelper()->next();
      else
        return ps;
    }

skip()

template<class T >

virtual skip_type JLANG::JAbstractObjectReader< T >::skip ( const skip_type ns )

inlineoverridevirtualinherited

Skip items.

Parameters

ns	number of items to skip

Returns

number of items skipped

Reimplemented from JLANG::JObjectIterator< T >.

Definition at line 80 of file JAbstractObjectReader.hh.

    {
      if (this->is_valid())
        return this->getHelper()->skip(ns);
      else
        return 0;
    } 

is_valid()

template<class T >

bool JLANG::JAbstractObjectReader< T >::is_valid ( ) const

inlineinherited

Check validity of helper.

Returns

true if helper not null; else false

Definition at line 35 of file JAbstractObjectReader.hh.

    { 
      return this->getHelper() != NULL; 
    }

Member Data Documentation

ps

template<class T >

pointer_type JLANG::JAbstractObjectReader< T >::ps

privateinherited

Definition at line 89 of file JAbstractObjectReader.hh.

---

The documentation for this struct was generated from the following file:

• JObjectReader.hh