Comment (Javadocs [I2P+ 2.13.0+] - API Version 0.9.70+)

java.lang.Object
- org.klomp.snark.comments.Comment

All Implemented Interfaces:
Comparable<Comment>
```
public class Comment
extends Object
implements Comparable<Comment>
```
Store a single comment and/or rating. Unmodifiable except for marking as hidden. Stores a one-second timestamp but designed so identical comments within a certain time frame (bucket) are equal. Don't store in a plain set - see equals().

Field Summary
Fields
Modifier and Type Field and Description
static int MAX_NAME_LEN
Maximum length of a commenter name

Fields
Modifier and Type	Field and Description
`static int`	`MAX_NAME_LEN` Maximum length of a commenter name

Constructor Summary

Constructors
Constructor and Description
`Comment(String text, String name, int rating)` My comment, now
`Comment(String text, String name, int rating, long time, boolean isMine)` Create a comment with the specified text, name, rating, time, and ownership.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`int`	`compareTo(Comment c)` Compares comments in reverse chronological order (newest first).
`boolean`	`equals(Object o)` Comments within 10 minutes (not necessarily in same bucket) and otherwise equal are considered equal.
`boolean`	`equalsIgnoreTimestamp(Comment c)` Checks equality ignoring the timestamp, comparing only rating, text, and name.
`static Comment`	`fromPersistentString(String s)` Parses a comment from its persistent string representation.
`int`	`getID()` Returns a unique ID for this comment, usable with CommentSet.remove(int).
`String`	`getName()` Returns the commenter's name.
`int`	`getRating()` Returns the rating (0-5).
`String`	`getText()` Returns the comment text.
`long`	`getTime()` Returns the comment timestamp in java time (milliseconds since epoch).
`int`	`hashCode()` Returns the bucket number for hash-based grouping.
`boolean`	`isHidden()` Returns whether this comment is hidden (deleted by the user).
`boolean`	`isMine()` Returns whether this comment was posted by the local user.
`(package private) void`	`setHidden()` Mark this comment as hidden.
`String`	`toPersistentString()` Converts this comment to a persistent string representation.

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - MAX_NAME_LEN
```
public static final int MAX_NAME_LEN
```
    Maximum length of a commenter name
    See Also:
    Constant Field Values
- Constructor Detail
  - Comment
```
public Comment(String text,
               String name,
               int rating)
```
    My comment, now
    Parameters:
    text - may be null, will be truncated to max length, newlines replaced with spaces
    name - may be null, will be truncated to max length, newlines and commas removed
    rating - 0-5
  - Comment
```
public Comment(String text,
               String name,
               int rating,
               long time,
               boolean isMine)
```
    Create a comment with the specified text, name, rating, time, and ownership.
    Parameters:
    text - may be null, will be truncated to max length, newlines replaced with spaces
    name - may be null, will be truncated to max length, newlines and commas removed
    time - java time (ms)
    rating - 0-5
    isMine - whether this comment is from the local user
- Method Detail
  - compareTo
```
public int compareTo(Comment c)
```
    Compares comments in reverse chronological order (newest first). Falls back to rating, then name, then text for ties.
    Specified by:
    compareTo in interface Comparable<Comment>
    Parameters:
    c - the other Comment to compare to
    Returns:
    negative if this comment is newer
  - equals
```
public boolean equals(Object o)
```
    Comments within 10 minutes (not necessarily in same bucket) and otherwise equal are considered equal. Violates contract, as equal objects may have different hashcodes and be in adjacent buckets.
    Overrides:
    equals in class Object
  - equalsIgnoreTimestamp
```
public boolean equalsIgnoreTimestamp(Comment c)
```
    Checks equality ignoring the timestamp, comparing only rating, text, and name.
    Parameters:
    c - the other Comment to compare to
    Returns:
    true if rating, text, and name match
  - fromPersistentString
```
public static Comment fromPersistentString(String s)
```
    Parses a comment from its persistent string representation.
    Parameters:
    s - the persistent string
    Returns:
    the parsed Comment, or null if parsing fails
  - getID
```
public int getID()
```
    Returns a unique ID for this comment, usable with CommentSet.remove(int). Not persisted across restarts.
    Returns:
    the unique ID
  - getName
```
public String getName()
```
    Returns the commenter's name.
    Returns:
    the name, or null if anonymous
  - getRating
```
public int getRating()
```
    Returns the rating (0-5).
    Returns:
    the rating value
  - getText
```
public String getText()
```
    Returns the comment text.
    Returns:
    the text, or null if no text
  - getTime
```
public long getTime()
```
    Returns the comment timestamp in java time (milliseconds since epoch).
    Returns:
    the timestamp
  - hashCode
```
public int hashCode()
```
    Returns the bucket number for hash-based grouping.
    Overrides:
    hashCode in class Object
    Returns:
    the bucket number
  - isHidden
```
public boolean isHidden()
```
    Returns whether this comment is hidden (deleted by the user).
    Returns:
    true if hidden
  - isMine
```
public boolean isMine()
```
    Returns whether this comment was posted by the local user.
    Returns:
    true if the comment is from the local user
  - setHidden
```
void setHidden()
```
    Mark this comment as hidden.
  - toPersistentString
```
public String toPersistentString()
```
    Converts this comment to a persistent string representation.
    Returns:
    comma-separated string of time,rating,mine,hidden,name,text

Class Comment

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

MAX_NAME_LEN

Constructor Detail

Comment

Comment

Method Detail

compareTo

equals

equalsIgnoreTimestamp

fromPersistentString

getID

getName

getRating

getText

getTime

hashCode

isHidden

isMine

setHidden

toPersistentString