// Generated by delombok at Tue Dec 10 13:42:03 UTC 2024
/*
 * Copyright (c) 2010-2024 Mark Allen, Norbert Bartels.
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to deal
 * in the Software without restriction, including without limitation the rights
 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 * copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in
 * all copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
 * THE SOFTWARE.
 */
package com.restfb.types;

import static java.util.Collections.unmodifiableList;
import java.util.ArrayList;
import java.util.Date;
import java.util.List;
import com.restfb.Connection;
import com.restfb.Facebook;
import com.restfb.JsonMapper;
import com.restfb.JsonMapper.JsonMappingCompleted;
import com.restfb.annotation.GraphAPI;
import com.restfb.exception.FacebookJsonMappingException;
import com.restfb.json.JsonObject;
import com.restfb.types.features.HasComments;
import com.restfb.types.features.HasCreatedTime;

/**
 * Represents the <a href="https://developers.facebook.com/docs/graph-api/reference/photo/">Photo Graph API type</a>.
 * 
 * @author <a href="http://restfb.com">Mark Allen</a>
 * @since 1.5
 */
public class Photo extends NamedFacebookType implements HasComments, HasCreatedTime {
  /**
   * An object containing the name and ID of the user who posted the photo.
   * 
   */
  @Facebook
  private From from;
  /**
   * The album-sized view of the photo.
   * 
   */
  @Facebook
  private String picture;
  /**
   * ID of the page story this corresponds to.
   *
   * May not be on all photos. Applies only to published photos
   *
   */
  @Facebook("page_story_id")
  private String pageStoryId;
  /**
   * The reactions for this photo.
   *
   */
  @Facebook
  private Reactions reactions;
  /**
   * The full-sized source of the photo.
   * 
   * @deprecated Use <code>images</code> field instead
   */
  @Facebook
  @Deprecated
  private String source;
  /**
   * The height of the photo, in pixels.
   * 
   */
  @Facebook
  private Integer height;
  /**
   * The width of the photo, in pixels.
   * 
   */
  @Facebook
  private Integer width;
  /**
   * A link to the photo on Facebook.
   * 
   */
  @Facebook
  private String link;
  /**
   * The icon-sized source of the photo.
   * 
   */
  @Facebook
  private String icon;
  /**
   * The album this photo is in
   *
   */
  @Facebook
  private Album album;
  /**
   * A boolean indicating if the viewer can delete the photo
   *
   */
  @Facebook("can_delete")
  private Boolean canDelete;
  /**
   * A boolean indicating if the viewer can tag the photo
   *
   */
  @Facebook("can_tag")
  private Boolean canTag;
  /**
   * The position of this photo in the album.
   * 
   * @since 1.6.5
   * @deprecated Facebook will start returning 0 for this field starting on October 3, 2012.
   */
  @Deprecated
  @Facebook
  private Integer position;
  /**
   * If this object has a place, the event associated with the place
   *
   */
  @Facebook
  @GraphAPI(since = "2.3")
  private Event event;
  /**
   * The last time the photo or its caption was updated.
   * 
   */
  @Facebook("updated_time")
  private Date updatedTime;
  /**
   * The time the photo was initially published.
   * 
   */
  @Facebook("created_time")
  private Date createdTime;
  /**
   * All of the comments on this photo.
   *
   * @since 1.6.5
   */
  @Facebook
  private Comments comments;
  @Facebook
  private List<Tag> tags = new ArrayList<>();
  @Facebook
  private Likes likes;
  @Facebook
  private List<Image> images = new ArrayList<>();
  @Facebook("name_tags")
  private transient String rawNameTags;
  private List<EntityAtTextRange> nameTags = new ArrayList<>();
  /**
   * The location associated with this photo, if any.
   * 
   * @since 1.6.10
   */
  @Facebook
  private Place place;
  /**
   * Back dated time
   * 
   * @since 1.6.15
   */
  @Facebook("backdated_time")
  private Date backdatedTime;
  /**
   * String that represents the back dated time granularity
   * 
   * @since 1.6.15
   */
  @Facebook("backdated_time_granularity")
  private String backdatedTimeGranularity;
  @Facebook
  private Connection<Insight> insights;
  private static final long serialVersionUID = 1L;


