private void _writeComponentSummary()

in maven-tagdoc-plugin/src/main/java/org/apache/myfaces/trinidadbuild/plugin/tagdoc/TagdocReport.java [683:779]
76 lines of code
8 McCabe index (conditional complexity)

  private void _writeComponentSummary(Writer out, ComponentBean bean, Map <String, List<QName>> contractMap) throws IOException
  {
    // In order to align all the Summary parts, create an HTML table.  The first column will be in bold, the second column in normal font.
    // The rows of the table are:
    // 1. Tag name
    // 2. Java class
    // 3. JavaScript class (optional)
    // 4. Component type
    // 5. Required ancestors (optional)
    // 6. Naming container (optional)
    // 7. Unsupported agents (optional)

    out.write("<div class=\'summary\'>\n");
    out.write("<table>\n");
    out.write("<tr>\n");
    out.write("<td><b>Tag Name:</b></td>");
    out.write("<td>&lt;" + _getQualifiedName(bean.getTagName()) + "&gt;</td>\n");
    out.write("</tr>\n");

    out.write("<tr>\n");
    out.write("<td><b>Java Class:</b></td>");
    String javadocURL = _platformAgnosticPath("../apidocs/" +
      bean.getComponentClass().replace('.', '/') + ".html");
    out.write("<td><a href=\"" + javadocURL + "\">");
    out.write(bean.getComponentClass());
    out.write("</a></td>\n");
    out.write("</tr>\n");

    // Write out the corresponding Java Script class for this component with a link to its JavaScript doc
    String jsClass = bean.getJsComponentClass();
    if (jsClass != null && !jsClass.isEmpty())
    {
      out.write("<tr>\n");
      out.write("<td><b>JavaScript Class:</b></td>");
      String jsdocURL = _platformAgnosticPath("../js_docs_out/" + jsClass.replace('.', '/') + ".html");
      out.write("<td><a href=\"" + jsdocURL + "\">");
      out.write(jsClass);
      out.write("</a></td>\n");
      out.write("</tr>\n");
    }

    out.write("<tr>\n");
    out.write("<td><b>Component Type:</b></td>");
    out.write("<td>" + bean.getComponentType() +  "</td>\n");
    out.write("</tr>\n");

    if (bean.hasRequiredAncestorContracts())
    {
      String formattedAncestors = _formatTagList ( bean.requiredAncestorContracts(),
                                                   contractMap,
                                                   null);
      out.write("<tr>\n");
      out.write("<td><b>Required Ancestor Tag(s):</b></td>");
      out.write("<td>" + formattedAncestors + "</td>");
      out.write("</tr>\n");
    }

    if (_isNamingContainer(bean))
    {
      out.write("<tr>\n");
      out.write("<td><b>Naming Container:</b></td>");
      out.write("<td>Yes.  When referring to children of this " +
                "component (\"partialTriggers\", <code>findComponent()</code>, etc.), " +
                "you must prefix the child's ID with this component's ID and a colon (':').</td>");
      out.write("</tr>\n");
    }

    String fmtd = _formatPropList(bean.getUnsupportedAgents(),
                                  null,
                                  _NON_DOCUMENTED_AGENTS);
    if (fmtd != null)
    {
      out.write("<tr>\n");
      out.write("<td><b>Unsupported Agent(s):</b></td>");
      out.write("<td>" + fmtd + "</td>");
      out.write("</tr>\n");
    }

    out.write("</table>\n");
    out.write("</div>\n");
    
    String deprecatedMessage = bean.getDeprecated();
    if (deprecatedMessage != null)
    {
      out.write("\n");
      out.write("<b>DEPRECATED: </b>");
      out.write(_preToSource(deprecatedMessage));
      out.write("\n");
    }

    String doc = bean.getLongDescription();
    if (doc == null)
      doc = bean.getDescription();

    out.write(_preToSource(doc));
    out.write("\n");
  }