Ignore:
Timestamp:
2017-05-15T23:42:03+02:00 (7 years ago)
Author:
michael2402
Message:

See #14794: Javadoc for data.osm package

File:
1 edited

Legend:

Unmodified
Added
Removed

  • trunk/src/org/openstreetmap/josm/data/osm/visitor/paint/MapRendererFactory.java

    r11537 r12189  
    4444    public static final String PREF_KEY_RENDERER_CLASS_NAME = "mappaint.renderer-class-name";
    4545
     46    /**
     47     * An exception thrown while creating a map renderer
     48     */
    4649    public static class MapRendererFactoryException extends RuntimeException {
    4750
     51        /**
     52         * Create a new {@link MapRendererFactoryException}
     53         * @param message The message
     54         * @param cause The cause
     55         */
    4856        public MapRendererFactoryException(String message, Throwable cause) {
    4957            super(message, cause);
    5058        }
    5159
     60        /**
     61         * Create a new {@link MapRendererFactoryException}
     62         * @param message The message
     63         */
    5264        public MapRendererFactoryException(String message) {
    5365            super(message);
    5466        }
    5567
     68        /**
     69         * Create a new {@link MapRendererFactoryException}
     70         * @param cause The cause
     71         */
    5672        public MapRendererFactoryException(Throwable cause) {
    5773            super(cause);
    … …  
    5975    }
    6076
     77    /**
     78     * A description of a possible renderer for the map
     79     */
    6180    public static class Descriptor {
    6281        private final Class<? extends AbstractMapRenderer> renderer;
    … …  
    6483        private final String description;
    6584
     85        /**
     86         * Creates a new map renderer description
     87         * @param renderer The renderer
     88         * @param displayName The display name for the renderer
     89         * @param description The longer description that should be displayed to the user.
     90         */
    6691        public Descriptor(Class<? extends AbstractMapRenderer> renderer, String displayName, String description) {
    6792            this.renderer = renderer;
    … …  
    7095        }
    7196
     97        /**
     98         * Get the class of the renderer
     99         * @return The class
     100         */
    72101        public Class<? extends AbstractMapRenderer> getRenderer() {
    73102            return renderer;
    74103        }
    75104
     105        /**
     106         * Get the display name
     107         * @return The name
     108         */
    76109        public String getDisplayName() {
    77110            return displayName;
    78111        }
    79112
     113        /**
     114         * Get the description
     115         * @return The description
     116         */
    80117        public String getDescription() {
    81118            return description;
Note: See TracChangeset for help on using the changeset viewer.