  /**
   * Represents the <a href="http://developers.facebook.com/docs/reference/api/photo">Tag Graph API type</a>.
   * 
   * @author <a href="http://restfb.com">Mark Allen</a>
   * @since 1.5
   */
  public static class Tag extends NamedFacebookType implements HasCreatedTime {
    /**
     * X coordinate (as a percentage of distance from left vs. width).
     * 
     */
    @Facebook
    private Double x;
    /**
     * Y coordinate (as a percentage of distance from top vs. height).
     * 
     */
    @Facebook
    private Double y;
    /**
     * Date this tag was created.
     * 
     */
    @Facebook("created_time")
    private Date createdTime;
    private static final long serialVersionUID = 1L;

    /**
     * X coordinate (as a percentage of distance from left vs. width).
     * 
     * @return X coordinate (as a percentage of distance from left vs. width).
     */
    @java.lang.SuppressWarnings("all")
    public Double getX() {
      return this.x;
    }

    /**
     * X coordinate (as a percentage of distance from left vs. width).
     * 
     */
    @java.lang.SuppressWarnings("all")
    public void setX(final Double x) {
      this.x = x;
    }

    /**
     * Y coordinate (as a percentage of distance from top vs. height).
     * 
     * @return Y coordinate (as a percentage of distance from top vs. height).
     */
    @java.lang.SuppressWarnings("all")
    public Double getY() {
      return this.y;
    }

    /**
     * Y coordinate (as a percentage of distance from top vs. height).
     * 
     */
    @java.lang.SuppressWarnings("all")
    public void setY(final Double y) {
      this.y = y;
    }

    /**
     * Date this tag was created.
     * 
     * @return Date this tag was created.
     */
    @Override
    @java.lang.SuppressWarnings("all")
    public Date getCreatedTime() {
      return this.createdTime;
    }

    /**
     * Date this tag was created.
     * 
     */
    @java.lang.SuppressWarnings("all")
    public void setCreatedTime(final Date createdTime) {
      this.createdTime = createdTime;
    }
  }


  /**
   * Represents the <a href="http://developers.facebook.com/docs/reference/api/photo">Image Graph API type</a>.
   * 
   * @author <a href="http://restfb.com">Mark Allen</a>
   * @since 1.6.5
   */
  public static class Image extends AbstractFacebookType {
    /**
     * The height of the image in pixels.
     * 
     */
    @Facebook
    private Integer height;
    /**
     * The width of the image in pixels.
     * 
     */
    @Facebook
    private Integer width;
    /**
     * The source URL of the image.
     * 
     */
    @Facebook
    private String source;
    private static final long serialVersionUID = 1L;

    /**
     * The height of the image in pixels.
     * 
     * @return The height of the image in pixels.
     */
    @java.lang.SuppressWarnings("all")
    public Integer getHeight() {
      return this.height;
    }

    /**
     * The height of the image in pixels.
     * 
     */
    @java.lang.SuppressWarnings("all")
    public void setHeight(final Integer height) {
      this.height = height;
    }

    /**
     * The width of the image in pixels.
     * 
     * @return The width of the image in pixels.
     */
    @java.lang.SuppressWarnings("all")
    public Integer getWidth() {
      return this.width;
    }

    /**
     * The width of the image in pixels.
     * 
     */
    @java.lang.SuppressWarnings("all")
    public void setWidth(final Integer width) {
      this.width = width;
    }

    /**
     * The source URL of the image.
     * 
     * @return The source URL of the image.
     */
    @java.lang.SuppressWarnings("all")
    public String getSource() {
      return this.source;
    }

    /**
     * The source URL of the image.
     * 
     */
    @java.lang.SuppressWarnings("all")
    public void setSource(final String source) {
      this.source = source;
    }
  }

