~vcs-imports/xena/trunk

« back to all changes in this revision

Viewing changes to ext/src/javahelp/jhMaster/JavaHelp/src/new/javax/help/.svn/text-base/BadIDException.java.svn-base

  • Committer: matthewoliver
  • Date: 2009-12-10 03:18:07 UTC
  • Revision ID: vcs-imports@canonical.com-20091210031807-l086qguzdlljtkl9
Merged Xena Testing into Xena Stable for the Xena 5 release.

Show diffs side-by-side

added added

removed removed

Lines of Context:
 
1
/*
 
2
 * @(#)BadIDException.java      1.15 06/10/30
 
3
 * 
 
4
 * Copyright (c) 2006 Sun Microsystems, Inc.  All Rights Reserved.
 
5
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
 
6
 * 
 
7
 * This code is free software; you can redistribute it and/or modify it
 
8
 * under the terms of the GNU General Public License version 2 only, as
 
9
 * published by the Free Software Foundation.  Sun designates this
 
10
 * particular file as subject to the "Classpath" exception as provided
 
11
 * by Sun in the LICENSE file that accompanied this code.
 
12
 * 
 
13
 * This code is distributed in the hope that it will be useful, but WITHOUT
 
14
 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
 
15
 * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
 
16
 * version 2 for more details (a copy is included in the LICENSE file that
 
17
 * accompanied this code).
 
18
 * 
 
19
 * You should have received a copy of the GNU General Public License version
 
20
 * 2 along with this work; if not, write to the Free Software Foundation,
 
21
 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
 
22
 * 
 
23
 * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa Clara,
 
24
 * CA 95054 USA or visit www.sun.com if you need additional information or
 
25
 * have any questions.
 
26
 */
 
27
 
 
28
package javax.help;
 
29
 
 
30
/**
 
31
 * An ID was attempted to be created with incorrect arguments
 
32
 *
 
33
 * @author Roger D. Brinkley
 
34
 * @author Eduardo Pelegri-Llopart
 
35
 * @version     1.15    10/30/06
 
36
 */
 
37
 
 
38
public class BadIDException extends IllegalArgumentException {
 
39
    private Map map;
 
40
    private String id;
 
41
    private HelpSet hs;
 
42
 
 
43
    /**
 
44
     * Create the exception. Null values are allowed for each parameter.
 
45
     * 
 
46
     * @param map The Map in which the ID wasn't found
 
47
     * @param msg A generic message
 
48
     * @param id The ID in Map that wasn't found
 
49
     * @see javax.help.Map
 
50
     */
 
51
    public BadIDException(String msg, Map map, String id, HelpSet hs) {
 
52
        super(msg);
 
53
        this.map = map;
 
54
        this.id = id;
 
55
        this.hs = hs;
 
56
    }
 
57
 
 
58
    /**
 
59
     * The HelpSet in which the ID wasn't found
 
60
     */
 
61
    public Map getMap() {
 
62
        return map;
 
63
    }
 
64
 
 
65
    /**
 
66
     * The ID that wasn't found in the Map
 
67
     */
 
68
    public String getID() {
 
69
        return id;
 
70
    }
 
71
 
 
72
    /**
 
73
     * The HelpSet that wasn't found in the Map
 
74
     */
 
75
    public HelpSet getHelpSet() {
 
76
        return hs;
 
77
    }
 
78
}
 
79