Package javax.help
Class Map.ID
java.lang.Object
javax.help.Map.ID
- All Implemented Interfaces:
Serializable
- Enclosing interface:
Map
An ID is a pair of String, HelpSet.
An ID fully identifies a "location" within a HelpSet.
- See Also:
-
Field Summary
Fields -
Method Summary
-
Field Details
-
id
-
hs
-
-
Method Details
-
create
A location within a HelpSet. If id or hs are null, a null ID is returned.- Parameters:
id
- The Stringhs
- The HelpSet- Throws:
BadIDException
- if String is not within the Map of the HelpSet.
-
getHelpSet
Getter for property hs.- Returns:
- Value of property hs.
-
getIDString
Getter for property id.- Returns:
- Value of property id.
-
getURL
Returns the URL that the Map.ID refers to.- Returns:
- URL The matching URL. Null if the map cannot solve the ID.
- Throws:
MalformedURLException
- if the URL is malformed- See Also:
-
equals
Determines if two IDs are equal. -
toString
Gets an external represenation of an ID.
-