  /**
   * An array containing the users and their positions in this photo. The x and y coordinates are percentages from the
   * left and top edges of the photo, respectively.
   * 
   * @return An array containing the users and their positions in this photo. The x and y coordinates are percentages
   *         from the left and top edges of the photo, respectively.
   */
  public List<Tag> getTags() {
    return unmodifiableList(tags);
  }

  public boolean addTag(Tag tag) {
    return tags.add(tag);
  }

  public boolean removeTag(Tag tag) {
    return tags.remove(tag);
  }

  public List<EntityAtTextRange> getNameTags() {
    return unmodifiableList(nameTags);
  }

  public boolean addNameTag(EntityAtTextRange nameTag) {
    return nameTags.add(nameTag);
  }

  public boolean removeNameTag(EntityAtTextRange nameTag) {
    return nameTags.remove(nameTag);
  }

  /**
   * The 4 different stored representations of the photo.
   * 
   * @return The 4 different stored representations of the photo.
   * @since 1.6.5
   */
  public List<Image> getImages() {
    return unmodifiableList(images);
  }

  public boolean addImage(Image image) {
    return images.add(image);
  }

  public boolean removeImage(Image image) {
    return images.remove(image);
  }

  /**
   * Post-JSON-mapping operation that populates the {@code messageTags} field "by hand".
   *
   * @param jsonMapper
   *          The {@code JsonMapper} that was used to map to this type.
   */
  @JsonMappingCompleted
  protected void jsonMappingCompleted(JsonMapper jsonMapper) {
    if (rawNameTags == null) {
      return;
    }
    try {
      nameTags = jsonMapper.toJavaList(rawNameTags, EntityAtTextRange.class);
      return;
    } catch (FacebookJsonMappingException je) {
    }
    // message tags not in Graph API 2.5 format, ignore this exception and try another way
    try {
      JsonObject rawMessageTagsObject = jsonMapper.toJavaObject(rawNameTags, JsonObject.class);
      for (String key : rawMessageTagsObject.names()) {
        String tagArrayString = rawMessageTagsObject.get(key).toString();
        nameTags.addAll(jsonMapper.toJavaList(tagArrayString, EntityAtTextRange.class));
      }
    } catch (FacebookJsonMappingException je) {
    }
    // cannot parse message tags, but don't break the flow here
  }

  /**
   * An object containing the name and ID of the user who posted the photo.
   * 
   * @return An object containing the name and ID of the user who posted the photo.
   */
  @java.lang.SuppressWarnings("all")
  public From getFrom() {
    return this.from;
  }

  /**
   * An object containing the name and ID of the user who posted the photo.
   * 
   */
  @java.lang.SuppressWarnings("all")
  public void setFrom(final From from) {
    this.from = from;
  }

  /**
   * The album-sized view of the photo.
   * 
   * @return The album-sized view of the photo.
   */
  @java.lang.SuppressWarnings("all")
  public String getPicture() {
    return this.picture;
  }

  /**
   * The album-sized view of the photo.
   * 
   */
  @java.lang.SuppressWarnings("all")
  public void setPicture(final String picture) {
    this.picture = picture;
  }

  /**
   * ID of the page story this corresponds to.
   *
   * May not be on all photos. Applies only to published photos
   *
   * @return ID of the page story this corresponds to.
   */
  @java.lang.SuppressWarnings("all")
  public String getPageStoryId() {
    return this.pageStoryId;
  }

  /**
   * ID of the page story this corresponds to.
   *
   * May not be on all photos. Applies only to published photos
   *
   */
  @java.lang.SuppressWarnings("all")
  public void setPageStoryId(final String pageStoryId) {
    this.pageStoryId = pageStoryId;
  }

  /**
   * The reactions for this photo.
   *
   * @return The reactions for this photo.
   */
  @java.lang.SuppressWarnings("all")
  public Reactions getReactions() {
    return this.reactions;
  }

