X-Git-Url: https://git.pterodactylus.net/?a=blobdiff_plain;ds=sidebyside;f=src%2Fmain%2Fjava%2Fnet%2Fpterodactylus%2Fsone%2Fdata%2FSone.java;h=273b73e29f7ba3c61a96547d8ab088e5129412e6;hb=refs%2Ftags%2Fv79;hp=68c81141b01e611aa28382dcc3e63eb599500d70;hpb=c4ae226ec5052116cefc542ae2017036a7bc6332;p=Sone.git
diff --git a/src/main/java/net/pterodactylus/sone/data/Sone.java b/src/main/java/net/pterodactylus/sone/data/Sone.java
index 68c8114..273b73e 100644
--- a/src/main/java/net/pterodactylus/sone/data/Sone.java
+++ b/src/main/java/net/pterodactylus/sone/data/Sone.java
@@ -1,5 +1,5 @@
/*
- * Sone - Sone.java - Copyright © 2010â2016 David Roden
+ * Sone - Sone.java - Copyright © 2010â2019 David Roden
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
@@ -44,15 +44,11 @@ import com.google.common.primitives.Ints;
/**
* A Sone defines everything about a user: her profile, her status updates, her
* replies, her likes and dislikes, etc.
- *
- * @author David âBombeâ Roden
*/
public interface Sone extends Identified, Fingerprintable, Comparable {
/**
* Enumeration for the possible states of a {@link Sone}.
- *
- * @author David âBombeâ Roden
*/
public enum SoneStatus {
@@ -69,30 +65,6 @@ public interface Sone extends Identified, Fingerprintable, Comparable {
downloading,
}
- /**
- * The possible values for the âshow custom avatarsâ option.
- *
- * @author David âBombeâ Roden
- */
- public static enum ShowCustomAvatars {
-
- /** Never show custom avatars. */
- NEVER,
-
- /** Only show custom avatars of followed Sones. */
- FOLLOWED,
-
- /** Only show custom avatars of Sones you manually trust. */
- MANUALLY_TRUSTED,
-
- /** Only show custom avatars of automatically trusted Sones. */
- TRUSTED,
-
- /** Always show custom avatars. */
- ALWAYS,
-
- }
-
/** comparator that sorts Sones by their nice name. */
public static final Comparator NICE_NAME_COMPARATOR = new Comparator() {
@@ -193,6 +165,7 @@ public interface Sone extends Identified, Fingerprintable, Comparable {
*
* @return The identity of this Sone
*/
+ @Nonnull
Identity getIdentity();
/**
@@ -200,6 +173,7 @@ public interface Sone extends Identified, Fingerprintable, Comparable {
*
* @return The name of this Sone
*/
+ @Nonnull
String getName();
/**
@@ -214,6 +188,7 @@ public interface Sone extends Identified, Fingerprintable, Comparable {
*
* @return The request URI of this Sone
*/
+ @Nonnull
FreenetURI getRequestUri();
/**
@@ -221,6 +196,7 @@ public interface Sone extends Identified, Fingerprintable, Comparable {
*
* @return The insert URI of this Sone
*/
+ @Nullable
FreenetURI getInsertUri();
/**
@@ -254,6 +230,7 @@ public interface Sone extends Identified, Fingerprintable, Comparable {
* The time of the update (in milliseconds since Jan 1, 1970 UTC)
* @return This Sone (for method chaining)
*/
+ @Nonnull
Sone setTime(long time);
/**
@@ -261,6 +238,7 @@ public interface Sone extends Identified, Fingerprintable, Comparable {
*
* @return The status of this Sone
*/
+ @Nonnull
SoneStatus getStatus();
/**
@@ -272,7 +250,8 @@ public interface Sone extends Identified, Fingerprintable, Comparable {
* @throws IllegalArgumentException
* if {@code status} is {@code null}
*/
- Sone setStatus(SoneStatus status);
+ @Nonnull
+ Sone setStatus(@Nonnull SoneStatus status);
/**
* Returns a copy of the profile. If you want to update values in the profile
@@ -281,6 +260,7 @@ public interface Sone extends Identified, Fingerprintable, Comparable {
*
* @return A copy of the profile
*/
+ @Nonnull
Profile getProfile();
/**
@@ -291,13 +271,14 @@ public interface Sone extends Identified, Fingerprintable, Comparable {
* @param profile
* The profile to set
*/
- void setProfile(Profile profile);
+ void setProfile(@Nonnull Profile profile);
/**
* Returns the client used by this Sone.
*
* @return The client used by this Sone, or {@code null}
*/
+ @Nullable
Client getClient();
/**
@@ -307,7 +288,8 @@ public interface Sone extends Identified, Fingerprintable, Comparable {
* The client used by this Sone, or {@code null}
* @return This Sone (for method chaining)
*/
- Sone setClient(Client client);
+ @Nonnull
+ Sone setClient(@Nullable Client client);
/**
* Returns whether this Sone is known.
@@ -323,6 +305,7 @@ public interface Sone extends Identified, Fingerprintable, Comparable {
* {@code true} if this Sone is known, {@code false} otherwise
* @return This Sone
*/
+ @Nonnull
Sone setKnown(boolean known);
/**
@@ -330,6 +313,7 @@ public interface Sone extends Identified, Fingerprintable, Comparable {
*
* @return The friend Sones of this Sone
*/
+ @Nonnull
Collection getFriends();
/**
@@ -340,13 +324,14 @@ public interface Sone extends Identified, Fingerprintable, Comparable {
* @return {@code true} if this Sone has the given Sone as a friend, {@code
* false} otherwise
*/
- boolean hasFriend(String friendSoneId);
+ boolean hasFriend(@Nonnull String friendSoneId);
/**
* Returns the list of posts of this Sone, sorted by time, newest first.
*
* @return All posts of this Sone
*/
+ @Nonnull
List getPosts();
/**
@@ -356,7 +341,8 @@ public interface Sone extends Identified, Fingerprintable, Comparable {
* The new (and only) posts of this Sone
* @return This Sone (for method chaining)
*/
- Sone setPosts(Collection posts);
+ @Nonnull
+ Sone setPosts(@Nonnull Collection posts);
/**
* Adds the given post to this Sone. The post will not be added if its {@link
@@ -365,7 +351,7 @@ public interface Sone extends Identified, Fingerprintable, Comparable {
* @param post
* The post to add
*/
- void addPost(Post post);
+ void addPost(@Nonnull Post post);
/**
* Removes the given post from this Sone.
@@ -373,13 +359,14 @@ public interface Sone extends Identified, Fingerprintable, Comparable {
* @param post
* The post to remove
*/
- void removePost(Post post);
+ void removePost(@Nonnull Post post);
/**
* Returns all replies this Sone made.
*
* @return All replies this Sone made
*/
+ @Nonnull
Set getReplies();
/**
@@ -389,7 +376,8 @@ public interface Sone extends Identified, Fingerprintable, Comparable {
* The new (and only) replies of this Sone
* @return This Sone (for method chaining)
*/
- Sone setReplies(Collection replies);
+ @Nonnull
+ Sone setReplies(@Nonnull Collection replies);
/**
* Adds a reply to this Sone. If the given reply was not made by this Sone,
@@ -398,7 +386,7 @@ public interface Sone extends Identified, Fingerprintable, Comparable {
* @param reply
* The reply to add
*/
- void addReply(PostReply reply);
+ void addReply(@Nonnull PostReply reply);
/**
* Removes a reply from this Sone.
@@ -406,13 +394,14 @@ public interface Sone extends Identified, Fingerprintable, Comparable {
* @param reply
* The reply to remove
*/
- void removeReply(PostReply reply);
+ void removeReply(@Nonnull PostReply reply);
/**
* Returns the IDs of all liked posts.
*
* @return All liked postsâ IDs
*/
+ @Nonnull
Set getLikedPostIds();
/**
@@ -422,7 +411,8 @@ public interface Sone extends Identified, Fingerprintable, Comparable {
* All liked postsâ IDs
* @return This Sone (for method chaining)
*/
- Sone setLikePostIds(Set likedPostIds);
+ @Nonnull
+ Sone setLikePostIds(@Nonnull Set likedPostIds);
/**
* Checks whether the given post ID is liked by this Sone.
@@ -432,7 +422,7 @@ public interface Sone extends Identified, Fingerprintable, Comparable {
* @return {@code true} if this Sone likes the given post, {@code false}
* otherwise
*/
- boolean isLikedPostId(String postId);
+ boolean isLikedPostId(@Nonnull String postId);
/**
* Adds the given post ID to the list of posts this Sone likes.
@@ -441,22 +431,23 @@ public interface Sone extends Identified, Fingerprintable, Comparable {
* The ID of the post
* @return This Sone (for method chaining)
*/
- Sone addLikedPostId(String postId);
+ @Nonnull
+ Sone addLikedPostId(@Nonnull String postId);
/**
* Removes the given post ID from the list of posts this Sone likes.
*
* @param postId
* The ID of the post
- * @return This Sone (for method chaining)
*/
- Sone removeLikedPostId(String postId);
+ void removeLikedPostId(@Nonnull String postId);
/**
* Returns the IDs of all liked replies.
*
* @return All liked repliesâ IDs
*/
+ @Nonnull
Set getLikedReplyIds();
/**
@@ -466,7 +457,8 @@ public interface Sone extends Identified, Fingerprintable, Comparable {
* All liked repliesâ IDs
* @return This Sone (for method chaining)
*/
- Sone setLikeReplyIds(Set likedReplyIds);
+ @Nonnull
+ Sone setLikeReplyIds(@Nonnull Set likedReplyIds);
/**
* Checks whether the given reply ID is liked by this Sone.
@@ -476,7 +468,7 @@ public interface Sone extends Identified, Fingerprintable, Comparable {
* @return {@code true} if this Sone likes the given reply, {@code false}
* otherwise
*/
- boolean isLikedReplyId(String replyId);
+ boolean isLikedReplyId(@Nonnull String replyId);
/**
* Adds the given reply ID to the list of replies this Sone likes.
@@ -485,22 +477,23 @@ public interface Sone extends Identified, Fingerprintable, Comparable {
* The ID of the reply
* @return This Sone (for method chaining)
*/
- Sone addLikedReplyId(String replyId);
+ @Nonnull
+ Sone addLikedReplyId(@Nonnull String replyId);
/**
* Removes the given post ID from the list of replies this Sone likes.
*
* @param replyId
* The ID of the reply
- * @return This Sone (for method chaining)
*/
- Sone removeLikedReplyId(String replyId);
+ void removeLikedReplyId(@Nonnull String replyId);
/**
* Returns the root album that contains all visible albums of this Sone.
*
* @return The root album of this Sone
*/
+ @Nonnull
Album getRootAlbum();
/**
@@ -508,6 +501,7 @@ public interface Sone extends Identified, Fingerprintable, Comparable {
*
* @return The options of this Sone
*/
+ @Nonnull
SoneOptions getOptions();
/**
@@ -517,6 +511,6 @@ public interface Sone extends Identified, Fingerprintable, Comparable {
* The options of this Sone
*/
/* TODO - remove this method again, maybe add an option provider */
- void setOptions(SoneOptions options);
+ void setOptions(@Nonnull SoneOptions options);
}