Package help

Class ImageLocation

java.lang.Object

help.ImageLocation

public class ImageLocation
extends java.lang.Object

A class that represents the original location of an IMG tag along with its location resolution within the help system.

Some images are represented by 'in memory' or 'runtime' values that do not have a valid url.

Method Summary

Modifier and Type	Method	Description
static ImageLocation	createInvalidRuntimeLocation(java.nio.file.Path sourceFile, java.lang.String imageSrc)
static ImageLocation	createLocalLocation(java.nio.file.Path sourceFile, java.lang.String imageSrc, java.net.URI resolvedUri, java.nio.file.Path resolvedPath)
static ImageLocation	createRemoteLocation(java.nio.file.Path sourceFile, java.lang.String imageSrc, java.net.URI resolvedUri)
static ImageLocation	createRuntimeLocation(java.nio.file.Path sourceFile, java.lang.String imageSrc, java.net.URI resolvedUri, java.nio.file.Path resolvedPath)
java.lang.String	getImageSrc()
java.nio.file.Path	getResolvedPath()
java.net.URI	getResolvedUri()
java.nio.file.Path	getSourceFile()
boolean	isInvalidRuntimeImage()
boolean	isRemote()
boolean	isRuntime()
java.lang.String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Method Detail

createLocalLocation

public static ImageLocation createLocalLocation(java.nio.file.Path sourceFile,
                                                java.lang.String imageSrc,
                                                java.net.URI resolvedUri,
                                                java.nio.file.Path resolvedPath)

createRuntimeLocation

public static ImageLocation createRuntimeLocation(java.nio.file.Path sourceFile,
                                                  java.lang.String imageSrc,
                                                  java.net.URI resolvedUri,
                                                  java.nio.file.Path resolvedPath)

createInvalidRuntimeLocation

public static ImageLocation createInvalidRuntimeLocation(java.nio.file.Path sourceFile,
                                                         java.lang.String imageSrc)

createRemoteLocation

public static ImageLocation createRemoteLocation(java.nio.file.Path sourceFile,
                                                 java.lang.String imageSrc,
                                                 java.net.URI resolvedUri)

getSourceFile

public java.nio.file.Path getSourceFile()

getImageSrc

public java.lang.String getImageSrc()

getResolvedPath

public java.nio.file.Path getResolvedPath()

getResolvedUri

public java.net.URI getResolvedUri()

isRemote

public boolean isRemote()

isRuntime

public boolean isRuntime()

isInvalidRuntimeImage

public boolean isInvalidRuntimeImage()

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object