  /**
   * The reactions for this photo.
   *
   */
  @java.lang.SuppressWarnings("all")
  public void setReactions(final Reactions reactions) {
    this.reactions = reactions;
  }

  /**
   * The full-sized source of the photo.
   * 
   * @return The full-sized source of the photo.
   * @deprecated Use <code>images</code> field instead
   */
  @java.lang.Deprecated
  @java.lang.SuppressWarnings("all")
  public String getSource() {
    return this.source;
  }

  /**
   * The full-sized source of the photo.
   * 
   * @deprecated Use <code>images</code> field instead
   */
  @java.lang.Deprecated
  @java.lang.SuppressWarnings("all")
  public void setSource(final String source) {
    this.source = source;
  }

  /**
   * The height of the photo, in pixels.
   * 
   * @return The height of the photo, in pixels.
   */
  @java.lang.SuppressWarnings("all")
  public Integer getHeight() {
    return this.height;
  }

  /**
   * The height of the photo, in pixels.
   * 
   */
  @java.lang.SuppressWarnings("all")
  public void setHeight(final Integer height) {
    this.height = height;
  }

  /**
   * The width of the photo, in pixels.
   * 
   * @return The width of the photo, in pixels.
   */
  @java.lang.SuppressWarnings("all")
  public Integer getWidth() {
    return this.width;
  }

  /**
   * The width of the photo, in pixels.
   * 
   */
  @java.lang.SuppressWarnings("all")
  public void setWidth(final Integer width) {
    this.width = width;
  }

  /**
   * A link to the photo on Facebook.
   * 
   * @return A link to the photo on Facebook.
   */
  @java.lang.SuppressWarnings("all")
  public String getLink() {
    return this.link;
  }

  /**
   * A link to the photo on Facebook.
   * 
   */
  @java.lang.SuppressWarnings("all")
  public void setLink(final String link) {
    this.link = link;
  }

  /**
   * The icon-sized source of the photo.
   * 
   * @return The icon-sized source of the photo.
   */
  @java.lang.SuppressWarnings("all")
  public String getIcon() {
    return this.icon;
  }

  /**
   * The icon-sized source of the photo.
   * 
   */
  @java.lang.SuppressWarnings("all")
  public void setIcon(final String icon) {
    this.icon = icon;
  }

  /**
   * The album this photo is in
   *
   * @return The album this photo is in
   */
  @java.lang.SuppressWarnings("all")
  public Album getAlbum() {
    return this.album;
  }

  /**
   * The album this photo is in
   *
   */
  @java.lang.SuppressWarnings("all")
  public void setAlbum(final Album album) {
    this.album = album;
  }

  /**
   * A boolean indicating if the viewer can delete the photo
   *
   * @return A boolean indicating if the viewer can delete the photo
   */
  @java.lang.SuppressWarnings("all")
  public Boolean getCanDelete() {
    return this.canDelete;
  }

  /**
   * A boolean indicating if the viewer can delete the photo
   *
   */
  @java.lang.SuppressWarnings("all")
  public void setCanDelete(final Boolean canDelete) {
    this.canDelete = canDelete;
  }

  /**
   * A boolean indicating if the viewer can tag the photo
   *
   * @return A boolean indicating if the viewer can tag the photo
   */
  @java.lang.SuppressWarnings("all")
  public Boolean getCanTag() {
    return this.canTag;
  }

  /**
   * A boolean indicating if the viewer can tag the photo
   *
   */
  @java.lang.SuppressWarnings("all")
  public void setCanTag(final Boolean canTag) {
    this.canTag = canTag;
  }

  /**
   * The position of this photo in the album.
   * 
   * @return The position of this photo in the album.
   * @since 1.6.5
   * @deprecated Facebook will start returning 0 for this field starting on October 3, 2012.
   */
  @java.lang.Deprecated
  @java.lang.SuppressWarnings("all")
  public Integer getPosition() {
    return this.position;
  }

