Changeset 8092 in josm for trunk/src


Ignore:
Timestamp:
2015-02-21T15:39:23+01:00 (5 years ago)
Author:
stoecker
Message:

some javadoc

File:
1 edited

Legend:

Unmodified
Added
Removed
  • trunk/src/org/openstreetmap/josm/data/imagery/ImageryInfo.java

    r8091 r8092  
    159159    /** id for this imagery entry, optional at the moment */
    160160    private String id;
     161    /** URL of the imagery service */
    161162    private String url = null;
     163    /** whether this is a entry activated by default or not */
    162164    private boolean defaultEntry = false;
     165    /** The data part of HTTP cookies header in case the service requires cookies to work */
    163166    private String cookies = null;
    164     private String eulaAcceptanceRequired= null;
     167    /** Whether this service requires a explicit EULA acceptance before it can be activated */
     168    private String eulaAcceptanceRequired = null;
     169    /** type of the imagery servics - WMS, TMS, ... */
    165170    private ImageryType imageryType = ImageryType.WMS;
    166171    private double pixelPerDegree = 0.0;
     172    /** maximum zoom level for TMS imagery */
    167173    private int defaultMaxZoom = 0;
     174    /** minimum zoom level for TMS imagery */
    168175    private int defaultMinZoom = 0;
     176    /** display bounds of imagery, displayed in prefs and used for automatic imagery selection */
    169177    private ImageryBounds bounds = null;
     178    /** projections supported by WMS servers */
    170179    private List<String> serverProjections;
    171180    /** description of the imagery entry, should contain notes what type of data it is */
    172181    private String description;
    173     /** language of the description entry, "" for tr() result */
     182    /** language of the description entry */
    174183    private String langDescription;
     184    /** Text of a text attribution displayed when using the imagery */
    175185    private String attributionText;
     186    /** Link behing the text attribution displayed when using the imagery */
    176187    private String attributionLinkURL;
     188    /** Image of a graphical attribution displayed when using the imagery */
    177189    private String attributionImage;
     190    /** Link behind the graphical attribution displayed when using the imagery */
    178191    private String attributionImageURL;
     192    /** Text with usage terms displayed when using the imagery */
    179193    private String termsOfUseText;
     194    /** Link behind the text with usage terms displayed when using the imagery */
    180195    private String termsOfUseURL;
     196    /** country code of the imagery (for country specific imagery) */
    181197    private String countryCode = "";
     198    /** icon used in menu */
    182199    private String icon;
    183200    // when adding a field, also adapt the ImageryInfo(ImageryInfo) constructor
     
    316333     * @param type The entry imagery type. If null, WMS will be used as default
    317334     * @param eulaAcceptanceRequired The EULA URL
     335     * @param cookies The data part of HTTP cookies header in case the service requires cookies to work
    318336     * @throws IllegalArgumentException if type refers to an unknown imagery type
    319337     */
     
    769787    }
    770788
     789    /**
     790     * Return the data part of HTTP cookies header in case the service requires cookies to work
     791     * @return the cookie data part
     792     */
    771793    public String getCookies() {
    772794        return this.cookies;
Note: See TracChangeset for help on using the changeset viewer.