se.walkercrou.places.Photo Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of google-places-api-java Show documentation

Comprehensive and FULL Java client for the Google Places API

There is a newer version: 2.1.7

Show newest version

package se.walkercrou.places;

import se.walkercrou.places.exception.GooglePlacesException;

import javax.imageio.ImageIO;
import java.awt.image.BufferedImage;
import java.io.InputStream;

import static se.walkercrou.places.GooglePlaces.MAX_PHOTO_SIZE;

/**
 * Represents a referenced photo.
 */
public class Photo {
    private final Place place;
    private final String reference;
    private final int width, height;
    private InputStream image;

    protected Photo(Place place, String reference, int width, int height) {
        this.place = place;
        this.reference = reference;
        this.width = width;
        this.height = height;
    }

    /**
     * Downloads the photo and caches it within the photo.
     *
     * @param maxWidth    of photo
     * @param maxHeight   of photo
     * @param extraParams to append to request url
     * @return this
     */
    public Photo download(int maxWidth, int maxHeight, Param... extraParams) {
        image = place.getClient().downloadPhoto(this, maxWidth, maxHeight, extraParams);
        return this;
    }

    /**
     * Downloads the photo and caches it within the photo.
     *
     * @param extraParams to append to request url
     * @return this
     */
    public Photo download(Param... extraParams) {
        return download(MAX_PHOTO_SIZE, MAX_PHOTO_SIZE, extraParams);
    }

    /**
     * Returns the input stream of the image. {@link #download(int, int, Param...)}
     * must be called prior to calling this.
     *
     * @return input stream
     */
    public InputStream getInputStream() {
        return image;
    }

    /**
     * Returns an Image from the specified photo reference.
     *
     * @return image
     */
    public BufferedImage getImage() {
        try {
            return ImageIO.read(image);
        } catch (Exception e) {
            throw new GooglePlacesException(e);
        }
    }

    /**
     * Returns the reference token to the photo.
     *
     * @return reference token
     */
    public String getReference() {
        return reference;
    }

    /**
     * Returns the width of the photo.
     *
     * @return photo width
     */
    public int getWidth() {
        return width;
    }

    /**
     * Returns the height of the photo.
     *
     * @return photo height
     */
    public int getHeight() {
        return height;
    }
}