javax.help
Class Map.ID
- Map
- Serializable
public final class Map.ID
extends java.lang.Object
implements Serializable
An ID is a pair of String, HelpSet.
An ID fully identifies a "location" within a HelpSet.
create
public static Map.ID create(String id,
HelpSet hs)
throws BadIDException
A location within a HelpSet. If id or hs are null, a null ID is returned.
id
- The Stringhs
- The HelpSet
equals
public boolean equals(Object o)
Determines if two IDs are equal.
o
- The object to compare.
getHelpSet
public HelpSet getHelpSet()
Getter for property hs.
getIDString
public String getIDString()
Getter for property id.
getURL
public URL getURL()
throws MalformedURLException
Returns the URL that the Map.ID refers to.
- URL The matching URL. Null if the map cannot solve the ID.
javax.help.Map.getURLFromID(javax.help.Map.ID id)
toString
public String toString()
Gets an external represenation of an ID.