2 * Sone - Image.java - Copyright © 2011–2016 David Roden
4 * This program is free software: you can redistribute it and/or modify
5 * it under the terms of the GNU General Public License as published by
6 * the Free Software Foundation, either version 3 of the License, or
7 * (at your option) any later version.
9 * This program is distributed in the hope that it will be useful,
10 * but WITHOUT ANY WARRANTY; without even the implied warranty of
11 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12 * GNU General Public License for more details.
14 * You should have received a copy of the GNU General Public License
15 * along with this program. If not, see <http://www.gnu.org/licenses/>.
18 package net.pterodactylus.sone.data;
21 * Container for image metadata.
23 * @author <a href="mailto:d.roden@xplosion.de">David Roden</a>
25 public interface Image extends Identified, Fingerprintable {
28 * Returns the ID of this image.
30 * @return The ID of this image
35 * Returns the Sone this image belongs to.
37 * @return The Sone this image belongs to
42 * Returns the album this image belongs to.
44 * @return The album this image belongs to
49 * Sets the album this image belongs to. The album of an image can only be
50 * set once, and it is usually called by {@link Album#addImage(Image)}.
53 * The album this image belongs to
56 Image setAlbum(Album album);
59 * Returns the request key of this image.
61 * @return The request key of this image
66 * Returns whether the image has already been inserted. An image is
67 * considered as having been inserted it its {@link #getKey() key} is not
70 * @return {@code true} if there is a key for this image, {@code false}
76 * Returns the creation time of this image.
78 * @return The creation time of this image (in milliseconds since 1970, Jan
81 long getCreationTime();
84 * Returns the width of this image.
86 * @return The width of this image (in pixels)
91 * Returns the height of this image.
93 * @return The height of this image (in pixels)
98 * Returns the title of this image.
100 * @return The title of this image
105 * Returns the description of this image.
107 * @return The description of this image
109 String getDescription();
115 String getFingerprint();
117 Modifier modify() throws IllegalStateException;
121 Modifier setSone(Sone sone);
123 Modifier setCreationTime(long creationTime);
125 Modifier setKey(String key);
127 Modifier setTitle(String title);
129 Modifier setDescription(String description);
131 Modifier setWidth(int width);
133 Modifier setHeight(int height);
135 Image update() throws IllegalStateException;
137 class ImageTitleMustNotBeEmpty extends IllegalStateException { }