Ignore:
Timestamp:
2013-03-22T22:18:26+01:00 (13 years ago)
Author:
zverik
Message:

ImageryID refactoring and javadocs

File:
1 edited

Legend:

Unmodified
Added
Removed

  • applications/editors/josm/plugins/imagery_offset_db/src/iodb/ImageryOffsetBase.java

    r29376 r29384  
    77
    88/**
    9  * Stores one imagery offset record.
     9 * Stores one offset record. It is the superclass for {@link ImageryOffset}
     10 * and {@link CalibrationObject} classes and contains common fields
     11 * like position, author and description.
    1012 *
    11  * @author zverik
     13 * @author Zverik
     14 * @license WTFPL
    1215 */
    1316public class ImageryOffsetBase {
    … …  
    2124    protected String abandonReason;
    2225   
     26    /**
     27     * Initialize object with the basic information. It's offset location, author, date
     28     * and description.
     29     */
    2330    public void setBasicInfo( LatLon position, String author, String description, Date date ) {
    2431        this.position = position;
    … …  
    3744    }
    3845
     46    /**
     47     * Mark the offset as deprecated. Though there is no exact field for "isDeprecated",
     48     * it is deduced from abandonDate, author and reason being not null.
     49     */
    3950    public void setDeprecated(Date abandonDate, String author, String reason) {
    4051        this.abandonDate = abandonDate;
    … …  
    5566    }
    5667   
     68    /**
     69     * Check that {@link #getAbandonDate()} is not null. Note that
     70     * is doesn't say anything about abandonAuthor or abandonReason.
     71     */
    5772    public boolean isDeprecated() {
    5873        return abandonDate != null;
Note: See TracChangeset for help on using the changeset viewer.