org.openstreetmap.josm.data.notes

Class NoteComment

java.lang.Object

org.openstreetmap.josm.data.notes.NoteComment

public class NoteComment
extends Object

Represents a comment made on a note. All notes have at least on comment which is the comment the note was opened with. Comments are immutable.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	NoteComment.Action Every comment has an associated action.

Field Summary

Fields

Modifier and Type	Field and Description
private NoteComment.Action	action
private Date	commentTimestamp
private boolean	isNew
private String	text
private User	user

Constructor Summary

Constructors

Constructor and Description
NoteComment(Date createDate, User user, String commentText, NoteComment.Action action, boolean isNew)

Method Summary

Modifier and Type	Method and Description
Date	getCommentTimestamp()
NoteComment.Action	getNoteAction()
String	getText()
User	getUser()
boolean	isNew()
void	setNew(boolean isNew)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

text

private final String text

user

private final User user

commentTimestamp

private final Date commentTimestamp

action

private final NoteComment.Action action

isNew

private boolean isNew

Constructor Detail

NoteComment

public NoteComment(Date createDate,
                   User user,
                   String commentText,
                   NoteComment.Action action,
                   boolean isNew)

Parameters:

createDate - The time at which this comment was added

user - JOSM User object of the user who created the comment

commentText - The text left by the user. Is sometimes blank

action - The action associated with this comment

isNew - Whether or not this comment is new and needs to be uploaded

Method Detail

getText

public String getText()

Returns:

Plain text of user's comment

getUser

public User getUser()

Returns:

JOSM's User object for the user who made this comment

getCommentTimestamp

public Date getCommentTimestamp()

Returns:

The time at which this comment was created

getNoteAction

public NoteComment.Action getNoteAction()

Returns:

the action associated with this note

setNew

public void setNew(boolean isNew)

isNew

public boolean isNew()

Returns:

true if this is a new comment/action and needs to be uploaded to the API