Package help.validator.model

Class AnchorDefinition

java.lang.Object

help.validator.model.AnchorDefinition

public class AnchorDefinition
extends Object

A representation of a help location, which can be a file or a file with an anchor inside of that file.

This class is used to generate target information for TOC files and to generate link information for the help map files.

Warning: The ID generated by this class is specific to the JavaHelp system. It is of the format:

TopicName_anchorName

or

TopicName_Filename

Constructor Summary

Constructors

Constructor	Description
AnchorDefinition(Path file, String anchorName, int lineNum)

Method Summary

Modifier and Type	Method	Description
String	getAnchorName()
String	getHelpPath()
String	getId()
int	getLineNumber()
Path	getSrcFile()
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Details

AnchorDefinition

public AnchorDefinition(Path file,
 String anchorName,
 int lineNum)

Method Details

getAnchorName

public String getAnchorName()

getSrcFile

public Path getSrcFile()

getId

public String getId()

getLineNumber

public int getLineNumber()

getHelpPath

public String getHelpPath()

toString

public String toString()

Overrides:

toString in class Object