summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorMili Verma <mili.verma@isode.com>2012-01-06 12:27:41 (GMT)
committerKevin Smith <git@kismith.co.uk>2012-01-12 12:08:21 (GMT)
commitd78e4110cd919a4a1f8b2f2ff7aa6640f53c49b3 (patch)
treeaf6afb653a21f3304dec0f72ee833259f9c1ff02 /src/com/isode/stroke/jid/JID.java
parentbe94e872d9423501c688c84c6cb945a420a5cb18 (diff)
downloadstroke-d78e4110cd919a4a1f8b2f2ff7aa6640f53c49b3.zip
stroke-d78e4110cd919a4a1f8b2f2ff7aa6640f53c49b3.tar.bz2
Add Javadoc for CoreClient, EventLoop, JID
Test-information: Looks okay.
Diffstat (limited to 'src/com/isode/stroke/jid/JID.java')
-rw-r--r--src/com/isode/stroke/jid/JID.java9
1 files changed, 7 insertions, 2 deletions
diff --git a/src/com/isode/stroke/jid/JID.java b/src/com/isode/stroke/jid/JID.java
index 00e210b..a256944 100644
--- a/src/com/isode/stroke/jid/JID.java
+++ b/src/com/isode/stroke/jid/JID.java
@@ -1,5 +1,5 @@
/*
- * Copyright (c) 2010-2011, Isode Limited, London, England.
+ * Copyright (c) 2010-2012, Isode Limited, London, England.
* All rights reserved.
*/
/*
@@ -21,6 +21,11 @@ package com.isode.stroke.jid;
*
* Note that invalid JIDs shouldn't have any calls made to them beyond isValid().
*
+ * JIDs may be invalid if received over the wire, and should be checked with {@link JID#isValid}
+ * before they're used.
+ *
+ * <p>
+ * This is an immutable class.
*/
public class JID {
public enum CompareType {
@@ -129,7 +134,7 @@ public class JID {
/**
* e.g. JID("node@domain").getNode() == "node"
- * @return null for nodeless JIDs.
+ * @return Node, or null for nodeless JIDs.
*/
public String getNode() {
return node_;