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
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
package Torello.HTML.Tools.JavaDoc;

import Torello.HTML.*;
import Torello.HTML.NodeSearch.*;

import java.util.*;
import java.io.*;

/**
 * <CODE>JavaDoc Details-Part Constructor - Documentation.</CODE><BR /><BR />
 * <EMBED CLASS="external-html" DATA-FILE-ID="DPC">
 * <EMBED CLASS=globalDefs DATA-SECTION=Constructor DATA-ITER=constructorDetailsIterator>
 * <!-- Above Defs are used inside DATA-FILE-ID ==> JDOCDETEX, JDOCPARAM, DETTOPPART -->
 */
@StaticFunctional
public class DetailsPartConstructor
{
    private DetailsPartConstructor() { }

    /**
     * <EMBED CLASS='external-html' DATA-FILE-ID=DETTOPPART>
     * <BR /><BR />This retrieves the <i>constructor name</I> vectorized-HTML.
     * 
     * <DIV CLASS="HTML">{@code
     * <h4> [Class Name] </h4>
     * }</DIV>
     * 
     * @param javaDocConstructorHTML <EMBED CLASS='external-html' DATA-FILE-ID=JDOCPARAM>
     * @return {@code DotPair} pointing to HTML for the <B>'Constructor Name'</B> part.
     * @throws DetailsException <EMBED CLASS='external-html' DATA-FILE-ID=JDOCDETEX>
     * @see DetailsException
     * @see TagNodeFindInclusive
     * @see Details#constructorDetailsIterator(Vector)
     */
    public static DotPair name(Vector<HTMLNode> javaDocConstructorHTML)
    {
        DetailsException.check(javaDocConstructorHTML);
        return TagNodeFindInclusive.first(javaDocConstructorHTML, "h4");
    }

    /**
     * <EMBED CLASS='external-html' DATA-FILE-ID=DETTOPPART>
     * <BR /><BR />This retrieves the <i>constructor signature</I> vectorized-HTML.
     * 
     * <DIV CLASS="HTML">{@code
     * <h4> [Class Name] </h4>
     * <pre> ... </pre>
     * }</DIV>
     * 
     * @param javaDocConstructorHTML <EMBED CLASS='external-html' DATA-FILE-ID=JDOCPARAM>
     * @return {@code DotPair} pointing to HTML for the <B>'Constructor Signature'</B> part.
     * @throws DetailsException <EMBED CLASS='external-html' DATA-FILE-ID=JDOCDETEX>
     * @see DetailsException
     * @see TagNodeFindInclusive
     * @see Details#constructorDetailsIterator(Vector)
     */
    public static DotPair signature(Vector<HTMLNode> javaDocConstructorHTML)
    {
        DetailsException.check(javaDocConstructorHTML);
        return TagNodeFindInclusive.first(javaDocConstructorHTML, "pre");
    }

    /**
     * <EMBED CLASS='external-html' DATA-FILE-ID=DETTOPPART>
     * <BR /><BR />This retrieves the <i>constructor description</I> vectorized-HTML.
     * 
     * <DIV CLASS="HTML">{@code
     * <div class="block"> ... [Textual Description of Constructor] ... </div>
     * }</DIV>
     * 
     * @param javaDocConstructorHTML <EMBED CLASS='external-html' DATA-FILE-ID=JDOCPARAM>
     * @return {@code DotPair} pointing to HTML for the <B>'Constructor Description'</B> part.
     * @throws DetailsException <EMBED CLASS='external-html' DATA-FILE-ID=JDOCDETEX>
     * @see DetailsException
     * @see InnerTagFindInclusive
     * @see Details#constructorDetailsIterator(Vector)
     */
    public static DotPair description(Vector<HTMLNode> javaDocConstructorHTML)
    {
        DetailsException.check(javaDocConstructorHTML);
        return InnerTagFindInclusive.first(javaDocConstructorHTML, "div", "class", TextComparitor.C, "block");
    }

