001package Torello.HTML.Tools.JavaDoc;
002
003import Torello.HTML.*;
004import Torello.HTML.NodeSearch.*;
005
006import java.util.*;
007import java.io.*;
008
009/**
010 * <CODE>JavaDoc Details-Part Constructor - Documentation.</CODE><BR /><BR />
011 * <EMBED CLASS="external-html" DATA-FILE-ID="DPC">
012 * <EMBED CLASS=globalDefs DATA-SECTION=Constructor DATA-ITER=constructorDetailsIterator>
013 * <!-- Above Defs are used inside DATA-FILE-ID ==> JDOCDETEX, JDOCPARAM, DETTOPPART -->
014 */
015@StaticFunctional
016public class DetailsPartConstructor
017{
018    private DetailsPartConstructor() { }
019
020    /**
021     * <EMBED CLASS='external-html' DATA-FILE-ID=DETTOPPART>
022     * <BR /><BR />This retrieves the <i>constructor name</I> vectorized-HTML.
023     * 
024     * <DIV CLASS="HTML">{@code
025     * <h4> [Class Name] </h4>
026     * }</DIV>
027     * 
028     * @param javaDocConstructorHTML <EMBED CLASS='external-html' DATA-FILE-ID=JDOCPARAM>
029     * @return {@code DotPair} pointing to HTML for the <B>'Constructor Name'</B> part.
030     * @throws DetailsException <EMBED CLASS='external-html' DATA-FILE-ID=JDOCDETEX>
031     * @see DetailsException
032     * @see TagNodeFindInclusive
033     * @see Details#constructorDetailsIterator(Vector)
034     */
035    public static DotPair name(Vector<HTMLNode> javaDocConstructorHTML)
036    {
037        DetailsException.check(javaDocConstructorHTML);
038        return TagNodeFindInclusive.first(javaDocConstructorHTML, "h4");
039    }
040
041    /**
042     * <EMBED CLASS='external-html' DATA-FILE-ID=DETTOPPART>
043     * <BR /><BR />This retrieves the <i>constructor signature</I> vectorized-HTML.
044     * 
045     * <DIV CLASS="HTML">{@code
046     * <h4> [Class Name] </h4>
047     * <pre> ... </pre>
048     * }</DIV>
049     * 
050     * @param javaDocConstructorHTML <EMBED CLASS='external-html' DATA-FILE-ID=JDOCPARAM>
051     * @return {@code DotPair} pointing to HTML for the <B>'Constructor Signature'</B> part.
052     * @throws DetailsException <EMBED CLASS='external-html' DATA-FILE-ID=JDOCDETEX>
053     * @see DetailsException
054     * @see TagNodeFindInclusive
055     * @see Details#constructorDetailsIterator(Vector)
056     */
057    public static DotPair signature(Vector<HTMLNode> javaDocConstructorHTML)
058    {
059        DetailsException.check(javaDocConstructorHTML);
060        return TagNodeFindInclusive.first(javaDocConstructorHTML, "pre");
061    }
062
063    /**
064     * <EMBED CLASS='external-html' DATA-FILE-ID=DETTOPPART>
065     * <BR /><BR />This retrieves the <i>constructor description</I> vectorized-HTML.
066     * 
067     * <DIV CLASS="HTML">{@code
068     * <div class="block"> ... [Textual Description of Constructor] ... </div>
069     * }</DIV>
070     * 
071     * @param javaDocConstructorHTML <EMBED CLASS='external-html' DATA-FILE-ID=JDOCPARAM>
072     * @return {@code DotPair} pointing to HTML for the <B>'Constructor Description'</B> part.
073     * @throws DetailsException <EMBED CLASS='external-html' DATA-FILE-ID=JDOCDETEX>
074     * @see DetailsException
075     * @see InnerTagFindInclusive
076     * @see Details#constructorDetailsIterator(Vector)
077     */
078    public static DotPair description(Vector<HTMLNode> javaDocConstructorHTML)
079    {
080        DetailsException.check(javaDocConstructorHTML);
081        return InnerTagFindInclusive.first(javaDocConstructorHTML, "div", "class", TextComparitor.C, "block");
082    }
083
084    /**
085     * <EMBED CLASS='external-html' DATA-FILE-ID=DETTOPPART>
086     * <BR /><BR />This retrieves the <i>constructor parameters</I> vectorized-HTML.
087     * 
088     * <DIV CLASS="HTML">{@code
089     * <dt><span class="paramLabel">Parameters:</span></dt>
090     * <dd>...
091     * }</DIV>
092     * 
093     * @param javaDocConstructorHTML <EMBED CLASS='external-html' DATA-FILE-ID=JDOCPARAM>
094     * @return {@code DotPair} pointing to HTML for the <B>'Constructor Parameters'</B> part.
095     * <BR /><BR />Null will be returned if this HTML class description page for the
096     * {@code Constructor} that is passed does not contain a <B>'parameters'</B> section.
097     * @throws DetailsException <EMBED CLASS='external-html' DATA-FILE-ID=JDOCDETEX>
098     * @see HELPER#getSpanSection(Vector, String)
099     */
100    public static DotPair parameters(Vector<HTMLNode> javaDocConstructorHTML)
101    { return HELPER.getSpanSection(javaDocConstructorHTML, "paramLabel"); }
102
103    /**
104     * <EMBED CLASS='external-html' DATA-FILE-ID=DETTOPPART>
105     * <BR /><BR />This retrieves the <i>constructor throws</I> vectorized-HTML.
106     * 
107     * <DIV CLASS="HTML">{@code
108     * <dt><span class="throwsLabel">Throws:</span></dt>
109     * <dd>...
110     * }</DIV>
111     * 
112     * @param javaDocConstructorHTML <EMBED CLASS='external-html' DATA-FILE-ID=JDOCPARAM>
113     * @return {@code DotPair} pointing to HTML for the <B>'Constructor Throws'</B> part.
114     * <BR /><BR />Null will be returned if this HTML class description page for the
115     * {@code Constructor} that is passed does not contain a <B>'throws'</B> section.
116     * @throws DetailsException <EMBED CLASS='external-html' DATA-FILE-ID=JDOCDETEX>
117     * @see HELPER#getSpanSection(Vector, String)
118     */
119    public static DotPair throwing(Vector<HTMLNode> javaDocConstructorHTML)
120    { return HELPER.getSpanSection(javaDocConstructorHTML, "throwsLabel"); }
121
122    /**
123     * <EMBED CLASS='external-html' DATA-FILE-ID=DETTOPPART>
124     * <BR /><BR />This retrieves the <i>constructor see also</I> vectorized-HTML.
125     * 
126     * <DIV CLASS="HTML">{@code
127     * <dt><span class="seeLabel">See Also:</span></dt>
128     * <dd>...
129     * }</DIV>
130     * 
131     * @param javaDocConstructorHTML <EMBED CLASS='external-html' DATA-FILE-ID=JDOCPARAM>
132     * @return {@code DotPair} pointing to HTML for the <B>'Constructor See Also'</B> part.
133     * <BR /><BR />Null will be returned if this HTML class description page for the
134     * {@code Constructor} that is passed does not contain a <B>'see also'</B> section.
135     * @throws DetailsException <EMBED CLASS='external-html' DATA-FILE-ID=JDOCDETEX>
136     * @see HELPER#getSpanSection(Vector, String)
137     */
138    public static DotPair see(Vector<HTMLNode> javaDocConstructorHTML)
139    { return HELPER.getSpanSection(javaDocConstructorHTML, "seeLabel"); }
140
141
142    /**
143     * <EMBED CLASS='external-html' DATA-FILE-ID=DETTOPPART>
144     * <BR /><BR />This retrieves the <i>constructor "Specified by"</I> vectorized-HTML.
145     * 
146     * <DIV CLASS="HTML">{@code
147     * <dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
148     * <dd>...
149     * }</DIV>
150     * 
151     * @param javaDocConstructorHTML <EMBED CLASS='external-html' DATA-FILE-ID=JDOCPARAM>
152     * @return {@code DotPair} pointing to HTML for the <B>'Constructor Specified By'</B> part.
153     * <BR /><BR />Null will be returned if this HTML class description page for the
154     * {@code Constructor} that is passed does not contain a <B>'specified by'</B> section.
155     * @throws DetailsException <EMBED CLASS='external-html' DATA-FILE-ID=JDOCDETEX>
156     * @see HELPER#getSpanSection(Vector, String)
157     */
158    public static DotPair overrideSpecify(Vector<HTMLNode> javaDocConstructorHTML)
159    { return HELPER.getSpanSection(javaDocConstructorHTML, "overrideSpecifyLabel"); }
160}