Ignore:
Timestamp:
2016-04-10T16:57:50+02:00 (4 years ago)
Author:
Don-vip
Message:

sonar, javadoc

Location:
trunk/src/org/openstreetmap/josm/data/notes
Files:
1 added
2 edited

Legend:

Unmodified
Added
Removed
  • trunk/src/org/openstreetmap/josm/data/notes/Note.java

    r10098 r10134  
    1212
    1313/**
    14  * A map note. It always has at least one comment since a comment is required
    15  * to create a note on osm.org
     14 * A map note. It always has at least one comment since a comment is required to create a note on osm.org.
     15 * @since 7451
    1616 */
    1717public class Note {
    1818
    19     public enum State { open, closed }
     19    /** Note state */
     20    public enum State {
     21        /** Note is open */
     22        OPEN,
     23        /** Note is closed */
     24        CLOSED
     25    }
    2026
    2127    private long id;
     
    3945    }
    4046
     47    /**
     48     * Sets note id.
     49     * @param id OSM ID of this note
     50     */
    4151    public void setId(long id) {
    4252        this.id = id;
     
    5363    }
    5464
     65    /**
     66     * Sets date at which this note has been created.
     67     * @param createdAt date at which this note has been created
     68     */
    5569    public void setCreatedAt(Date createdAt) {
    5670        this.createdAt = createdAt;
     
    6276    }
    6377
     78    /**
     79     * Sets date at which this note has been closed.
     80     * @param closedAt date at which this note has been closed
     81     */
    6482    public void setClosedAt(Date closedAt) {
    6583        this.closedAt = closedAt;
     
    7189    }
    7290
     91    /**
     92     * Sets the note state.
     93     * @param state note state (open or closed)
     94     */
    7395    public void setState(State state) {
    7496        this.state = state;
     
    80102    }
    81103
     104    /**
     105     * Adds a comment.
     106     * @param comment note comment
     107     */
    82108    public void addComment(NoteComment comment) {
    83109        comments.add(comment);
     
    112138    @Override
    113139    public boolean equals(Object obj) {
    114         if (this == obj) return true;
    115         if (obj == null || getClass() != obj.getClass()) return false;
     140        if (this == obj)
     141            return true;
     142        if (obj == null || getClass() != obj.getClass())
     143            return false;
    116144        Note note = (Note) obj;
    117145        return id == note.id;
  • trunk/src/org/openstreetmap/josm/data/notes/NoteComment.java

    r10098 r10134  
    99 * Represents a comment made on a note. All notes have at least on comment
    1010 * which is the comment the note was opened with. Comments are immutable.
     11 * @since 7451
    1112 */
    1213public class NoteComment {
     
    2526     */
    2627    public enum Action {
    27         opened,
    28         closed,
    29         reopened,
    30         commented,
    31         hidden
     28        /** note has been opened */
     29        OPENED,
     30        /** note has been closed */
     31        CLOSED,
     32        /** note has been reopened */
     33        REOPENED,
     34        /** note has been commented */
     35        COMMENTED,
     36        /** note has been hidden */
     37        HIDDEN
    3238    }
    3339
Note: See TracChangeset for help on using the changeset viewer.