    /**
     * <EMBED CLASS='external-html' DATA-FILE-ID=DETTOPPART>
     * <BR /><BR />This retrieves the <i>constructor parameters</I> vectorized-HTML.
     * 
     * <DIV CLASS="HTML">{@code
     * <dt><span class="paramLabel">Parameters:</span></dt>
     * <dd>...
     * }</DIV>
     * 
     * @param javaDocConstructorHTML <EMBED CLASS='external-html' DATA-FILE-ID=JDOCPARAM>
     * @return {@code DotPair} pointing to HTML for the <B>'Constructor Parameters'</B> part.
     * <BR /><BR />Null will be returned if this HTML class description page for the
     * {@code Constructor} that is passed does not contain a <B>'parameters'</B> section.
     * @throws DetailsException <EMBED CLASS='external-html' DATA-FILE-ID=JDOCDETEX>
     * @see HELPER#getSpanSection(Vector, String)
     */
    public static DotPair parameters(Vector<HTMLNode> javaDocConstructorHTML)
    { return HELPER.getSpanSection(javaDocConstructorHTML, "paramLabel"); }

    /**
     * <EMBED CLASS='external-html' DATA-FILE-ID=DETTOPPART>
     * <BR /><BR />This retrieves the <i>constructor throws</I> vectorized-HTML.
     * 
     * <DIV CLASS="HTML">{@code
     * <dt><span class="throwsLabel">Throws:</span></dt>
     * <dd>...
     * }</DIV>
     * 
     * @param javaDocConstructorHTML <EMBED CLASS='external-html' DATA-FILE-ID=JDOCPARAM>
     * @return {@code DotPair} pointing to HTML for the <B>'Constructor Throws'</B> part.
     * <BR /><BR />Null will be returned if this HTML class description page for the
     * {@code Constructor} that is passed does not contain a <B>'throws'</B> section.
     * @throws DetailsException <EMBED CLASS='external-html' DATA-FILE-ID=JDOCDETEX>
     * @see HELPER#getSpanSection(Vector, String)
     */
    public static DotPair throwing(Vector<HTMLNode> javaDocConstructorHTML)
    { return HELPER.getSpanSection(javaDocConstructorHTML, "throwsLabel"); }

    /**
     * <EMBED CLASS='external-html' DATA-FILE-ID=DETTOPPART>
     * <BR /><BR />This retrieves the <i>constructor see also</I> vectorized-HTML.
     * 
     * <DIV CLASS="HTML">{@code
     * <dt><span class="seeLabel">See Also:</span></dt>
     * <dd>...
     * }</DIV>
     * 
     * @param javaDocConstructorHTML <EMBED CLASS='external-html' DATA-FILE-ID=JDOCPARAM>
     * @return {@code DotPair} pointing to HTML for the <B>'Constructor See Also'</B> part.
     * <BR /><BR />Null will be returned if this HTML class description page for the
     * {@code Constructor} that is passed does not contain a <B>'see also'</B> section.
     * @throws DetailsException <EMBED CLASS='external-html' DATA-FILE-ID=JDOCDETEX>
     * @see HELPER#getSpanSection(Vector, String)
     */
    public static DotPair see(Vector<HTMLNode> javaDocConstructorHTML)
    { return HELPER.getSpanSection(javaDocConstructorHTML, "seeLabel"); }


    /**
     * <EMBED CLASS='external-html' DATA-FILE-ID=DETTOPPART>
     * <BR /><BR />This retrieves the <i>constructor "Specified by"</I> vectorized-HTML.
     * 
     * <DIV CLASS="HTML">{@code
     * <dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
     * <dd>...
     * }</DIV>
     * 
     * @param javaDocConstructorHTML <EMBED CLASS='external-html' DATA-FILE-ID=JDOCPARAM>
     * @return {@code DotPair} pointing to HTML for the <B>'Constructor Specified By'</B> part.
     * <BR /><BR />Null will be returned if this HTML class description page for the
     * {@code Constructor} that is passed does not contain a <B>'specified by'</B> section.
     * @throws DetailsException <EMBED CLASS='external-html' DATA-FILE-ID=JDOCDETEX>
     * @see HELPER#getSpanSection(Vector, String)
     */
    public static DotPair overrideSpecify(Vector<HTMLNode> javaDocConstructorHTML)
    { return HELPER.getSpanSection(javaDocConstructorHTML, "overrideSpecifyLabel"); }
}