  /**
   * The position of this photo in the album.
   * 
   * @since 1.6.5
   * @deprecated Facebook will start returning 0 for this field starting on October 3, 2012.
   */
  @java.lang.Deprecated
  @java.lang.SuppressWarnings("all")
  public void setPosition(final Integer position) {
    this.position = position;
  }

  /**
   * If this object has a place, the event associated with the place
   *
   * @return If this object has a place, the event associated with the place
   */
  @GraphAPI(since = "2.3")
  @java.lang.SuppressWarnings("all")
  public Event getEvent() {
    return this.event;
  }

  /**
   * If this object has a place, the event associated with the place
   *
   */
  @java.lang.SuppressWarnings("all")
  public void setEvent(final Event event) {
    this.event = event;
  }

  /**
   * The last time the photo or its caption was updated.
   * 
   * @return The last time the photo or its caption was updated.
   */
  @java.lang.SuppressWarnings("all")
  public Date getUpdatedTime() {
    return this.updatedTime;
  }

  /**
   * The last time the photo or its caption was updated.
   * 
   */
  @java.lang.SuppressWarnings("all")
  public void setUpdatedTime(final Date updatedTime) {
    this.updatedTime = updatedTime;
  }

  /**
   * The time the photo was initially published.
   * 
   * @return The time the photo was initially published.
   */
  @Override
  @java.lang.SuppressWarnings("all")
  public Date getCreatedTime() {
    return this.createdTime;
  }

  /**
   * The time the photo was initially published.
   * 
   */
  @java.lang.SuppressWarnings("all")
  public void setCreatedTime(final Date createdTime) {
    this.createdTime = createdTime;
  }

  /**
   * All of the comments on this photo.
   *
   * @return All of the comments on this photo.
   * @since 1.6.5
   */
  @Override
  @java.lang.SuppressWarnings("all")
  public Comments getComments() {
    return this.comments;
  }

  /**
   * All of the comments on this photo.
   *
   * @since 1.6.5
   */
  @java.lang.SuppressWarnings("all")
  public void setComments(final Comments comments) {
    this.comments = comments;
  }

  @java.lang.SuppressWarnings("all")
  public Likes getLikes() {
    return this.likes;
  }

  @java.lang.SuppressWarnings("all")
  public void setLikes(final Likes likes) {
    this.likes = likes;
  }

  /**
   * The location associated with this photo, if any.
   * 
   * @return The place this photo was taken.
   * @since 1.6.10
   */
  @java.lang.SuppressWarnings("all")
  public Place getPlace() {
    return this.place;
  }

  /**
   * The location associated with this photo, if any.
   * 
   * @since 1.6.10
   */
  @java.lang.SuppressWarnings("all")
  public void setPlace(final Place place) {
    this.place = place;
  }

  /**
   * Back dated time
   * 
   * @return the back dated time
   * @since 1.6.15
   */
  @java.lang.SuppressWarnings("all")
  public Date getBackdatedTime() {
    return this.backdatedTime;
  }

  /**
   * Back dated time
   * 
   * @since 1.6.15
   */
  @java.lang.SuppressWarnings("all")
  public void setBackdatedTime(final Date backdatedTime) {
    this.backdatedTime = backdatedTime;
  }

  /**
   * String that represents the back dated time granularity
   * 
   * @return the back dated time granularity
   * @since 1.6.15
   */
  @java.lang.SuppressWarnings("all")
  public String getBackdatedTimeGranularity() {
    return this.backdatedTimeGranularity;
  }

  /**
   * String that represents the back dated time granularity
   * 
   * @since 1.6.15
   */
  @java.lang.SuppressWarnings("all")
  public void setBackdatedTimeGranularity(final String backdatedTimeGranularity) {
    this.backdatedTimeGranularity = backdatedTimeGranularity;
  }

  @java.lang.SuppressWarnings("all")
  public Connection<Insight> getInsights() {
    return this.insights;
  }

  @java.lang.SuppressWarnings("all")
  public void setInsights(final Connection<Insight> insights) {
    this.insights = insights;
  }
}