Ignore:
Timestamp:
2017-04-10T00:14:42+02:00 (3 years ago)
Author:
Don-vip
Message:

findbugs - EI_EXPOSE_REP2 + javadoc

Location:
trunk/src/org/openstreetmap/josm/data/osm
Files:
10 edited

Legend:

Unmodified
Added
Removed
  • trunk/src/org/openstreetmap/josm/data/osm/Changeset.java

    r11332 r11878  
    1515import org.openstreetmap.josm.data.osm.visitor.Visitor;
    1616import org.openstreetmap.josm.tools.CheckParameterUtil;
     17import org.openstreetmap.josm.tools.date.DateUtils;
    1718
    1819/**
     
    177178     */
    178179    public Date getCreatedAt() {
    179         return createdAt;
     180        return DateUtils.cloneDate(createdAt);
    180181    }
    181182
     
    185186     */
    186187    public void setCreatedAt(Date createdAt) {
    187         this.createdAt = createdAt;
     188        this.createdAt = DateUtils.cloneDate(createdAt);
    188189    }
    189190
     
    193194     */
    194195    public Date getClosedAt() {
    195         return closedAt;
     196        return DateUtils.cloneDate(closedAt);
    196197    }
    197198
     
    201202     */
    202203    public void setClosedAt(Date closedAt) {
    203         this.closedAt = closedAt;
     204        this.closedAt = DateUtils.cloneDate(closedAt);
    204205    }
    205206
     
    426427            return;
    427428        this.user = other.user;
    428         this.createdAt = other.createdAt;
    429         this.closedAt = other.closedAt;
     429        this.createdAt = DateUtils.cloneDate(other.createdAt);
     430        this.closedAt = DateUtils.cloneDate(other.closedAt);
    430431        this.open = other.open;
    431432        this.min = other.min;
  • trunk/src/org/openstreetmap/josm/data/osm/ChangesetDataSet.java

    r11115 r11878  
    1717public class ChangesetDataSet {
    1818
     19    /**
     20     * Type of primitive modification.
     21     */
    1922    public enum ChangesetModificationType {
     23        /** The primitive has been created */
    2024        CREATED,
     25        /** The primitive has been updated */
    2126        UPDATED,
     27        /** The primitive has been deleted */
    2228        DELETED
    2329    }
    2430
     31    /**
     32     * An entry in the changeset dataset.
     33     */
    2534    public interface ChangesetDataSetEntry {
     35
     36        /**
     37         * Returns the type of modification.
     38         * @return the type of modification
     39         */
    2640        ChangesetModificationType getModificationType();
    2741
     42        /**
     43         * Returns the affected history primitive.
     44         * @return the affected history primitive
     45         */
    2846        HistoryOsmPrimitive getPrimitive();
    2947    }
     
    133151
    134152    /**
    135      * Replies the {@link HistoryOsmPrimitive} with id <code>id</code> from this
    136      * dataset. null, if there is no such primitive in the data set.
    137      *
    138      * @param id the id
    139      * @return  the {@link HistoryOsmPrimitive} with id <code>id</code> from this
    140      * dataset
     153     * Replies the {@link HistoryOsmPrimitive} with id <code>id</code> from this dataset.
     154     * null, if there is no such primitive in the data set.
     155     *
     156     * @param id the id
     157     * @return the {@link HistoryOsmPrimitive} with id <code>id</code> from this dataset
    141158     */
    142159    public HistoryOsmPrimitive getPrimitive(PrimitiveId id) {
     
    145162    }
    146163
     164    /**
     165     * Returns an iterator over dataset entries.
     166     * @return an iterator over dataset entries
     167     */
    147168    public Iterator<ChangesetDataSetEntry> iterator() {
    148169        return new DefaultIterator();
     
    184205        public ChangesetDataSetEntry next() {
    185206            Entry<PrimitiveId, ChangesetModificationType> next = typeIterator.next();
    186             ChangesetModificationType type = next.getValue();
    187             HistoryOsmPrimitive primitive = primitives.get(next.getKey());
    188             return new DefaultChangesetDataSetEntry(type, primitive);
     207            return new DefaultChangesetDataSetEntry(next.getValue(), primitives.get(next.getKey()));
    189208        }
    190209
  • trunk/src/org/openstreetmap/josm/data/osm/ChangesetDiscussionComment.java

    r7937 r11878  
    33
    44import java.util.Date;
     5
     6import org.openstreetmap.josm.tools.date.DateUtils;
    57
    68/**
     
    2325     */
    2426    public ChangesetDiscussionComment(Date date, User user) {
    25         this.date = date;
     27        this.date = DateUtils.cloneDate(date);
    2628        this.user = user;
    2729    }
     
    4850     */
    4951    public final Date getDate() {
    50         return date;
     52        return DateUtils.cloneDate(date);
    5153    }
    5254
  • trunk/src/org/openstreetmap/josm/data/osm/PrimitiveData.java

    r10946 r11878  
    7575    }
    7676
     77    /**
     78     * Returns a filtered list for a given primitive type.
     79     * @param <T> primitive type
     80     * @param list list to filter
     81     * @param type primitive type
     82     * @return a filtered list for given primitive type
     83     */
    7784    @SuppressWarnings("unchecked")
    7885    public static <T extends PrimitiveData> List<T> getFilteredList(Collection<T> list, OsmPrimitiveType type) {
  • trunk/src/org/openstreetmap/josm/data/osm/RelationData.java

    r9891 r11878  
    77import org.openstreetmap.josm.data.osm.visitor.PrimitiveVisitor;
    88
     9/**
     10 * Relation data.
     11 * @since 2284
     12 */
    913public class RelationData extends PrimitiveData implements IRelation {
    1014
     
    2832    }
    2933
     34    /**
     35     * Returns relation members.
     36     * @return relation members
     37     */
    3038    public List<RelationMemberData> getMembers() {
    3139        return members;
    3240    }
    3341
     42    /**
     43     * Sets relation members.
     44     * @param memberData relation members
     45     */
    3446    public void setMembers(List<RelationMemberData> memberData) {
    3547        members = new ArrayList<>(memberData);
  • trunk/src/org/openstreetmap/josm/data/osm/UserInfo.java

    r11349 r11878  
    66
    77import org.openstreetmap.josm.data.coor.LatLon;
     8import org.openstreetmap.josm.tools.date.DateUtils;
    89
    910/**
     
    7374     */
    7475    public Date getAccountCreated() {
    75         return accountCreated;
     76        return DateUtils.cloneDate(accountCreated);
    7677    }
    7778
     
    8182     */
    8283    public void setAccountCreated(Date accountCreated) {
    83         this.accountCreated = accountCreated;
     84        this.accountCreated = DateUtils.cloneDate(accountCreated);
    8485    }
    8586
  • trunk/src/org/openstreetmap/josm/data/osm/history/HistoryNode.java

    r11608 r11878  
    66import org.openstreetmap.josm.data.coor.LatLon;
    77import org.openstreetmap.josm.data.osm.Node;
     8import org.openstreetmap.josm.data.osm.NodeData;
    89import org.openstreetmap.josm.data.osm.OsmPrimitiveType;
    910import org.openstreetmap.josm.data.osm.User;
     
    8990        return formatter.format(this);
    9091    }
     92
     93    /**
     94     * Fills the node attributes with values from this history.
     95     * @param data node data to fill
     96     * @return filled node data
     97     * @since 11878
     98     */
     99    public NodeData fillPrimitiveData(NodeData data) {
     100        super.fillPrimitiveCommonData(data);
     101        data.setCoor(coords);
     102        return data;
     103    }
    91104}
  • trunk/src/org/openstreetmap/josm/data/osm/history/HistoryOsmPrimitive.java

    r11608 r11878  
    1313import java.util.Objects;
    1414
     15import org.openstreetmap.josm.Main;
    1516import org.openstreetmap.josm.data.osm.Changeset;
    1617import org.openstreetmap.josm.data.osm.Node;
    1718import org.openstreetmap.josm.data.osm.OsmPrimitive;
    1819import org.openstreetmap.josm.data.osm.OsmPrimitiveType;
     20import org.openstreetmap.josm.data.osm.PrimitiveData;
    1921import org.openstreetmap.josm.data.osm.PrimitiveId;
    2022import org.openstreetmap.josm.data.osm.Relation;
     
    2426import org.openstreetmap.josm.data.osm.Way;
    2527import org.openstreetmap.josm.tools.CheckParameterUtil;
     28import org.openstreetmap.josm.tools.date.DateUtils;
    2629
    2730/**
     
    8588        this.user = user;
    8689        this.changesetId = changesetId;
    87         this.timestamp = timestamp;
    88         tags = new HashMap<>();
     90        this.timestamp = DateUtils.cloneDate(timestamp);
     91        this.tags = new HashMap<>();
    8992    }
    9093
     
    159162     */
    160163    public Date getTimestamp() {
    161         return timestamp;
     164        return DateUtils.cloneDate(timestamp);
    162165    }
    163166
     
    170173    }
    171174
     175    /**
     176     * Checks that value is positive.
     177     * @param value value to check
     178     * @param name parameter name for error message
     179     * @throws IllegalArgumentException if {@code value <= 0}
     180     */
    172181    protected final void ensurePositiveLong(long value, String name) {
    173182        if (value <= 0) {
     
    176185    }
    177186
     187    /**
     188     * Determines if this history matches given id and version.
     189     * @param id Primitive identifier
     190     * @param version Primitive version
     191     * @return {@code true} if this history matches given id and version
     192     */
    178193    public boolean matches(long id, long version) {
    179194        return this.id == id && this.version == version;
    180195    }
    181196
     197    /**
     198     * Determines if this history matches given id.
     199     * @param id Primitive identifier
     200     * @return {@code true} if this history matches given id
     201     */
    182202    public boolean matches(long id) {
    183203        return this.id == id;
     
    325345    }
    326346
     347    /**
     348     * Fills the attributes common to all primitives with values from this history.
     349     * @param data primitive data to fill
     350     */
     351    protected void fillPrimitiveCommonData(PrimitiveData data) {
     352        data.setUser(user);
     353        try {
     354            data.setVisible(visible);
     355        } catch (IllegalStateException e) {
     356            Main.error(e, "Cannot change visibility for "+data+':');
     357        }
     358        data.setTimestamp(timestamp);
     359        data.setKeys(tags);
     360        data.setOsmId(id, (int) version);
     361    }
     362
    327363    @Override
    328364    public int hashCode() {
     
    335371        if (obj == null || getClass() != obj.getClass()) return false;
    336372        HistoryOsmPrimitive that = (HistoryOsmPrimitive) obj;
    337         return id == that.id &&
    338                 version == that.version;
     373        return id == that.id && version == that.version;
    339374    }
    340375
  • trunk/src/org/openstreetmap/josm/data/osm/history/HistoryRelation.java

    r11608 r11878  
    1010import org.openstreetmap.josm.data.osm.OsmPrimitiveType;
    1111import org.openstreetmap.josm.data.osm.Relation;
     12import org.openstreetmap.josm.data.osm.RelationData;
    1213import org.openstreetmap.josm.data.osm.RelationMemberData;
    1314import org.openstreetmap.josm.data.osm.User;
     
    141142        return formatter.format(this);
    142143    }
     144
     145    /**
     146     * Fills the relation attributes with values from this history.
     147     * @param data relation data to fill
     148     * @return filled relation data
     149     * @since 11878
     150     */
     151    public RelationData fillPrimitiveData(RelationData data) {
     152        super.fillPrimitiveCommonData(data);
     153        data.setMembers(members);
     154        return data;
     155    }
    143156}
  • trunk/src/org/openstreetmap/josm/data/osm/history/HistoryWay.java

    r11608 r11878  
    1212import org.openstreetmap.josm.data.osm.User;
    1313import org.openstreetmap.josm.data.osm.Way;
     14import org.openstreetmap.josm.data.osm.WayData;
    1415import org.openstreetmap.josm.tools.CheckParameterUtil;
    1516
     
    143144        return formatter.format(this);
    144145    }
     146
     147    /**
     148     * Fills the way attributes with values from this history.
     149     * @param data way data to fill
     150     * @return filled way data
     151     * @since 11878
     152     */
     153    public WayData fillPrimitiveData(WayData data) {
     154        super.fillPrimitiveCommonData(data);
     155        data.setNodes(nodeIds);
     156        return data;
     157    }
    145158}
Note: See TracChangeset for help on using the changeset viewer.