Add additional isGlobalId() method to GlobalItemIDImpl

Author: Lloyd Watkin

src/main/java/org/buddycloud/channelserver/pubsub/model/GlobalItemID.java

@@ -3,26 +3,28 @@
 import org.xmpp.packet.JID;
 
 /**
- * Pointer to a globally identifiable node item, using a service JID, node ID and itemID.
- * The Item is unique within the Node
- * The Node is unique within the Service
- * The Service is unique within the network. 
+ * Pointer to a globally identifiable node item, using a service JID, node ID
+ * and itemID. The Item is unique within the Node The Node is unique within the
+ * Service The Service is unique within the network.
  */
 public interface GlobalItemID {
 	/**
 	 * Gets the JID of service which hosts the node (and item)
+	 * 
 	 * @return the JID of the service.
 	 */
 	public JID getService();
-	
+
 	/**
 	 * Gets the NodeID of the node containing the item
+	 * 
 	 * @return the NodeID of the node.
 	 */
 	public String getNodeID();
-	
+
 	/**
 	 * Gets the ItemID of the item within the Node
+	 * 
 	 * @return the ItemID if the item.
 	 */
 	public String getItemID();

src/main/java/org/buddycloud/channelserver/pubsub/model/impl/GlobalItemIDImpl.java

@@ -11,13 +11,18 @@
  */
 public class GlobalItemIDImpl implements GlobalItemID {
 
-	private static final Pattern STRING_PATTERN = Pattern.compile("^tag:([^,]+),([^,]+),([^,]+)$");
-	
+	private static final Pattern STRING_PATTERN = Pattern
+			.compile("^tag:([^,]+),([^,]+),([^,]+)$");
+
 	/**
 	 * Creates a new global item ID
-	 * @param service the JID of the pubsub service hosting the node
-	 * @param nodeID the id of the node containing the item
-	 * @param itemID the id of the item
+	 * 
+	 * @param service
+	 *            the JID of the pubsub service hosting the node
+	 * @param nodeID
+	 *            the id of the node containing the item
+	 * @param itemID
+	 *            the id of the item
 	 */
 	public GlobalItemIDImpl(JID service, String nodeID, String itemID) {
 		this.service = service;
@@ -28,26 +33,26 @@ public GlobalItemIDImpl(JID service, String nodeID, String itemID) {
 	private JID service;
 	private String nodeID;
 	private String itemID;
-	
+
 	@Override
 	public JID getService() {
 		return service;
 	}
-	
+
 	@Override
 	public String getNodeID() {
 		return nodeID;
 	}
-	
+
 	@Override
 	public String getItemID() {
 		return itemID;
 	}
-	
+
 	@Override
 	public String toString() {
 		StringBuilder builder = new StringBuilder();
-		
+
 		if (service != null) {
 			builder.append("tag:");
 			builder.append(service.toString());
@@ -56,40 +61,46 @@ public String toString() {
 		builder.append(nodeID);
 		builder.append(",");
 		builder.append(itemID);
-		
+
 		return builder.toString();
 	}
-	
+
 	/**
-	 * Creates a new {@link GlobalItemID} from a tag string which looks a bit like:
-	 * <blockquote><code>tag:pubsub.server.com,a/node/id,an/item/id</code></blockquote>
-	 * @param str The tag string
+	 * Creates a new {@link GlobalItemID} from a tag string which looks a bit
+	 * like: <blockquote><code>tag:pubsub.server.com,a/node/id,an/item/id</code>
+	 * </blockquote>
+	 * 
+	 * @param str
+	 *            The tag string
 	 * @return the {@link GlobalItemID}
 	 */
 	public static GlobalItemID fromString(final String str) {
 		Matcher matcher = STRING_PATTERN.matcher(str);
-		
-		if(!matcher.matches()) {
-			throw new IllegalArgumentException(str + " is not a valid GlobalItemID String. Expected something like 'tag:example.com,node,item'.");
+
+		if (!matcher.matches()) {
+			throw new IllegalArgumentException(
+					str
+							+ " is not a valid GlobalItemID String. Expected something like 'tag:example.com,node,item'.");
 		}
-		
+
 		JID service = new JID(matcher.group(1));
-		
+
 		// Handle an issue with certain clients
-		if((service.getNode() != null) && service.getNode().equals("null")) {
+		if ((service.getNode() != null) && service.getNode().equals("null")) {
 			service = new JID(null, service.getDomain(), service.getResource());
 		}
-		
+
 		return new GlobalItemIDImpl(service, matcher.group(2), matcher.group(3));
 	}
-	
+
 	/**
 	 * 
 	 */
 	public static GlobalItemID fromBuddycloudString(String itemId) {
 		String[] splittedItemId = itemId.split(",");
 		if (splittedItemId.length < 2) {
-			throw new IllegalArgumentException("Illegal format for buddycloud global id");
+			throw new IllegalArgumentException(
+					"Illegal format for buddycloud global id");
 		}
 		if (splittedItemId.length == 3) {
 			return fromString(itemId);
@@ -108,7 +119,7 @@ public static String toLocalId(String itemId) {
 		}
 		return fromBuddycloudString(itemId).getItemID();
 	}
-	
+
 	@Override
 	public int hashCode() {
 		final int prime = 31;
@@ -145,4 +156,13 @@ public boolean equals(Object obj) {
 			return false;
 		return true;
 	}
+
+	public static boolean isGlobalId(String id) {
+		Matcher matcher = STRING_PATTERN.matcher(id);
+
+		if (!matcher.matches()) {
+			return false;
+		}
+		return true;
+	}
 }

src/test/java/org/buddycloud/channelserver/pubsub/model/impl/GlobalItemIDImplTest.java

@@ -1,6 +1,7 @@
 package org.buddycloud.channelserver.pubsub.model.impl;
 
 import static org.junit.Assert.*;
+import junit.framework.Assert;
 
 import org.buddycloud.channelserver.pubsub.model.GlobalItemID;
 import org.junit.After;
@@ -19,9 +20,10 @@ public void testFromStringWithValidStrings() {
 				new JID("test@pubsub.server.com"),
 				"some kind of RANDOM node ID", "4545nnn342300-dsvads=f/fdsafh");
 	}
-	
+
 	/**
-	 * This is to handle a case with existing buddycloud clients which send the service as <code>"null@&lt;server&gt;"</code>
+	 * This is to handle a case with existing buddycloud clients which send the
+	 * service as <code>"null@&lt;server&gt;"</code>
 	 */
 	@Test
 	public void testFromStringWithNullNodeInService() {
@@ -30,23 +32,34 @@ public void testFromStringWithNullNodeInService() {
 				"this-in-an-item");
 	}
 
-	@Test(expected=IllegalArgumentException.class)
+	@Test(expected = IllegalArgumentException.class)
 	public void testFromStringWithInvalidString() {
 		GlobalItemIDImpl.fromString("this isn't valid");
 	}
 
-	@Test(expected=IllegalArgumentException.class)
+	@Test(expected = IllegalArgumentException.class)
 	public void testFromStringWithMissingTag() {
-		GlobalItemIDImpl.fromString("pubsub.server.com,this/is/a/node,this-in-an-item");
+		GlobalItemIDImpl
+				.fromString("pubsub.server.com,this/is/a/node,this-in-an-item");
 	}
 
 	@Test
 	public void checkEqualsABit() {
-		GlobalItemID itemID = new GlobalItemIDImpl(new JID("denmark.lit"), "node", "item-id");
-		GlobalItemID itemID2 = new GlobalItemIDImpl(new JID("denmark.lit"), "node", "item-id");
-		
+		GlobalItemID itemID = new GlobalItemIDImpl(new JID("denmark.lit"),
+				"node", "item-id");
+		GlobalItemID itemID2 = new GlobalItemIDImpl(new JID("denmark.lit"),
+				"node", "item-id");
+
 		assertEquals("Equals isn't working!", itemID, itemID2);
 	}
+	
+	@Test
+	public void canTestForGlobalIdType() throws Exception {
+		GlobalItemIDImpl id = new GlobalItemIDImpl(new JID("denmark.lit"),
+				"node", "item-id");
+		assertTrue(GlobalItemIDImpl.isGlobalId(id.toString()));
+		assertFalse(GlobalItemIDImpl.isGlobalId(id.getItemID()));
+	}
 
 	private void checkValid(String input, JID service, String nodeID,
 			String itemID) {
@@ -56,4 +69,5 @@ private void checkValid(String input, JID service, String nodeID,
 		assertEquals("Incorrect service", nodeID, result.getNodeID());
 		assertEquals("Incorrect service", itemID, result.getItemID());
 	}
+	
 }