Package com.restfb

Class Connection<T>

java.lang.Object
com.restfb.Connection<T>
Type Parameters:
T - The Facebook type
All Implemented Interfaces:
Iterable<List<T>>
public class Connection<T> extends Object implements Iterable<List<T>>
Represents a Graph API Connection type.
Author:
Mark Allen

  • Constructor Details

    • Connection

      public Connection(FacebookClient facebookClient, String json, Class<T> connectionType)
      Creates a connection with the given jsonObject.
      Parameters:
      facebookClient - The FacebookClient used to fetch additional pages and map data to JSON objects.
      json - Raw JSON which must include a data field that holds a JSON array and optionally a paging field that holds a JSON object with next/previous page URLs.
      connectionType - Connection type token.
      Throws:
      FacebookJsonMappingException - If the provided json is invalid.
      Since:
      1.6.7

  • Method Details

    • iterator

      public ConnectionIterator<T> iterator()
      Specified by:
      iterator in interface Iterable<T>
      Since:
      1.6.7
      See Also:

    • fetchNextPage

      protected Connection<T> fetchNextPage()
      Fetches the next page of the connection. Designed to be used by Connection.Itr.
      Returns:
      The next page of the connection.
      Since:
      1.6.7

    • toString

      public String toString()
      Overrides:
      toString in class Object

    • equals

      public boolean equals(Object object)
      Overrides:
      equals in class Object

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object

    • getData

      public List<T> getData()
      Data for this connection.
      Returns:
      Data for this connection.

    • getPreviousPageUrl

      public String getPreviousPageUrl()
      This connection's "previous page of data" URL.
      Returns:
      This connection's "previous page of data" URL, or null if there is no previous page.
      Since:
      1.5.3

    • getNextPageUrl

      public String getNextPageUrl()
      This connection's "next page of data" URL.
      Returns:
      This connection's "next page of data" URL, or null if there is no next page.
      Since:
      1.5.3

    • hasPrevious

      public boolean hasPrevious()
      Does this connection have a previous page of data?
      Returns:
      true if there is a previous page of data for this connection, false otherwise.

    • hasNext

      public boolean hasNext()
      Does this connection have a next page of data?
      Returns:
      true if there is a next page of data for this connection, false otherwise.

    • getTotalCount

      public Long getTotalCount()
      provides the total count of elements, if FB provides them (API ≥ v2.0)
      Returns:
      the total count of elements if present
      Since:
      1.6.16

    • getOrder

      public String getOrder()
      returns the order of the elements
      Returns:
      the order of the elements

    • getBeforeCursor

      public String getBeforeCursor()

    • getAfterCursor

      public String getAfterCursor()

    • getTypedSummary

      public T getTypedSummary()
      return the typed summary.

      For some connections, there is summary object that contains almost the same fields as the type that is used in the connection. For example ad insights fill the summary that way (if you use the right query parameter)

      Returns:
      the typed summary, may be null

    • replaceFacebookClient

      public void replaceFacebookClient(FacebookClient facebookClient)
      replace the current facebookclient with the new one.
      Parameters:
      facebookClient - the new FacebookClient

    • getJson

      public String getJson()
      returns the JSON this connection is based on, it can be used for debug logs for example
      Returns:
      JSON as String the connection is based on

    • getResponseMetadata

      public ResponseMetadata getResponseMetadata()
      Returns the metadata of the response that created this Connection.
      Returns:
      response metadata or null if unavailable

    • setResponseMetadata

      public void setResponseMetadata(ResponseMetadata responseMetadata)
      Attaches response metadata to this connection.
      Parameters:
      responseMetadata - metadata captured while fetching the connection

    • setNextPageUrl

      public void setNextPageUrl(String nextPageUrl)
      Override the next page URL - use at your own risk
      Parameters:
      nextPageUrl - Custom next Page URL as String

    • setPreviousPageUrl

      public void setPreviousPageUrl(String previousPageUrl)
      Override the previous page URL - use at your own risk
      Parameters:
      previousPageUrl - Custom previous Page URL as String

    • getFacebookClient

      public FacebookClient getFacebookClient()
      fetch the currently used
      Returns:
      the used FacebookClient