projects
/
Sone.git
/ blobdiff
commit
grep
author
committer
pickaxe
?
search:
re
summary
|
shortlog
|
log
|
commit
|
commitdiff
|
tree
raw
|
inline
| side by side
Optimize some imports
[Sone.git]
/
src
/
main
/
java
/
net
/
pterodactylus
/
sone
/
data
/
Sone.java
diff --git
a/src/main/java/net/pterodactylus/sone/data/Sone.java
b/src/main/java/net/pterodactylus/sone/data/Sone.java
index
777660f
..
33b8edd
100644
(file)
--- a/
src/main/java/net/pterodactylus/sone/data/Sone.java
+++ b/
src/main/java/net/pterodactylus/sone/data/Sone.java
@@
-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.
/**
* A Sone defines everything about a user: her profile, her status updates, her
* replies, her likes and dislikes, etc.
- *
- * @author <a href="mailto:bombe@pterodactylus.net">David ‘Bombe’ Roden</a>
*/
public interface Sone extends Identified, Fingerprintable, Comparable<Sone> {
/**
* Enumeration for the possible states of a {@link Sone}.
*/
public interface Sone extends Identified, Fingerprintable, Comparable<Sone> {
/**
* Enumeration for the possible states of a {@link Sone}.
- *
- * @author <a href="mailto:bombe@pterodactylus.net">David ‘Bombe’ Roden</a>
*/
public enum SoneStatus {
*/
public enum SoneStatus {
@@
-169,6
+165,7
@@
public interface Sone extends Identified, Fingerprintable, Comparable<Sone> {
*
* @return The identity of this Sone
*/
*
* @return The identity of this Sone
*/
+ @Nonnull
Identity getIdentity();
/**
Identity getIdentity();
/**
@@
-176,6
+173,7
@@
public interface Sone extends Identified, Fingerprintable, Comparable<Sone> {
*
* @return The name of this Sone
*/
*
* @return The name of this Sone
*/
+ @Nonnull
String getName();
/**
String getName();
/**
@@
-190,6
+188,7
@@
public interface Sone extends Identified, Fingerprintable, Comparable<Sone> {
*
* @return The request URI of this Sone
*/
*
* @return The request URI of this Sone
*/
+ @Nonnull
FreenetURI getRequestUri();
/**
FreenetURI getRequestUri();
/**
@@
-197,6
+196,7
@@
public interface Sone extends Identified, Fingerprintable, Comparable<Sone> {
*
* @return The insert URI of this Sone
*/
*
* @return The insert URI of this Sone
*/
+ @Nullable
FreenetURI getInsertUri();
/**
FreenetURI getInsertUri();
/**
@@
-230,6
+230,7
@@
public interface Sone extends Identified, Fingerprintable, Comparable<Sone> {
* The time of the update (in milliseconds since Jan 1, 1970 UTC)
* @return This Sone (for method chaining)
*/
* The time of the update (in milliseconds since Jan 1, 1970 UTC)
* @return This Sone (for method chaining)
*/
+ @Nonnull
Sone setTime(long time);
/**
Sone setTime(long time);
/**
@@
-237,6
+238,7
@@
public interface Sone extends Identified, Fingerprintable, Comparable<Sone> {
*
* @return The status of this Sone
*/
*
* @return The status of this Sone
*/
+ @Nonnull
SoneStatus getStatus();
/**
SoneStatus getStatus();
/**
@@
-248,7
+250,8
@@
public interface Sone extends Identified, Fingerprintable, Comparable<Sone> {
* @throws IllegalArgumentException
* if {@code status} is {@code null}
*/
* @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
/**
* Returns a copy of the profile. If you want to update values in the profile
@@
-257,6
+260,7
@@
public interface Sone extends Identified, Fingerprintable, Comparable<Sone> {
*
* @return A copy of the profile
*/
*
* @return A copy of the profile
*/
+ @Nonnull
Profile getProfile();
/**
Profile getProfile();
/**
@@
-267,13
+271,14
@@
public interface Sone extends Identified, Fingerprintable, Comparable<Sone> {
* @param profile
* The profile to set
*/
* @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}
*/
/**
* Returns the client used by this Sone.
*
* @return The client used by this Sone, or {@code null}
*/
+ @Nullable
Client getClient();
/**
Client getClient();
/**
@@
-283,7
+288,8
@@
public interface Sone extends Identified, Fingerprintable, Comparable<Sone> {
* The client used by this Sone, or {@code null}
* @return This Sone (for method chaining)
*/
* 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.
/**
* Returns whether this Sone is known.
@@
-299,6
+305,7
@@
public interface Sone extends Identified, Fingerprintable, Comparable<Sone> {
* {@code true} if this Sone is known, {@code false} otherwise
* @return This Sone
*/
* {@code true} if this Sone is known, {@code false} otherwise
* @return This Sone
*/
+ @Nonnull
Sone setKnown(boolean known);
/**
Sone setKnown(boolean known);
/**
@@
-306,6
+313,7
@@
public interface Sone extends Identified, Fingerprintable, Comparable<Sone> {
*
* @return The friend Sones of this Sone
*/
*
* @return The friend Sones of this Sone
*/
+ @Nonnull
Collection<String> getFriends();
/**
Collection<String> getFriends();
/**
@@
-316,13
+324,14
@@
public interface Sone extends Identified, Fingerprintable, Comparable<Sone> {
* @return {@code true} if this Sone has the given Sone as a friend, {@code
* false} otherwise
*/
* @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
*/
/**
* Returns the list of posts of this Sone, sorted by time, newest first.
*
* @return All posts of this Sone
*/
+ @Nonnull
List<Post> getPosts();
/**
List<Post> getPosts();
/**
@@
-332,7
+341,8
@@
public interface Sone extends Identified, Fingerprintable, Comparable<Sone> {
* The new (and only) posts of this Sone
* @return This Sone (for method chaining)
*/
* The new (and only) posts of this Sone
* @return This Sone (for method chaining)
*/
- Sone setPosts(Collection<Post> posts);
+ @Nonnull
+ Sone setPosts(@Nonnull Collection<Post> posts);
/**
* Adds the given post to this Sone. The post will not be added if its {@link
/**
* Adds the given post to this Sone. The post will not be added if its {@link
@@
-341,7
+351,7
@@
public interface Sone extends Identified, Fingerprintable, Comparable<Sone> {
* @param post
* The post to add
*/
* @param post
* The post to add
*/
- void addPost(Post post);
+ void addPost(
@Nonnull
Post post);
/**
* Removes the given post from this Sone.
/**
* Removes the given post from this Sone.
@@
-349,13
+359,14
@@
public interface Sone extends Identified, Fingerprintable, Comparable<Sone> {
* @param post
* The post to remove
*/
* @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
*/
/**
* Returns all replies this Sone made.
*
* @return All replies this Sone made
*/
+ @Nonnull
Set<PostReply> getReplies();
/**
Set<PostReply> getReplies();
/**
@@
-365,7
+376,8
@@
public interface Sone extends Identified, Fingerprintable, Comparable<Sone> {
* The new (and only) replies of this Sone
* @return This Sone (for method chaining)
*/
* The new (and only) replies of this Sone
* @return This Sone (for method chaining)
*/
- Sone setReplies(Collection<PostReply> replies);
+ @Nonnull
+ Sone setReplies(@Nonnull Collection<PostReply> replies);
/**
* Adds a reply to this Sone. If the given reply was not made by this Sone,
/**
* Adds a reply to this Sone. If the given reply was not made by this Sone,
@@
-374,7
+386,7
@@
public interface Sone extends Identified, Fingerprintable, Comparable<Sone> {
* @param reply
* The reply to add
*/
* @param reply
* The reply to add
*/
- void addReply(PostReply reply);
+ void addReply(
@Nonnull
PostReply reply);
/**
* Removes a reply from this Sone.
/**
* Removes a reply from this Sone.
@@
-382,13
+394,14
@@
public interface Sone extends Identified, Fingerprintable, Comparable<Sone> {
* @param reply
* The reply to remove
*/
* @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
*/
/**
* Returns the IDs of all liked posts.
*
* @return All liked posts’ IDs
*/
+ @Nonnull
Set<String> getLikedPostIds();
/**
Set<String> getLikedPostIds();
/**
@@
-398,7
+411,8
@@
public interface Sone extends Identified, Fingerprintable, Comparable<Sone> {
* All liked posts’ IDs
* @return This Sone (for method chaining)
*/
* All liked posts’ IDs
* @return This Sone (for method chaining)
*/
- Sone setLikePostIds(Set<String> likedPostIds);
+ @Nonnull
+ Sone setLikePostIds(@Nonnull Set<String> likedPostIds);
/**
* Checks whether the given post ID is liked by this Sone.
/**
* Checks whether the given post ID is liked by this Sone.
@@
-408,7
+422,7
@@
public interface Sone extends Identified, Fingerprintable, Comparable<Sone> {
* @return {@code true} if this Sone likes the given post, {@code false}
* otherwise
*/
* @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.
/**
* Adds the given post ID to the list of posts this Sone likes.
@@
-417,22
+431,23
@@
public interface Sone extends Identified, Fingerprintable, Comparable<Sone> {
* The ID of the post
* @return This Sone (for method chaining)
*/
* 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
/**
* 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
*/
/**
* Returns the IDs of all liked replies.
*
* @return All liked replies’ IDs
*/
+ @Nonnull
Set<String> getLikedReplyIds();
/**
Set<String> getLikedReplyIds();
/**
@@
-442,7
+457,8
@@
public interface Sone extends Identified, Fingerprintable, Comparable<Sone> {
* All liked replies’ IDs
* @return This Sone (for method chaining)
*/
* All liked replies’ IDs
* @return This Sone (for method chaining)
*/
- Sone setLikeReplyIds(Set<String> likedReplyIds);
+ @Nonnull
+ Sone setLikeReplyIds(@Nonnull Set<String> likedReplyIds);
/**
* Checks whether the given reply ID is liked by this Sone.
/**
* Checks whether the given reply ID is liked by this Sone.
@@
-452,7
+468,7
@@
public interface Sone extends Identified, Fingerprintable, Comparable<Sone> {
* @return {@code true} if this Sone likes the given reply, {@code false}
* otherwise
*/
* @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.
/**
* Adds the given reply ID to the list of replies this Sone likes.
@@
-461,22
+477,23
@@
public interface Sone extends Identified, Fingerprintable, Comparable<Sone> {
* The ID of the reply
* @return This Sone (for method chaining)
*/
* 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
/**
* 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
*/
/**
* Returns the root album that contains all visible albums of this Sone.
*
* @return The root album of this Sone
*/
+ @Nonnull
Album getRootAlbum();
/**
Album getRootAlbum();
/**
@@
-484,6
+501,7
@@
public interface Sone extends Identified, Fingerprintable, Comparable<Sone> {
*
* @return The options of this Sone
*/
*
* @return The options of this Sone
*/
+ @Nonnull
SoneOptions getOptions();
/**
SoneOptions getOptions();
/**
@@
-493,6
+511,6
@@
public interface Sone extends Identified, Fingerprintable, Comparable<Sone> {
* The options of this Sone
*/
/* TODO - remove this method again, maybe add an option provider */
* The options of this Sone
*/
/* TODO - remove this method again, maybe add an option provider */
- void setOptions(SoneOptions options);
+ void setOptions(
@Nonnull
SoneOptions options);
}
}