1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57

package Torello.HTML;

// These are only needed for the Java Doc {@link ...} taglets.
import Torello.HTML.NodeSearch.InnerTagPeekInclusive;
import Torello.HTML.NodeSearch.TagNodePeekInclusive;

/**
 * In order for a set or collection of <CODE>&lt;{@link Replaceable}&gt;</CODE> to work properly
 * during an update or replacement, the set or collection ({@code Iterable}) of
 * {@code Replaceable's} must be properly sorted and the pieces may not overlap (as per their
 * <B><I>original-locations</I></B>).  Furthermore, their original-location values must all point
 * to indices that are actually within the HTML-{@code Vector's} bounds.
 * 
 * This is the parent exception of any &amp; all exceptions
 * that may occur if these requirements aren't met.  These inheriting-exceptions are listed below:
 * 
 * <BR /><BR /><UL CLASS=JDUL>
 * <LI>
 *      <B>{@link ReplaceablesOverlappingException}</B> -
 *      If two consecutive {@code Replaceable} instances (consecutively returned by an
 *      {@code Iterator} on a Set or Collection) have any <B><I>original-location</B></I>
 *      HTML-{@code Vector} indices that are overlapping.
 *      <BR /><BR />
 *      </LI>
 * <LI>
 *      <B>{@link ReplaceablesUnsortedException}</B> -
 *      If two consecutive {@code Replaceable} instances (consecutively returned by an
 *      {@code Iterator} on a Set or Collection) have <B><I>original</I></B> HTML-{@code Vector}
 *      <B><I>starting-locations</I></B> that are not ordered.
 *      <BR /><BR />
 *      </LI>
 * <LI>
 *      <B>{@link ReplaceableOutOfBoundsException}</B> -
 *      If either the starting or ending original-location of a {@code Replaceable} is not within
 *      bounds of an HTML-{@code Vector}.
 *      </LI>
 * </UL>
 * 
 * <BR /><BR />This class may be used for other purposes not currently employed within the standard
 * Java HTML JAR Library.
 */
public class ReplaceableException extends RuntimeException
{
    /** <EMBED CLASS='external-html' DATA-FILE-ID=SVUIDEX> */
    public static final long serialVersionUID = 1;

    /** Constructs a {@code ReplaceableException} with no detail message. */
    public ReplaceableException()
    { super(); }

    /**
     * Constructs a {@code ReplaceableException} with the specified detail message.
     * @param message the detail message.
     */
    public ReplaceableException(String message)
    { super(message); }
}