Author: felixk Date: Thu Oct 6 10:08:47 2011 New Revision: 1179554 URL: http://svn.apache.org/viewvc?rev=1179554&view=rev Log: Update javadocs
Modified: james/mailbox/trunk/hbase/src/main/java/org/apache/james/mailbox/hbase/HBaseMailboxSessionMapperFactory.java james/mailbox/trunk/hbase/src/main/java/org/apache/james/mailbox/hbase/HBaseUtils.java james/mailbox/trunk/hbase/src/main/java/org/apache/james/mailbox/hbase/PropertyConvertor.java james/mailbox/trunk/hbase/src/main/java/org/apache/james/mailbox/hbase/mail/HBaseMessage.java Modified: james/mailbox/trunk/hbase/src/main/java/org/apache/james/mailbox/hbase/HBaseMailboxSessionMapperFactory.java URL: http://svn.apache.org/viewvc/james/mailbox/trunk/hbase/src/main/java/org/apache/james/mailbox/hbase/HBaseMailboxSessionMapperFactory.java?rev=1179554&r1=1179553&r2=1179554&view=diff ============================================================================== --- james/mailbox/trunk/hbase/src/main/java/org/apache/james/mailbox/hbase/HBaseMailboxSessionMapperFactory.java (original) +++ james/mailbox/trunk/hbase/src/main/java/org/apache/james/mailbox/hbase/HBaseMailboxSessionMapperFactory.java Thu Oct 6 10:08:47 2011 @@ -130,8 +130,8 @@ public class HBaseMailboxSessionMapperFa } /** - * Returns the configuration object for accesing the cluster. - * @return + * Returns the configuration object for accessing the cluster. + * @return The configuration for accessing the cluster */ public Configuration getClusterConfiguration() { return conf; @@ -139,7 +139,7 @@ public class HBaseMailboxSessionMapperFa /** * Returns the ModSeqProvider used. - * @return + * @return The used modSeqProvider */ public ModSeqProvider<UUID> getModSeqProvider() { return modSeqProvider; @@ -147,7 +147,7 @@ public class HBaseMailboxSessionMapperFa /** * Returns the UidProvider that generates UID's for mailboxes. - * @return + * @return The provider that generates UID's for mailboxes */ public UidProvider<UUID> getUidProvider() { return uidProvider; Modified: james/mailbox/trunk/hbase/src/main/java/org/apache/james/mailbox/hbase/HBaseUtils.java URL: http://svn.apache.org/viewvc/james/mailbox/trunk/hbase/src/main/java/org/apache/james/mailbox/hbase/HBaseUtils.java?rev=1179554&r1=1179553&r2=1179554&view=diff ============================================================================== --- james/mailbox/trunk/hbase/src/main/java/org/apache/james/mailbox/hbase/HBaseUtils.java (original) +++ james/mailbox/trunk/hbase/src/main/java/org/apache/james/mailbox/hbase/HBaseUtils.java Thu Oct 6 10:08:47 2011 @@ -76,12 +76,10 @@ public class HBaseUtils { /** * This returns the row key needed for HBase. Having the method here ensure * we have a consistent way to generate the rowkey. - * @return rowkey byte array that can be used with HBase API - */ - /** + * * Convenience method for generating a rowKey when you don't have a mailbox object. * @param uuid - * @return + * @return rowkey byte array that can be used with HBase API */ public static byte[] mailboxRowKey(UUID uuid) { byte[] rowKey = new byte[16]; @@ -93,7 +91,7 @@ public class HBaseUtils { /** * Returns a UUID from the a byte array. * @param rowkey - * @return + * @return UUID calculated from the byte array */ public static UUID UUIDFromRowKey(byte[] rowkey) { return new UUID(Bytes.toLong(rowkey, 0), Bytes.toLong(rowkey, 8)); @@ -184,8 +182,8 @@ public class HBaseUtils { * Create a row key for a message in a mailbox. The current row key is mailboxID followed by messageID. * Both values are fixed length so no separator is needed. * Downside: we will be storing the same message multiple times, one time for each recipient. - * @param message - * @return a row key + * @param message message to get row key from + * @return rowkey byte array that can be used with HBase API */ public static byte[] messageRowKey(Message<UUID> message) { return messageRowKey(message.getMailboxId(), message.getUid()); @@ -195,9 +193,9 @@ public class HBaseUtils { * Utility method to build row keys from mailbox UUID and message uid. * The message uid's are stored in reverse order by substracting the uid value * from Long.MAX_VALUE. - * @param message - * @param uid - * @return a row key byte array + * @param mailboxUid mailbox UUID + * @param uid message uid + * @return rowkey byte array that can be used with HBase API */ public static byte[] messageRowKey(UUID mailboxUid, long uid) { /** message uid's are stored in reverse order so we will always have the most recent messages first*/ @@ -210,10 +208,10 @@ public class HBaseUtils { /** * Utility to build row keys from mailboxUID and a value. The value is added to - * the key without any other opperations. - * @param mailboxUid + * the key without any other operations. + * @param mailboxUid mailbox UUID * @param value - * @return + * @return rowkey byte array that can be used with HBase API */ public static byte[] customMessageRowKey(UUID mailboxUid, long value) { return Bytes.add(Bytes.toBytes(mailboxUid.getMostSignificantBits()), Modified: james/mailbox/trunk/hbase/src/main/java/org/apache/james/mailbox/hbase/PropertyConvertor.java URL: http://svn.apache.org/viewvc/james/mailbox/trunk/hbase/src/main/java/org/apache/james/mailbox/hbase/PropertyConvertor.java?rev=1179554&r1=1179553&r2=1179554&view=diff ============================================================================== --- james/mailbox/trunk/hbase/src/main/java/org/apache/james/mailbox/hbase/PropertyConvertor.java (original) +++ james/mailbox/trunk/hbase/src/main/java/org/apache/james/mailbox/hbase/PropertyConvertor.java Thu Oct 6 10:08:47 2011 @@ -37,7 +37,7 @@ public class PropertyConvertor { /** * Returns a byte array that represents a HBase column qualifier for the * provided property. - * @param prop the property for storage n HBase + * @param propNumber the property for storage n HBase * @return a byte array that represents a column qualifier for the property */ public static byte[] getQualifier(int propNumber) { Modified: james/mailbox/trunk/hbase/src/main/java/org/apache/james/mailbox/hbase/mail/HBaseMessage.java URL: http://svn.apache.org/viewvc/james/mailbox/trunk/hbase/src/main/java/org/apache/james/mailbox/hbase/mail/HBaseMessage.java?rev=1179554&r1=1179553&r2=1179554&view=diff ============================================================================== --- james/mailbox/trunk/hbase/src/main/java/org/apache/james/mailbox/hbase/mail/HBaseMessage.java (original) +++ james/mailbox/trunk/hbase/src/main/java/org/apache/james/mailbox/hbase/mail/HBaseMessage.java Thu Oct 6 10:08:47 2011 @@ -272,7 +272,7 @@ public class HBaseMessage extends Abstra } /** - * @see org.apache.james.mailbox.store.mail.model.MailboxMembership#getInternalDate() + * @see org.apache.james.mailbox.store.mail.model.Message#getInternalDate() */ @Override public Date getInternalDate() { @@ -280,7 +280,7 @@ public class HBaseMessage extends Abstra } /** - * @see org.apache.james.mailbox.store.mail.model.MailboxMembership#getMailboxId() + * @see org.apache.james.mailbox.store.mail.model.Message#getMailboxId() */ @Override public UUID getMailboxId() { @@ -288,7 +288,7 @@ public class HBaseMessage extends Abstra } /** - * @see org.apache.james.mailbox.store.mail.model.MailboxMembership#getUid() + * @see org.apache.james.mailbox.store.mail.model.Message#getUid() */ @Override public long getUid() { @@ -296,7 +296,7 @@ public class HBaseMessage extends Abstra } /** - * @see org.apache.james.mailbox.store.mail.model.MailboxMembership#isAnswered() + * @see org.apache.james.mailbox.store.mail.model.Message#isAnswered() */ @Override public boolean isAnswered() { @@ -304,7 +304,7 @@ public class HBaseMessage extends Abstra } /** - * @see org.apache.james.mailbox.store.mail.model.MailboxMembership#isDeleted() + * @see org.apache.james.mailbox.store.mail.model.Message#isDeleted() */ @Override public boolean isDeleted() { @@ -312,7 +312,7 @@ public class HBaseMessage extends Abstra } /** - * @see org.apache.james.mailbox.store.mail.model.MailboxMembership#isDraft() + * @see org.apache.james.mailbox.store.mail.model.Message#isDraft() */ @Override public boolean isDraft() { @@ -320,7 +320,7 @@ public class HBaseMessage extends Abstra } /** - * @see org.apache.james.mailbox.store.mail.model.MailboxMembership#isFlagged() + * @see org.apache.james.mailbox.store.mail.model.Message#isFlagged() */ @Override public boolean isFlagged() { @@ -328,7 +328,7 @@ public class HBaseMessage extends Abstra } /** - * @see org.apache.james.mailbox.store.mail.model.MailboxMembership#isRecent() + * @see org.apache.james.mailbox.store.mail.model.Message#isRecent() */ @Override public boolean isRecent() { @@ -336,7 +336,7 @@ public class HBaseMessage extends Abstra } /** - * @see org.apache.james.mailbox.store.mail.model.MailboxMembership#isSeen() + * @see org.apache.james.mailbox.store.mail.model.Message#isSeen() */ @Override public boolean isSeen() { @@ -349,7 +349,7 @@ public class HBaseMessage extends Abstra } /** - * @see org.apache.james.mailbox.store.mail.model.MailboxMembership#setFlags(javax.mail.Flags) + * @see org.apache.james.mailbox.store.mail.model.Message#setFlags(javax.mail.Flags) */ @Override public final void setFlags(Flags flags) { --------------------------------------------------------------------- To unsubscribe, e-mail: server-dev-unsubscr...@james.apache.org For additional commands, e-mail: server-dev-h...@james.apache.org