Class RelatedMediaReferences

All Implemented Interfaces:
Serializable, Iterator<RelatedMediaReference>
Direct Known Subclasses:
ConnectedRelatedMediaReferences

public abstract class RelatedMediaReferences extends PropertyIteratorBase implements Iterator<RelatedMediaReference>
RelatedMediaReferences supports an iterator over a list of related media references. Callers can use it to step through the list just once. If they want to parse the list again, they could use the copy/clone constructor to create a new iterator.
See Also:
  • Constructor Details

    • RelatedMediaReferences

      public RelatedMediaReferences(int totalElementCount, int maxCacheSize)
      Typical Constructor creates an iterator with the supplied list of elements.
      Parameters:
      totalElementCount - the total number of elements to process. A negative value is converted to 0.
      maxCacheSize - maximum number of elements that should be retrieved from the property server and cached in the element list at any one time. If a number less than one is supplied, 1 is used.
    • RelatedMediaReferences

      public RelatedMediaReferences(RelatedMediaReferences template)
      Copy/clone constructor. Used to reset iterator element pointer to 0;
      Parameters:
      template - type-specific iterator to copy; null to create an empty iterator
  • Method Details

    • cloneElement

      protected ElementBase cloneElement(ElementBase template)
      Provides a concrete implementation of cloneElement for the specific iterator type.
      Specified by:
      cloneElement in class PropertyIteratorBase
      Parameters:
      template - object to clone
      Returns:
      new cloned object.
    • cloneIterator

      protected abstract RelatedMediaReferences cloneIterator()
      Clones this iterator.
      Returns:
      new cloned object.
    • hasNext

      public boolean hasNext()
      The iterator can only be used once to step through the elements. This method returns a boolean to indicate if it has got to the end of the list yet.
      Specified by:
      hasNext in interface Iterator<RelatedMediaReference>
      Returns:
      boolean indicating whether there are more elements.
    • next

      public RelatedMediaReference next()
      Return the next element in the iteration.
      Specified by:
      next in interface Iterator<RelatedMediaReference>
      Returns:
      RelatedMediaReference next element object that has been cloned.
    • remove

      public void remove()
      Remove the current element in the iterator. (Null implementation since this iterator works off of cached elements from the property (metadata) server.)
      Specified by:
      remove in interface Iterator<RelatedMediaReference>
    • toString

      public String toString()
      Standard toString method.
      Overrides:
      toString in class Object
      Returns:
      print out of variables in a JSON-style