Change contract of Shell.getShelled().

[Sone.git] / src / main / java / net / pterodactylus / sone / data / Shell.java

diff --git a/src/main/java/net/pterodactylus/sone/data/Shell.java b/src/main/java/net/pterodactylus/sone/data/Shell.java
index 9f1fc9b..8d7068e 100644 (file)
--- a/src/main/java/net/pterodactylus/sone/data/Shell.java
+++ b/src/main/java/net/pterodactylus/sone/data/Shell.java
@@ -36,11 +36,11 @@ public interface Shell<T> {
        public boolean canUnshell();
 
        /**
-        * Returns the object that is shelled. Returns {@code null} if the real
-        * object has not yet been retrieved.
+        * Returns the object that is shelled. This method with return the shell
+        * itself if {@link #canUnshell()} returns {@code false} and will return the
+        * real object once {@link #canUnshell()} returns true.
         *
-        * @return The shelled object, or {@code null} if the shelled object is not
-        *         retrieved yet
+        * @return The shelled object, or the shell itself
         */
        public T getShelled();