|
24 | 24 | */
|
25 | 25 | package de.bluecolored.bluemap.api;
|
26 | 26 |
|
| 27 | +import com.flowpowered.math.vector.Vector2i; |
27 | 28 | import de.bluecolored.bluemap.api.marker.Marker;
|
28 | 29 | import de.bluecolored.bluemap.api.marker.MarkerAPI;
|
29 | 30 | import de.bluecolored.bluemap.api.renderer.RenderAPI;
|
@@ -102,11 +103,24 @@ public abstract class BlueMapAPI {
|
102 | 103 | *
|
103 | 104 | * @param image the image to create
|
104 | 105 | * @param path the path/name of this image, the separator-char is '/'
|
105 |
| - * @return the relative address of the image in the web-app |
| 106 | + * @return the relative address of the image in the web-app, |
| 107 | + * which can be used as it is e.g. in the {@link de.bluecolored.bluemap.api.marker.POIMarker#setIcon(String, Vector2i)} method |
106 | 108 | * @throws IOException If an {@link IOException} is thrown while writing the image
|
107 | 109 | */
|
108 | 110 | public abstract String createImage(BufferedImage image, String path) throws IOException;
|
109 | 111 |
|
| 112 | + /** |
| 113 | + * Lists all images that are available. This includes all images previously created with the {@link #createImage(BufferedImage, String)} |
| 114 | + * function, but might include more. |
| 115 | + * @return A map of available images where: |
| 116 | + * <ul> |
| 117 | + * <li>the <b>key</b> is the image path how it would be used in the "path" parameter of the {@link #createImage(BufferedImage, String)} method</li> |
| 118 | + * <li>and the <b>value</b> is the relative address of the image. The same ones that are returned from the {@link #createImage(BufferedImage, String)} method</li> |
| 119 | + * </ul> |
| 120 | + * @throws IOException If an {@link IOException} is thrown while reading the images |
| 121 | + */ |
| 122 | + public abstract Map<String, String> availableImages() throws IOException; |
| 123 | + |
110 | 124 | /**
|
111 | 125 | * Getter for the configured web-root folder
|
112 | 126 | * @return The {@link Path} of the web-root folder
|
|
0 commit comments