001package Torello.HTML;
002
003/**
004 * Tag Criteria - An enumeration that allows a user to specify which type of tag's are being
005 * requested when searching a web-page for HTML-Tags.
006 * 
007 * <EMBED CLASS='external-html' DATA-FILE-ID=TCEN>
008 */
009public enum TC
010{
011    /**
012     * OpeningTags indicates HTML <CODE>TagNode's</CODE> that constitute the first of a two
013     * {@code TagNode} pair like:
014     * <CODE>&lt;DIV&gt;</CODE> rather than / as opposed to <CODE>&lt;/DIV&gt;</CODE>
015     */
016    OpeningTags,
017
018    /**
019     * ClosingTag indicates HTML <CODE>TagNode's</CODE> that constitute the second of the two
020     * {@code TagNode} pair such as:
021     * <CODE>&lt;/A&gt;</CODE>, rather than {@code <A HREF=...>}
022     */
023    ClosingTags,
024
025    // NOTE: Use the HTML 'CODE' element instead of curly-brace AT code, because it fixed the
026    // issue.  Don't ask.
027    // TO-DO: Figure out why using curly-brace AT code ... for the anchor-tag actually broke
028    // Balance-Validity Report.
029    // WHY: ? the Javadoc Tool usually (heavy emphasis on 'usually') escapes HTML that is between
030    // the code tags.
031    // It wasn't doing the escape in the above comment.
032
033    /**
034     * The <CODE>TC.Both</CODE> enumerated type indicates that either of these scenarios
035     * will satisfy the search criteria.
036     */
037    Both;
038}