Package com.restfb

Class Parameter

java.lang.Object
com.restfb.Parameter

public final class Parameter extends Object
Representation of a Facebook API request parameter.
Author:
Mark Allen
  • Field Details

  • Method Details

    • with

      public static Parameter with(String name, Object value)
      Factory method which provides an instance with the given name and value.

      The value parameter is often a String or primitive type like Integer, but you may pass in a List, Map, or your own @Facebook-annotated Javabean and it will be converted to JSON automatically. See the "attachment" section of the stream.publish API documentation for an example of where this is useful.

      Parameters:
      name - The parameter name.
      value - The parameter value.
      Returns:
      A Parameter instance with the given name and value.
      Throws:
      IllegalArgumentException - If name or value is null or a blank string.
      FacebookJsonMappingException - If an error occurs when converting value to JSON.
    • withFields

      public static Parameter withFields(String fieldList)
      convenience factory method which needs a comma separated list of fields that the dev likes to fetch from the API
      Parameters:
      fieldList - comma separated list of fields
      Returns:
      Parameter object
    • withMetadata

      public static Parameter withMetadata()
      convenience factory method which creates a Parameter object to fetch the metadata from API
      Returns:
      Parameter object
    • withLocale

      public static Parameter withLocale(Locale locale)
      convenience factory method which creates a Parameter object to fetch data from API with given locale
      Parameters:
      locale - the locale that should be used to fetch the data
      Returns:
      Parameter object
    • with

      public static Parameter with(String name, Object value, JsonMapper jsonMapper)
      Factory method which provides an instance with the given name and value, using the provided jsonMapper to turn value into a JSON string.

      The value parameter is often a String or primitive type like Integer, but you may pass in a List, Map, or your own @Facebook-annotated Javabean and it will be converted to JSON automatically. See the "attachment" section of the stream.publish API documentation for an example of where this is useful.

      Parameters:
      name - The parameter name.
      value - The parameter value.
      jsonMapper - The jsonMapper
      Returns:
      A Parameter instance with the given name and value.
      Throws:
      IllegalArgumentException - If name or value is null or a blank string.
      FacebookJsonMappingException - If an error occurs when converting value to JSON.
    • equals

      public boolean equals(Object obj)
      Overrides:
      equals in class Object
      See Also:
    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object
    • toString

      public String toString()
      Overrides:
      toString in class Object