Extract Iterator implementation into TypedDataCollection (#247)

* Refactored collections iterators, extracted the iterator directly into TypedDataCollection so that all the collections can benefit from the iterator.

* Making sure the iterator is always initialized, even if a subclass does not call super() in its constructor.

Author: catacraciun

intercom-java/src/main/java/io/intercom/api/AdminCollection.java

@@ -4,18 +4,15 @@
 import com.fasterxml.jackson.annotation.JsonInclude;
 import com.fasterxml.jackson.annotation.JsonProperty;
 
-import java.util.Iterator;
 import java.util.List;
 
 @SuppressWarnings("UnusedDeclaration")
 @JsonIgnoreProperties(ignoreUnknown = true)
 @JsonInclude(JsonInclude.Include.NON_EMPTY)
-public class AdminCollection extends TypedDataCollection<Admin> implements Iterator<Admin> {
-    protected TypedDataCollectionIterator<Admin> iterator;
+public class AdminCollection extends TypedDataCollection<Admin> {
 
     public AdminCollection() {
         type = "company.list";
-        iterator = new TypedDataCollectionIterator<Admin>(this);
     }
 
     @Override
@@ -29,17 +26,4 @@ public AdminCollection nextPage() {
     public List<Admin> getPage() {
         return super.getPage();
     }
-
-    public boolean hasNext() {
-        return iterator.hasNext();
-    }
-
-    public Admin next() {
-        return iterator.next();
-    }
-
-    public void remove() {
-        iterator.remove();
-    }
-
 }

intercom-java/src/main/java/io/intercom/api/CompanyCollection.java

@@ -3,21 +3,17 @@
 import com.fasterxml.jackson.annotation.JsonIgnoreProperties;
 import com.fasterxml.jackson.annotation.JsonProperty;
 
-import java.util.Iterator;
 import java.util.List;
 
 @SuppressWarnings("UnusedDeclaration")
 @JsonIgnoreProperties(ignoreUnknown = true)
-public class CompanyCollection extends TypedDataCollection<Company> implements Iterator<Company> {
-
-    protected TypedDataCollectionIterator<Company> iterator;
+public class CompanyCollection extends TypedDataCollection<Company> {
 
     @JsonProperty("total_count")
     private long totalCount;
 
     public CompanyCollection() {
         type = "company.list";
-        iterator = new TypedDataCollectionIterator<Company>(this);
     }
 
     public CompanyCollection(List<Company> companies) {
@@ -41,18 +37,6 @@ public CompanyCollection nextPage() {
         return fetchNextPage(CompanyCollection.class);
     }
 
-    public boolean hasNext() {
-        return iterator.hasNext();
-    }
-
-    public Company next() {
-        return iterator.next();
-    }
-
-    public void remove() {
-        iterator.remove();
-    }
-
     @Override
     public String toString() {
         return "CompanyCollection{" +

intercom-java/src/main/java/io/intercom/api/ContactCollection.java

@@ -8,12 +8,10 @@
 
 @SuppressWarnings("UnusedDeclaration")
 @JsonIgnoreProperties(ignoreUnknown = true)
-public class ContactCollection extends TypedDataCollection<Contact> implements Iterator<Contact> {
+public class ContactCollection extends TypedDataCollection<Contact> {
 
-    protected TypedDataCollectionIterator<Contact> iterator;
 
     public ContactCollection() {
-        iterator = new TypedDataCollectionIterator<Contact>(this);
     }
 
     public ContactCollection(List<Contact> contacts) {
@@ -32,17 +30,4 @@ public List<Contact> getPage() {
     public ContactCollection nextPage() {
         return fetchNextPage(ContactCollection.class);
     }
-
-    public boolean hasNext() {
-        return iterator.hasNext();
-    }
-
-    public Contact next() {
-        return iterator.next();
-    }
-
-    public void remove() {
-        iterator.remove();
-    }
-
 }

intercom-java/src/main/java/io/intercom/api/ConversationCollection.java

@@ -8,13 +8,11 @@
 
 @SuppressWarnings("UnusedDeclaration")
 @JsonIgnoreProperties(ignoreUnknown = true)
-public class ConversationCollection extends TypedDataCollection<Conversation> implements Iterator<Conversation> {
+public class ConversationCollection extends TypedDataCollection<Conversation> {
 
-    protected TypedDataCollectionIterator<Conversation> iterator;
 
     public ConversationCollection() {
         type = "conversation.list";
-        iterator = new TypedDataCollectionIterator<Conversation>(this);
     }
 
     @SuppressWarnings("EmptyMethod")
@@ -27,18 +25,4 @@ public List<Conversation> getPage() {
     public ConversationCollection nextPage() {
         return fetchNextPage(ConversationCollection.class);
     }
-
-
-    public boolean hasNext() {
-        return iterator.hasNext();
-    }
-
-    public Conversation next() {
-        return iterator.next();
-    }
-
-    public void remove() {
-        iterator.remove();
-    }
-
 }

intercom-java/src/main/java/io/intercom/api/EventCollection.java

@@ -8,11 +8,9 @@
 
 @SuppressWarnings("UnusedDeclaration")
 @JsonIgnoreProperties(ignoreUnknown = true)
-public class EventCollection  extends TypedDataCollection<Event> implements Iterator<Event> {
-  protected TypedDataCollectionIterator<Event> iterator;
+public class EventCollection  extends TypedDataCollection<Event> {
 
   public EventCollection() {
-    iterator = new TypedDataCollectionIterator<Event>(this);
   }
 
   public EventCollection(List<Event> events) {
@@ -31,16 +29,4 @@ public List<Event> getPage() {
   public EventCollection nextPage() {
     return fetchNextPage(EventCollection.class);
   }
-
-  public boolean hasNext() {
-    return iterator.hasNext();
-  }
-
-  public Event next() {
-    return iterator.next();
-  }
-
-  public void remove() {
-    iterator.remove();
-  }
 }

intercom-java/src/main/java/io/intercom/api/JobItemCollection.java

@@ -3,19 +3,13 @@
 import com.fasterxml.jackson.annotation.JsonIgnoreProperties;
 import com.fasterxml.jackson.annotation.JsonProperty;
 
-import java.util.Iterator;
 import java.util.List;
 
 @SuppressWarnings("UnusedDeclaration")
 @JsonIgnoreProperties(ignoreUnknown = true)
-public class JobItemCollection<T extends TypedData>
-    extends TypedDataCollection<JobItem<T>>
-    implements Iterator<JobItem<T>> {
-
-    protected TypedDataCollectionIterator<JobItem<T>> iterator;
+public class JobItemCollection<T extends TypedData> extends TypedDataCollection<JobItem<T>> {
 
     public JobItemCollection() {
-        iterator = new TypedDataCollectionIterator<JobItem<T>>(this);
     }
 
     public JobItemCollection(List<JobItem<T>> items) {
@@ -34,17 +28,4 @@ public List<JobItem<T>> getPage() {
     public JobItemCollection<T> nextPage() {
         return fetchNextPage(JobItemCollection.class);
     }
-
-    public boolean hasNext() {
-        return iterator.hasNext();
-    }
-
-    public JobItem<T> next() {
-        return iterator.next();
-    }
-
-    public void remove() {
-        iterator.remove();
-    }
-
 }

intercom-java/src/main/java/io/intercom/api/NoteCollection.java

@@ -3,17 +3,14 @@
 import com.fasterxml.jackson.annotation.JsonIgnoreProperties;
 import com.fasterxml.jackson.annotation.JsonProperty;
 
-import java.util.Iterator;
 import java.util.List;
 
 @SuppressWarnings("UnusedDeclaration")
 @JsonIgnoreProperties(ignoreUnknown = true)
-public class NoteCollection extends TypedDataCollection<Note> implements Iterator<Note> {
+public class NoteCollection extends TypedDataCollection<Note> {
 
-    protected TypedDataCollectionIterator<Note> iterator;
 
     public NoteCollection() {
-        iterator = new TypedDataCollectionIterator<Note>(this);
     }
 
     @Override
@@ -27,17 +24,4 @@ public NoteCollection nextPage() {
     public List<Note> getPage() {
         return super.getPage();
     }
-
-    public boolean hasNext() {
-        return iterator.hasNext();
-    }
-
-    public Note next() {
-        return iterator.next();
-    }
-
-    public void remove() {
-        iterator.remove();
-    }
-
 }

intercom-java/src/main/java/io/intercom/api/NotificationCollection.java

@@ -3,18 +3,15 @@
 import com.fasterxml.jackson.annotation.JsonIgnoreProperties;
 import com.fasterxml.jackson.annotation.JsonProperty;
 
-import java.util.Iterator;
 import java.util.List;
 
 @SuppressWarnings("UnusedDeclaration")
 @JsonIgnoreProperties(ignoreUnknown = true)
-public class NotificationCollection extends TypedDataCollection<Notification> implements Iterator<Notification> {
+public class NotificationCollection extends TypedDataCollection<Notification> {
 
-    protected TypedDataCollectionIterator<Notification> iterator;
 
     public NotificationCollection() {
         type = "notification.list";
-        iterator = new TypedDataCollectionIterator<Notification>(this);
     }
 
     @Override
@@ -28,17 +25,4 @@ public NotificationCollection nextPage() {
     public List<Notification> getPage() {
         return super.getPage();
     }
-
-    public boolean hasNext() {
-        return iterator.hasNext();
-    }
-
-    public Notification next() {
-        return iterator.next();
-    }
-
-    public void remove() {
-        iterator.remove();
-    }
-
 }

intercom-java/src/main/java/io/intercom/api/NotificationErrorCollection.java

@@ -3,18 +3,14 @@
 import com.fasterxml.jackson.annotation.JsonIgnoreProperties;
 import com.fasterxml.jackson.annotation.JsonProperty;
 
-import java.util.Iterator;
 import java.util.List;
 
 @SuppressWarnings("UnusedDeclaration")
 @JsonIgnoreProperties(ignoreUnknown = true)
-public class NotificationErrorCollection extends TypedDataCollection<NotificationError> implements Iterator<NotificationError> {
-
-    protected TypedDataCollectionIterator<NotificationError> iterator;
+public class NotificationErrorCollection extends TypedDataCollection<NotificationError> {
 
     public NotificationErrorCollection() {
         type = "notification.list";
-        iterator = new TypedDataCollectionIterator<NotificationError>(this);
     }
 
     @SuppressWarnings("EmptyMethod")
@@ -28,16 +24,4 @@ public List<NotificationError> getPage() {
     public NotificationErrorCollection nextPage() {
         return fetchNextPage(NotificationErrorCollection.class);
     }
-
-    public boolean hasNext() {
-        return iterator.hasNext();
-    }
-
-    public NotificationError next() {
-        return iterator.next();
-    }
-
-    public void remove() {
-        iterator.remove();
-    }
 }

intercom-java/src/main/java/io/intercom/api/SegmentCollection.java

@@ -4,19 +4,15 @@
 import com.fasterxml.jackson.annotation.JsonInclude;
 import com.fasterxml.jackson.annotation.JsonProperty;
 
-import java.util.Iterator;
 import java.util.List;
 
 @SuppressWarnings("UnusedDeclaration")
 @JsonIgnoreProperties(ignoreUnknown = true)
 @JsonInclude(JsonInclude.Include.NON_EMPTY)
-public class SegmentCollection extends TypedDataCollection<Segment> implements Iterator<Segment> {
-
-    protected TypedDataCollectionIterator<Segment> iterator;
+public class SegmentCollection extends TypedDataCollection<Segment> {
 
     public SegmentCollection() {
         type = "segment.list";
-        iterator = new TypedDataCollectionIterator<Segment>(this);
     }
 
     @Override
@@ -31,21 +27,9 @@ public List<Segment> getPage() {
         return super.getPage();
     }
 
-    public boolean hasNext() {
-        return iterator.hasNext();
-    }
-
-    public Segment next() {
-        return iterator.next();
-    }
-
-    public void remove() {
-        iterator.remove();
-    }
-
     @Override
     public String toString() {
         return "SegmentCollection{" +
-            "} " + super.toString();
+                "} " + super.toString();
     }
 }