http://git-wip-us.apache.org/repos/asf/creadur-site/blob/3e6a0709/rat/apache-rat-core/apidocs/org/apache/rat/ReportConfiguration.html ---------------------------------------------------------------------- diff --git a/rat/apache-rat-core/apidocs/org/apache/rat/ReportConfiguration.html b/rat/apache-rat-core/apidocs/org/apache/rat/ReportConfiguration.html index 374df80..c8ab885 100644 --- a/rat/apache-rat-core/apidocs/org/apache/rat/ReportConfiguration.html +++ b/rat/apache-rat-core/apidocs/org/apache/rat/ReportConfiguration.html @@ -1,457 +1,463 @@ -<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> -<!--NewPage--> -<HTML> -<HEAD> -<META http-equiv="Content-Type" content="text/html; charset=UTF-8"> -<TITLE> -ReportConfiguration (Apache Creadur Rat::Core 0.11 API) -</TITLE> - -<META NAME="keywords" CONTENT="org.apache.rat.ReportConfiguration class"> - -<LINK REL ="stylesheet" TYPE="text/css" HREF="../../../stylesheet.css" TITLE="Style"> - -<SCRIPT type="text/javascript"> -function windowTitle() -{ - parent.document.title="ReportConfiguration (Apache Creadur Rat::Core 0.11 API)"; -} -</SCRIPT> -<NOSCRIPT> -</NOSCRIPT> - -</HEAD> - -<BODY BGCOLOR="white" onload="windowTitle();"> - - -<!-- ========= START OF TOP NAVBAR ======= --> -<A NAME="navbar_top"><!-- --></A> -<A HREF="#skip-navbar_top" title="Skip navigation links"></A> -<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY=""> -<TR> -<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> -<A NAME="navbar_top_firstrow"><!-- --></A> -<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY=""> - <TR ALIGN="center" VALIGN="top"> - <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD> - <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD> - <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD> - <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/ReportConfiguration.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A> </TD> - <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD> - <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD> - <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD> - <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD> - </TR> -</TABLE> -</TD> -<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM> -</EM> -</TD> -</TR> - -<TR> -<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> - <A HREF="../../../org/apache/rat/Report.html" title="class in org.apache.rat"><B>PREV CLASS</B></A> - NEXT CLASS</FONT></TD> -<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> - <A HREF="../../../index.html?org/apache/rat/ReportConfiguration.html" target="_top"><B>FRAMES</B></A> - <A HREF="ReportConfiguration.html" target="_top"><B>NO FRAMES</B></A> - <SCRIPT type="text/javascript"> - <!-- - if(window==top) { - document.writeln('<A HREF="../../../allclasses-noframe.html"><B>All Classes</B></A>'); - } - //--> -</SCRIPT> -<NOSCRIPT> - <A HREF="../../../allclasses-noframe.html"><B>All Classes</B></A> -</NOSCRIPT> - - -</FONT></TD> -</TR> -<TR> -<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> - SUMMARY: NESTED | FIELD | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD> -<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> -DETAIL: FIELD | <A HREF="#constructor_detail">CONSTR</A> | <A HREF="#method_detail">METHOD</A></FONT></TD> -</TR> -</TABLE> -<A NAME="skip-navbar_top"></A> -<!-- ========= END OF TOP NAVBAR ========= --> - -<HR> -<!-- ======== START OF CLASS DATA ======== --> -<H2> -<FONT SIZE="-1"> -org.apache.rat</FONT> -<BR> -Class ReportConfiguration</H2> -<PRE> -<A HREF="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html" title="class or interface in java.lang">java.lang.Object</A> - <IMG SRC="../../../resources/inherit.gif" ALT="extended by "><B>org.apache.rat.ReportConfiguration</B> -</PRE> -<HR> -<DL> -<DT><PRE>public class <B>ReportConfiguration</B><DT>extends <A HREF="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html" title="class or interface in java.lang">Object</A></DL> -</PRE> - -<P> -A configuration object is used by the frontend to invoke the - <A HREF="../../../org/apache/rat/Report.html" title="class in org.apache.rat"><CODE>Report</CODE></A>. Basically, the sole purpose of the frontends is - to create the configuration and invoke the <A HREF="../../../org/apache/rat/Report.html" title="class in org.apache.rat"><CODE>Report</CODE></A>. -<P> - -<P> -<HR> - -<P> - -<!-- ======== CONSTRUCTOR SUMMARY ======== --> - -<A NAME="constructor_summary"><!-- --></A> -<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> -<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> -<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2"> -<B>Constructor Summary</B></FONT></TH> -</TR> -<TR BGCOLOR="white" CLASS="TableRowColor"> -<TD><CODE><B><A HREF="../../../org/apache/rat/ReportConfiguration.html#ReportConfiguration()">ReportConfiguration</A></B>()</CODE> - -<BR> - </TD> -</TR> -</TABLE> - -<!-- ========== METHOD SUMMARY =========== --> - -<A NAME="method_summary"><!-- --></A> -<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> -<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> -<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2"> -<B>Method Summary</B></FONT></TH> -</TR> -<TR BGCOLOR="white" CLASS="TableRowColor"> -<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> -<CODE> <A HREF="../../../org/apache/rat/license/ILicenseFamily.html" title="interface in org.apache.rat.license">ILicenseFamily</A>[]</CODE></FONT></TD> -<TD><CODE><B><A HREF="../../../org/apache/rat/ReportConfiguration.html#getApprovedLicenseNames()">getApprovedLicenseNames</A></B>()</CODE> - -<BR> - Returns the set of approved license names.</TD> -</TR> -<TR BGCOLOR="white" CLASS="TableRowColor"> -<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> -<CODE> <A HREF="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A></CODE></FONT></TD> -<TD><CODE><B><A HREF="../../../org/apache/rat/ReportConfiguration.html#getCopyrightMessage()">getCopyrightMessage</A></B>()</CODE> - -<BR> - </TD> -</TR> -<TR BGCOLOR="white" CLASS="TableRowColor"> -<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> -<CODE> <A HREF="../../../org/apache/rat/analysis/IHeaderMatcher.html" title="interface in org.apache.rat.analysis">IHeaderMatcher</A></CODE></FONT></TD> -<TD><CODE><B><A HREF="../../../org/apache/rat/ReportConfiguration.html#getHeaderMatcher()">getHeaderMatcher</A></B>()</CODE> - -<BR> - Returns the header matcher.</TD> -</TR> -<TR BGCOLOR="white" CLASS="TableRowColor"> -<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> -<CODE> boolean</CODE></FONT></TD> -<TD><CODE><B><A HREF="../../../org/apache/rat/ReportConfiguration.html#isAddingLicenses()">isAddingLicenses</A></B>()</CODE> - -<BR> - </TD> -</TR> -<TR BGCOLOR="white" CLASS="TableRowColor"> -<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> -<CODE> boolean</CODE></FONT></TD> -<TD><CODE><B><A HREF="../../../org/apache/rat/ReportConfiguration.html#isAddingLicensesForced()">isAddingLicensesForced</A></B>()</CODE> - -<BR> - </TD> -</TR> -<TR BGCOLOR="white" CLASS="TableRowColor"> -<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> -<CODE> void</CODE></FONT></TD> -<TD><CODE><B><A HREF="../../../org/apache/rat/ReportConfiguration.html#setAddingLicenses(boolean)">setAddingLicenses</A></B>(boolean addingLicenses)</CODE> - -<BR> - Returns, whether Rat should add missing license headers.</TD> -</TR> -<TR BGCOLOR="white" CLASS="TableRowColor"> -<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> -<CODE> void</CODE></FONT></TD> -<TD><CODE><B><A HREF="../../../org/apache/rat/ReportConfiguration.html#setAddingLicensesForced(boolean)">setAddingLicensesForced</A></B>(boolean addingLicensesForced)</CODE> - -<BR> - If Rat is adding license headers: Sets, whether adding - license headers is enforced.</TD> -</TR> -<TR BGCOLOR="white" CLASS="TableRowColor"> -<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> -<CODE> void</CODE></FONT></TD> -<TD><CODE><B><A HREF="../../../org/apache/rat/ReportConfiguration.html#setApprovedLicenseNames(org.apache.rat.license.ILicenseFamily[])">setApprovedLicenseNames</A></B>(<A HREF="../../../org/apache/rat/license/ILicenseFamily.html" title="interface in org.apache.rat.license">ILicenseFamily</A>[] approvedLicenseNames)</CODE> - -<BR> - Sets the set of approved license names.</TD> -</TR> -<TR BGCOLOR="white" CLASS="TableRowColor"> -<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> -<CODE> void</CODE></FONT></TD> -<TD><CODE><B><A HREF="../../../org/apache/rat/ReportConfiguration.html#setCopyrightMessage(java.lang.String)">setCopyrightMessage</A></B>(<A HREF="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> copyrightMessage)</CODE> - -<BR> - If Rat is adding license headers: Sets the optional - copyright message.</TD> -</TR> -<TR BGCOLOR="white" CLASS="TableRowColor"> -<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> -<CODE> void</CODE></FONT></TD> -<TD><CODE><B><A HREF="../../../org/apache/rat/ReportConfiguration.html#setHeaderMatcher(org.apache.rat.analysis.IHeaderMatcher)">setHeaderMatcher</A></B>(<A HREF="../../../org/apache/rat/analysis/IHeaderMatcher.html" title="interface in org.apache.rat.analysis">IHeaderMatcher</A> headerMatcher)</CODE> - -<BR> - Sets the header matcher.</TD> -</TR> -</TABLE> - <A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A> -<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> -<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor"> -<TH ALIGN="left"><B>Methods inherited from class java.lang.<A HREF="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html" title="class or interface in java.lang">Object</A></B></TH> -</TR> -<TR BGCOLOR="white" CLASS="TableRowColor"> -<TD><CODE><A HREF="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html#clone()" title="class or interface in java.lang">clone</A>, <A HREF="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html#equals(java.lang.Object)" title="class or interface in java.lang">equals</A>, <A HREF="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html#finalize()" title="class or interface in java.lang">finalize</A>, <A HREF="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html#getClass()" title="class or interface in java.lang">getClass</A>, <A HREF="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html#hashCode()" title="class or interface in java.lang">hashCode</A>, <A HREF="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html#notify()" title="class or interface in java.lang">notify</A>, <A HREF="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html#notifyAll()" title="class or interface in java.lang">noti fyAll</A>, <A HREF="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html#toString()" title="class or interface in java.lang">toString</A>, <A HREF="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html#wait()" title="class or interface in java.lang">wait</A>, <A HREF="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html#wait(long)" title="class or interface in java.lang">wait</A>, <A HREF="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html#wait(long, int)" title="class or interface in java.lang">wait</A></CODE></TD> -</TR> -</TABLE> - -<P> - -<!-- ========= CONSTRUCTOR DETAIL ======== --> - -<A NAME="constructor_detail"><!-- --></A> -<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> -<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> -<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2"> -<B>Constructor Detail</B></FONT></TH> -</TR> -</TABLE> - -<A NAME="ReportConfiguration()"><!-- --></A><H3> -ReportConfiguration</H3> -<PRE> -public <B>ReportConfiguration</B>()</PRE> -<DL> -</DL> - -<!-- ============ METHOD DETAIL ========== --> - -<A NAME="method_detail"><!-- --></A> -<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> -<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> -<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2"> -<B>Method Detail</B></FONT></TH> -</TR> -</TABLE> - -<A NAME="getHeaderMatcher()"><!-- --></A><H3> -getHeaderMatcher</H3> -<PRE> -public <A HREF="../../../org/apache/rat/analysis/IHeaderMatcher.html" title="interface in org.apache.rat.analysis">IHeaderMatcher</A> <B>getHeaderMatcher</B>()</PRE> -<DL> -<DD>Returns the header matcher. -<P> -<DD><DL> - -<DT><B>Returns:</B><DD>the header matcher.</DL> -</DD> -</DL> -<HR> - -<A NAME="setHeaderMatcher(org.apache.rat.analysis.IHeaderMatcher)"><!-- --></A><H3> -setHeaderMatcher</H3> -<PRE> -public void <B>setHeaderMatcher</B>(<A HREF="../../../org/apache/rat/analysis/IHeaderMatcher.html" title="interface in org.apache.rat.analysis">IHeaderMatcher</A> headerMatcher)</PRE> -<DL> -<DD>Sets the header matcher. -<P> -<DD><DL> -<DT><B>Parameters:</B><DD><CODE>headerMatcher</CODE> - header matcher.</DL> -</DD> -</DL> -<HR> - -<A NAME="getApprovedLicenseNames()"><!-- --></A><H3> -getApprovedLicenseNames</H3> -<PRE> -public <A HREF="../../../org/apache/rat/license/ILicenseFamily.html" title="interface in org.apache.rat.license">ILicenseFamily</A>[] <B>getApprovedLicenseNames</B>()</PRE> -<DL> -<DD>Returns the set of approved license names. -<P> -<DD><DL> - -<DT><B>Returns:</B><DD>the set of approved license names.</DL> -</DD> -</DL> -<HR> - -<A NAME="setApprovedLicenseNames(org.apache.rat.license.ILicenseFamily[])"><!-- --></A><H3> -setApprovedLicenseNames</H3> -<PRE> -public void <B>setApprovedLicenseNames</B>(<A HREF="../../../org/apache/rat/license/ILicenseFamily.html" title="interface in org.apache.rat.license">ILicenseFamily</A>[] approvedLicenseNames)</PRE> -<DL> -<DD>Sets the set of approved license names. -<P> -<DD><DL> -<DT><B>Parameters:</B><DD><CODE>approvedLicenseNames</CODE> - set of approved license names.</DL> -</DD> -</DL> -<HR> - -<A NAME="getCopyrightMessage()"><!-- --></A><H3> -getCopyrightMessage</H3> -<PRE> -public <A HREF="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> <B>getCopyrightMessage</B>()</PRE> -<DL> -<DD><DL> - -<DT><B>Returns:</B><DD>If Rat is adding license headers: Returns the optional - copyright message. This value is ignored, if no - license headers are added.<DT><B>See Also:</B><DD><A HREF="../../../org/apache/rat/ReportConfiguration.html#isAddingLicenses()"><CODE>isAddingLicenses()</CODE></A></DL> -</DD> -</DL> -<HR> - -<A NAME="setCopyrightMessage(java.lang.String)"><!-- --></A><H3> -setCopyrightMessage</H3> -<PRE> -public void <B>setCopyrightMessage</B>(<A HREF="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> copyrightMessage)</PRE> -<DL> -<DD>If Rat is adding license headers: Sets the optional - copyright message. This value is ignored, if no - license headers are added. -<P> -<DD><DL> -<DT><B>Parameters:</B><DD><CODE>copyrightMessage</CODE> - message to set.<DT><B>See Also:</B><DD><A HREF="../../../org/apache/rat/ReportConfiguration.html#setAddingLicenses(boolean)"><CODE>setAddingLicenses(boolean)</CODE></A></DL> -</DD> -</DL> -<HR> - -<A NAME="isAddingLicensesForced()"><!-- --></A><H3> -isAddingLicensesForced</H3> -<PRE> -public boolean <B>isAddingLicensesForced</B>()</PRE> -<DL> -<DD><DL> - -<DT><B>Returns:</B><DD>If Rat is adding license headers: Returns, whether adding - license headers is enforced. This value is ignored, if no - license headers are added.<DT><B>See Also:</B><DD><A HREF="../../../org/apache/rat/ReportConfiguration.html#isAddingLicenses()"><CODE>isAddingLicenses()</CODE></A></DL> -</DD> -</DL> -<HR> - -<A NAME="setAddingLicensesForced(boolean)"><!-- --></A><H3> -setAddingLicensesForced</H3> -<PRE> -public void <B>setAddingLicensesForced</B>(boolean addingLicensesForced)</PRE> -<DL> -<DD>If Rat is adding license headers: Sets, whether adding - license headers is enforced. This value is ignored, if no - license headers are added. -<P> -<DD><DL> -<DT><B>Parameters:</B><DD><CODE>addingLicensesForced</CODE> - enable/disable forcibly adding licenses.<DT><B>See Also:</B><DD><A HREF="../../../org/apache/rat/ReportConfiguration.html#isAddingLicenses()"><CODE>isAddingLicenses()</CODE></A></DL> -</DD> -</DL> -<HR> - -<A NAME="isAddingLicenses()"><!-- --></A><H3> -isAddingLicenses</H3> -<PRE> -public boolean <B>isAddingLicenses</B>()</PRE> -<DL> -<DD><DL> - -<DT><B>Returns:</B><DD>Returns, whether Rat should add missing license headers.<DT><B>See Also:</B><DD><A HREF="../../../org/apache/rat/ReportConfiguration.html#isAddingLicensesForced()"><CODE>isAddingLicensesForced()</CODE></A>, -<A HREF="../../../org/apache/rat/ReportConfiguration.html#getCopyrightMessage()"><CODE>getCopyrightMessage()</CODE></A></DL> -</DD> -</DL> -<HR> - -<A NAME="setAddingLicenses(boolean)"><!-- --></A><H3> -setAddingLicenses</H3> -<PRE> -public void <B>setAddingLicenses</B>(boolean addingLicenses)</PRE> -<DL> -<DD>Returns, whether Rat should add missing license headers. -<P> -<DD><DL> -<DT><B>Parameters:</B><DD><CODE>addingLicenses</CODE> - enabled/disables adding of licenses.<DT><B>See Also:</B><DD><A HREF="../../../org/apache/rat/ReportConfiguration.html#setAddingLicensesForced(boolean)"><CODE>setAddingLicensesForced(boolean)</CODE></A>, -<A HREF="../../../org/apache/rat/ReportConfiguration.html#setCopyrightMessage(java.lang.String)"><CODE>setCopyrightMessage(String)</CODE></A></DL> -</DD> -</DL> -<!-- ========= END OF CLASS DATA ========= --> -<HR> - - -<!-- ======= START OF BOTTOM NAVBAR ====== --> -<A NAME="navbar_bottom"><!-- --></A> -<A HREF="#skip-navbar_bottom" title="Skip navigation links"></A> -<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY=""> -<TR> -<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> -<A NAME="navbar_bottom_firstrow"><!-- --></A> -<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY=""> - <TR ALIGN="center" VALIGN="top"> - <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD> - <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD> - <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD> - <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/ReportConfiguration.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A> </TD> - <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD> - <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD> - <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD> - <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD> - </TR> -</TABLE> -</TD> -<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM> -</EM> -</TD> -</TR> - -<TR> -<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> - <A HREF="../../../org/apache/rat/Report.html" title="class in org.apache.rat"><B>PREV CLASS</B></A> - NEXT CLASS</FONT></TD> -<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> - <A HREF="../../../index.html?org/apache/rat/ReportConfiguration.html" target="_top"><B>FRAMES</B></A> - <A HREF="ReportConfiguration.html" target="_top"><B>NO FRAMES</B></A> - <SCRIPT type="text/javascript"> - <!-- - if(window==top) { - document.writeln('<A HREF="../../../allclasses-noframe.html"><B>All Classes</B></A>'); - } - //--> -</SCRIPT> -<NOSCRIPT> - <A HREF="../../../allclasses-noframe.html"><B>All Classes</B></A> -</NOSCRIPT> - - -</FONT></TD> -</TR> -<TR> -<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> - SUMMARY: NESTED | FIELD | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD> -<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> -DETAIL: FIELD | <A HREF="#constructor_detail">CONSTR</A> | <A HREF="#method_detail">METHOD</A></FONT></TD> -</TR> -</TABLE> -<A NAME="skip-navbar_bottom"></A> -<!-- ======== END OF BOTTOM NAVBAR ======= --> - -<HR> -Copyright © 2006–2014 <a href="http://www.apache.org">Apache Software Foundation</a>. All rights reserved. -</BODY> -</HTML> \ No newline at end of file +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> +<!-- NewPage --> +<html lang="en"> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<title>ReportConfiguration (Apache Creadur Rat::Core 0.12 API)</title> +<link rel="stylesheet" type="text/css" href="../../../stylesheet.css" title="Style"> +</head> +<body> +<script type="text/javascript"><!-- + if (location.href.indexOf('is-external=true') == -1) { + parent.document.title="ReportConfiguration (Apache Creadur Rat::Core 0.12 API)"; + } +//--> +</script> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<!-- ========= START OF TOP NAVBAR ======= --> +<div class="topNav"><a name="navbar_top"> +<!-- --> +</a><a href="#skip-navbar_top" title="Skip navigation links"></a><a name="navbar_top_firstrow"> +<!-- --> +</a> +<ul class="navList" title="Navigation"> +<li><a href="../../../overview-summary.html">Overview</a></li> +<li><a href="package-summary.html">Package</a></li> +<li class="navBarCell1Rev">Class</li> +<li><a href="class-use/ReportConfiguration.html">Use</a></li> +<li><a href="package-tree.html">Tree</a></li> +<li><a href="../../../deprecated-list.html">Deprecated</a></li> +<li><a href="../../../index-all.html">Index</a></li> +<li><a href="../../../help-doc.html">Help</a></li> +</ul> +</div> +<div class="subNav"> +<ul class="navList"> +<li><a href="../../../org/apache/rat/Report.html" title="class in org.apache.rat"><span class="strong">Prev Class</span></a></li> +<li>Next Class</li> +</ul> +<ul class="navList"> +<li><a href="../../../index.html?org/apache/rat/ReportConfiguration.html" target="_top">Frames</a></li> +<li><a href="ReportConfiguration.html" target="_top">No Frames</a></li> +</ul> +<ul class="navList" id="allclasses_navbar_top"> +<li><a href="../../../allclasses-noframe.html">All Classes</a></li> +</ul> +<div> +<script type="text/javascript"><!-- + allClassesLink = document.getElementById("allclasses_navbar_top"); + if(window==top) { + allClassesLink.style.display = "block"; + } + else { + allClassesLink.style.display = "none"; + } + //--> +</script> +</div> +<div> +<ul class="subNavList"> +<li>Summary: </li> +<li>Nested | </li> +<li>Field | </li> +<li><a href="#constructor_summary">Constr</a> | </li> +<li><a href="#method_summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li>Field | </li> +<li><a href="#constructor_detail">Constr</a> | </li> +<li><a href="#method_detail">Method</a></li> +</ul> +</div> +<a name="skip-navbar_top"> +<!-- --> +</a></div> +<!-- ========= END OF TOP NAVBAR ========= --> +<!-- ======== START OF CLASS DATA ======== --> +<div class="header"> +<div class="subTitle">org.apache.rat</div> +<h2 title="Class ReportConfiguration" class="title">Class ReportConfiguration</h2> +</div> +<div class="contentContainer"> +<ul class="inheritance"> +<li><a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">java.lang.Object</a></li> +<li> +<ul class="inheritance"> +<li>org.apache.rat.ReportConfiguration</li> +</ul> +</li> +</ul> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<hr> +<br> +<pre>public class <span class="strong">ReportConfiguration</span> +extends <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></pre> +<div class="block">A configuration object is used by the frontend to invoke the + <a href="../../../org/apache/rat/Report.html" title="class in org.apache.rat"><code>Report</code></a>. Basically, the sole purpose of the frontends is + to create the configuration and invoke the <a href="../../../org/apache/rat/Report.html" title="class in org.apache.rat"><code>Report</code></a>.</div> +</li> +</ul> +</div> +<div class="summary"> +<ul class="blockList"> +<li class="blockList"> +<!-- ======== CONSTRUCTOR SUMMARY ======== --> +<ul class="blockList"> +<li class="blockList"><a name="constructor_summary"> +<!-- --> +</a> +<h3>Constructor Summary</h3> +<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation"> +<caption><span>Constructors</span><span class="tabEnd"> </span></caption> +<tr> +<th class="colOne" scope="col">Constructor and Description</th> +</tr> +<tr class="altColor"> +<td class="colOne"><code><strong><a href="../../../org/apache/rat/ReportConfiguration.html#ReportConfiguration()">ReportConfiguration</a></strong>()</code> </td> +</tr> +</table> +</li> +</ul> +<!-- ========== METHOD SUMMARY =========== --> +<ul class="blockList"> +<li class="blockList"><a name="method_summary"> +<!-- --> +</a> +<h3>Method Summary</h3> +<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation"> +<caption><span>Methods</span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Modifier and Type</th> +<th class="colLast" scope="col">Method and Description</th> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../org/apache/rat/license/ILicenseFamily.html" title="interface in org.apache.rat.license">ILicenseFamily</a>[]</code></td> +<td class="colLast"><code><strong><a href="../../../org/apache/rat/ReportConfiguration.html#getApprovedLicenseNames()">getApprovedLicenseNames</a></strong>()</code> +<div class="block">Returns the set of approved license names.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td> +<td class="colLast"><code><strong><a href="../../../org/apache/rat/ReportConfiguration.html#getCopyrightMessage()">getCopyrightMessage</a></strong>()</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../org/apache/rat/analysis/IHeaderMatcher.html" title="interface in org.apache.rat.analysis">IHeaderMatcher</a></code></td> +<td class="colLast"><code><strong><a href="../../../org/apache/rat/ReportConfiguration.html#getHeaderMatcher()">getHeaderMatcher</a></strong>()</code> +<div class="block">Returns the header matcher.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><strong><a href="../../../org/apache/rat/ReportConfiguration.html#isAddingLicenses()">isAddingLicenses</a></strong>()</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><strong><a href="../../../org/apache/rat/ReportConfiguration.html#isAddingLicensesForced()">isAddingLicensesForced</a></strong>()</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><strong><a href="../../../org/apache/rat/ReportConfiguration.html#isApproveDefaultLicenses()">isApproveDefaultLicenses</a></strong>()</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../org/apache/rat/ReportConfiguration.html#setAddingLicenses(boolean)">setAddingLicenses</a></strong>(boolean addingLicenses)</code> +<div class="block">Returns, whether Rat should add missing license headers.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../org/apache/rat/ReportConfiguration.html#setAddingLicensesForced(boolean)">setAddingLicensesForced</a></strong>(boolean addingLicensesForced)</code> +<div class="block">If Rat is adding license headers: Sets, whether adding + license headers is enforced.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../org/apache/rat/ReportConfiguration.html#setApproveDefaultLicenses(boolean)">setApproveDefaultLicenses</a></strong>(boolean approveDefaultLicenses)</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../org/apache/rat/ReportConfiguration.html#setApprovedLicenseNames(org.apache.rat.license.ILicenseFamily[])">setApprovedLicenseNames</a></strong>(<a href="../../../org/apache/rat/license/ILicenseFamily.html" title="interface in org.apache.rat.license">ILicenseFamily</a>[] approvedLicenseNames)</code> +<div class="block">Sets the set of approved license names.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../org/apache/rat/ReportConfiguration.html#setApprovedLicenseNames(java.util.List)">setApprovedLicenseNames</a></strong>(<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a><<a href="../../../org/apache/rat/license/ILicenseFamily.html" title="interface in org.apache.rat.license">ILicenseFamily</a>> approvedLicenseNames)</code> +<div class="block">Sets the set of approved license names (convenience).</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../org/apache/rat/ReportConfiguration.html#setCopyrightMessage(java.lang.String)">setCopyrightMessage</a></strong>(<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> copyrightMessage)</code> +<div class="block">If Rat is adding license headers: Sets the optional + copyright message.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../org/apache/rat/ReportConfiguration.html#setHeaderMatcher(org.apache.rat.analysis.IHeaderMatcher)">setHeaderMatcher</a></strong>(<a href="../../../org/apache/rat/analysis/IHeaderMatcher.html" title="interface in org.apache.rat.analysis">IHeaderMatcher</a> headerMatcher)</code> +<div class="block">Sets the header matcher.</div> +</td> +</tr> +</table> +<ul class="blockList"> +<li class="blockList"><a name="methods_inherited_from_class_java.lang.Object"> +<!-- --> +</a> +<h3>Methods inherited from class java.lang.<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></h3> +<code><a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true#clone()" title="class or interface in java.lang">clone</a>, <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true#equals(java.lang.Object)" title="class or interface in java.lang">equals</a>, <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true#finalize()" title="class or interface in java.lang">finalize</a>, <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true#getClass()" title="class or interface in java.lang">getClass</a>, <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true#hashCode()" title="class or interface in java.lang">hashCode</a>, <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true#notify()" title="class or interface in java.lang">notify</a>, <a href="http://docs.oracle.com/jav ase/1.5.0/docs/api/java/lang/Object.html?is-external=true#notifyAll()" title="class or interface in java.lang">notifyAll</a>, <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true#toString()" title="class or interface in java.lang">toString</a>, <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true#wait()" title="class or interface in java.lang">wait</a>, <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true#wait(long)" title="class or interface in java.lang">wait</a>, <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true#wait(long,%20int)" title="class or interface in java.lang">wait</a></code></li> +</ul> +</li> +</ul> +</li> +</ul> +</div> +<div class="details"> +<ul class="blockList"> +<li class="blockList"> +<!-- ========= CONSTRUCTOR DETAIL ======== --> +<ul class="blockList"> +<li class="blockList"><a name="constructor_detail"> +<!-- --> +</a> +<h3>Constructor Detail</h3> +<a name="ReportConfiguration()"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>ReportConfiguration</h4> +<pre>public ReportConfiguration()</pre> +</li> +</ul> +</li> +</ul> +<!-- ============ METHOD DETAIL ========== --> +<ul class="blockList"> +<li class="blockList"><a name="method_detail"> +<!-- --> +</a> +<h3>Method Detail</h3> +<a name="isApproveDefaultLicenses()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>isApproveDefaultLicenses</h4> +<pre>public boolean isApproveDefaultLicenses()</pre> +<dl><dt><span class="strong">Returns:</span></dt><dd>whether default licenses shall be approved by default.</dd></dl> +</li> +</ul> +<a name="setApproveDefaultLicenses(boolean)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setApproveDefaultLicenses</h4> +<pre>public void setApproveDefaultLicenses(boolean approveDefaultLicenses)</pre> +</li> +</ul> +<a name="getHeaderMatcher()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getHeaderMatcher</h4> +<pre>public <a href="../../../org/apache/rat/analysis/IHeaderMatcher.html" title="interface in org.apache.rat.analysis">IHeaderMatcher</a> getHeaderMatcher()</pre> +<div class="block">Returns the header matcher.</div> +<dl><dt><span class="strong">Returns:</span></dt><dd>the header matcher.</dd></dl> +</li> +</ul> +<a name="setHeaderMatcher(org.apache.rat.analysis.IHeaderMatcher)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setHeaderMatcher</h4> +<pre>public void setHeaderMatcher(<a href="../../../org/apache/rat/analysis/IHeaderMatcher.html" title="interface in org.apache.rat.analysis">IHeaderMatcher</a> headerMatcher)</pre> +<div class="block">Sets the header matcher.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>headerMatcher</code> - header matcher.</dd></dl> +</li> +</ul> +<a name="getApprovedLicenseNames()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getApprovedLicenseNames</h4> +<pre>public <a href="../../../org/apache/rat/license/ILicenseFamily.html" title="interface in org.apache.rat.license">ILicenseFamily</a>[] getApprovedLicenseNames()</pre> +<div class="block">Returns the set of approved license names.</div> +<dl><dt><span class="strong">Returns:</span></dt><dd>the set of approved license names.</dd></dl> +</li> +</ul> +<a name="setApprovedLicenseNames(org.apache.rat.license.ILicenseFamily[])"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setApprovedLicenseNames</h4> +<pre>public void setApprovedLicenseNames(<a href="../../../org/apache/rat/license/ILicenseFamily.html" title="interface in org.apache.rat.license">ILicenseFamily</a>[] approvedLicenseNames)</pre> +<div class="block">Sets the set of approved license names.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>approvedLicenseNames</code> - set of approved license names.</dd></dl> +</li> +</ul> +<a name="setApprovedLicenseNames(java.util.List)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setApprovedLicenseNames</h4> +<pre>public void setApprovedLicenseNames(<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a><<a href="../../../org/apache/rat/license/ILicenseFamily.html" title="interface in org.apache.rat.license">ILicenseFamily</a>> approvedLicenseNames)</pre> +<div class="block">Sets the set of approved license names (convenience).</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>approvedLicenseNames</code> - set of approved license names.</dd></dl> +</li> +</ul> +<a name="getCopyrightMessage()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getCopyrightMessage</h4> +<pre>public <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> getCopyrightMessage()</pre> +<dl><dt><span class="strong">Returns:</span></dt><dd>If Rat is adding license headers: Returns the optional + copyright message. This value is ignored, if no + license headers are added.</dd><dt><span class="strong">See Also:</span></dt><dd><a href="../../../org/apache/rat/ReportConfiguration.html#isAddingLicenses()"><code>isAddingLicenses()</code></a></dd></dl> +</li> +</ul> +<a name="setCopyrightMessage(java.lang.String)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setCopyrightMessage</h4> +<pre>public void setCopyrightMessage(<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> copyrightMessage)</pre> +<div class="block">If Rat is adding license headers: Sets the optional + copyright message. This value is ignored, if no + license headers are added.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>copyrightMessage</code> - message to set.</dd><dt><span class="strong">See Also:</span></dt><dd><a href="../../../org/apache/rat/ReportConfiguration.html#setAddingLicenses(boolean)"><code>setAddingLicenses(boolean)</code></a></dd></dl> +</li> +</ul> +<a name="isAddingLicensesForced()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>isAddingLicensesForced</h4> +<pre>public boolean isAddingLicensesForced()</pre> +<dl><dt><span class="strong">Returns:</span></dt><dd>If Rat is adding license headers: Returns, whether adding + license headers is enforced. This value is ignored, if no + license headers are added.</dd><dt><span class="strong">See Also:</span></dt><dd><a href="../../../org/apache/rat/ReportConfiguration.html#isAddingLicenses()"><code>isAddingLicenses()</code></a></dd></dl> +</li> +</ul> +<a name="setAddingLicensesForced(boolean)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setAddingLicensesForced</h4> +<pre>public void setAddingLicensesForced(boolean addingLicensesForced)</pre> +<div class="block">If Rat is adding license headers: Sets, whether adding + license headers is enforced. This value is ignored, if no + license headers are added.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>addingLicensesForced</code> - enable/disable forcibly adding licenses.</dd><dt><span class="strong">See Also:</span></dt><dd><a href="../../../org/apache/rat/ReportConfiguration.html#isAddingLicenses()"><code>isAddingLicenses()</code></a></dd></dl> +</li> +</ul> +<a name="isAddingLicenses()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>isAddingLicenses</h4> +<pre>public boolean isAddingLicenses()</pre> +<dl><dt><span class="strong">Returns:</span></dt><dd>Returns, whether Rat should add missing license headers.</dd><dt><span class="strong">See Also:</span></dt><dd><a href="../../../org/apache/rat/ReportConfiguration.html#isAddingLicensesForced()"><code>isAddingLicensesForced()</code></a>, +<a href="../../../org/apache/rat/ReportConfiguration.html#getCopyrightMessage()"><code>getCopyrightMessage()</code></a></dd></dl> +</li> +</ul> +<a name="setAddingLicenses(boolean)"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>setAddingLicenses</h4> +<pre>public void setAddingLicenses(boolean addingLicenses)</pre> +<div class="block">Returns, whether Rat should add missing license headers.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>addingLicenses</code> - enables/disables adding of licenses.</dd><dt><span class="strong">See Also:</span></dt><dd><a href="../../../org/apache/rat/ReportConfiguration.html#setAddingLicensesForced(boolean)"><code>setAddingLicensesForced(boolean)</code></a>, +<a href="../../../org/apache/rat/ReportConfiguration.html#setCopyrightMessage(java.lang.String)"><code>setCopyrightMessage(String)</code></a></dd></dl> +</li> +</ul> +</li> +</ul> +</li> +</ul> +</div> +</div> +<!-- ========= END OF CLASS DATA ========= --> +<!-- ======= START OF BOTTOM NAVBAR ====== --> +<div class="bottomNav"><a name="navbar_bottom"> +<!-- --> +</a><a href="#skip-navbar_bottom" title="Skip navigation links"></a><a name="navbar_bottom_firstrow"> +<!-- --> +</a> +<ul class="navList" title="Navigation"> +<li><a href="../../../overview-summary.html">Overview</a></li> +<li><a href="package-summary.html">Package</a></li> +<li class="navBarCell1Rev">Class</li> +<li><a href="class-use/ReportConfiguration.html">Use</a></li> +<li><a href="package-tree.html">Tree</a></li> +<li><a href="../../../deprecated-list.html">Deprecated</a></li> +<li><a href="../../../index-all.html">Index</a></li> +<li><a href="../../../help-doc.html">Help</a></li> +</ul> +</div> +<div class="subNav"> +<ul class="navList"> +<li><a href="../../../org/apache/rat/Report.html" title="class in org.apache.rat"><span class="strong">Prev Class</span></a></li> +<li>Next Class</li> +</ul> +<ul class="navList"> +<li><a href="../../../index.html?org/apache/rat/ReportConfiguration.html" target="_top">Frames</a></li> +<li><a href="ReportConfiguration.html" target="_top">No Frames</a></li> +</ul> +<ul class="navList" id="allclasses_navbar_bottom"> +<li><a href="../../../allclasses-noframe.html">All Classes</a></li> +</ul> +<div> +<script type="text/javascript"><!-- + allClassesLink = document.getElementById("allclasses_navbar_bottom"); + if(window==top) { + allClassesLink.style.display = "block"; + } + else { + allClassesLink.style.display = "none"; + } + //--> +</script> +</div> +<div> +<ul class="subNavList"> +<li>Summary: </li> +<li>Nested | </li> +<li>Field | </li> +<li><a href="#constructor_summary">Constr</a> | </li> +<li><a href="#method_summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li>Field | </li> +<li><a href="#constructor_detail">Constr</a> | </li> +<li><a href="#method_detail">Method</a></li> +</ul> +</div> +<a name="skip-navbar_bottom"> +<!-- --> +</a></div> +<!-- ======== END OF BOTTOM NAVBAR ======= --> +<p class="legalCopy"><small>Copyright © 2006–2016 <a href="http://www.apache.org">Apache Software Foundation</a>. All rights reserved.</small></p> +</body> +</html>
http://git-wip-us.apache.org/repos/asf/creadur-site/blob/3e6a0709/rat/apache-rat-core/apidocs/org/apache/rat/analysis/DefaultAnalyserFactory.html ---------------------------------------------------------------------- diff --git a/rat/apache-rat-core/apidocs/org/apache/rat/analysis/DefaultAnalyserFactory.html b/rat/apache-rat-core/apidocs/org/apache/rat/analysis/DefaultAnalyserFactory.html index 45900cb..5dd5b8d 100644 --- a/rat/apache-rat-core/apidocs/org/apache/rat/analysis/DefaultAnalyserFactory.html +++ b/rat/apache-rat-core/apidocs/org/apache/rat/analysis/DefaultAnalyserFactory.html @@ -1,253 +1,257 @@ -<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> -<!--NewPage--> -<HTML> -<HEAD> -<META http-equiv="Content-Type" content="text/html; charset=UTF-8"> -<TITLE> -DefaultAnalyserFactory (Apache Creadur Rat::Core 0.11 API) -</TITLE> - -<META NAME="keywords" CONTENT="org.apache.rat.analysis.DefaultAnalyserFactory class"> - -<LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../stylesheet.css" TITLE="Style"> - -<SCRIPT type="text/javascript"> -function windowTitle() -{ - parent.document.title="DefaultAnalyserFactory (Apache Creadur Rat::Core 0.11 API)"; -} -</SCRIPT> -<NOSCRIPT> -</NOSCRIPT> - -</HEAD> - -<BODY BGCOLOR="white" onload="windowTitle();"> - - -<!-- ========= START OF TOP NAVBAR ======= --> -<A NAME="navbar_top"><!-- --></A> -<A HREF="#skip-navbar_top" title="Skip navigation links"></A> -<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY=""> -<TR> -<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> -<A NAME="navbar_top_firstrow"><!-- --></A> -<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY=""> - <TR ALIGN="center" VALIGN="top"> - <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD> - <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD> - <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD> - <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/DefaultAnalyserFactory.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A> </TD> - <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD> - <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD> - <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD> - <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD> - </TR> -</TABLE> -</TD> -<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM> -</EM> -</TD> -</TR> - -<TR> -<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> - PREV CLASS - <A HREF="../../../../org/apache/rat/analysis/DocumentHeaderAnalyser.html" title="class in org.apache.rat.analysis"><B>NEXT CLASS</B></A></FONT></TD> -<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> - <A HREF="../../../../index.html?org/apache/rat/analysis/DefaultAnalyserFactory.html" target="_top"><B>FRAMES</B></A> - <A HREF="DefaultAnalyserFactory.html" target="_top"><B>NO FRAMES</B></A> - <SCRIPT type="text/javascript"> - <!-- - if(window==top) { - document.writeln('<A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>'); - } - //--> -</SCRIPT> -<NOSCRIPT> - <A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A> -</NOSCRIPT> - - -</FONT></TD> -</TR> -<TR> -<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> - SUMMARY: NESTED | FIELD | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD> -<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> -DETAIL: FIELD | <A HREF="#constructor_detail">CONSTR</A> | <A HREF="#method_detail">METHOD</A></FONT></TD> -</TR> -</TABLE> -<A NAME="skip-navbar_top"></A> -<!-- ========= END OF TOP NAVBAR ========= --> - -<HR> -<!-- ======== START OF CLASS DATA ======== --> -<H2> -<FONT SIZE="-1"> -org.apache.rat.analysis</FONT> -<BR> -Class DefaultAnalyserFactory</H2> -<PRE> -<A HREF="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html" title="class or interface in java.lang">java.lang.Object</A> - <IMG SRC="../../../../resources/inherit.gif" ALT="extended by "><B>org.apache.rat.analysis.DefaultAnalyserFactory</B> -</PRE> -<HR> -<DL> -<DT><PRE>public class <B>DefaultAnalyserFactory</B><DT>extends <A HREF="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html" title="class or interface in java.lang">Object</A></DL> -</PRE> - -<P> -Creates default analysers. -<P> - -<P> -<HR> - -<P> - -<!-- ======== CONSTRUCTOR SUMMARY ======== --> - -<A NAME="constructor_summary"><!-- --></A> -<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> -<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> -<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2"> -<B>Constructor Summary</B></FONT></TH> -</TR> -<TR BGCOLOR="white" CLASS="TableRowColor"> -<TD><CODE><B><A HREF="../../../../org/apache/rat/analysis/DefaultAnalyserFactory.html#DefaultAnalyserFactory()">DefaultAnalyserFactory</A></B>()</CODE> - -<BR> - </TD> -</TR> -</TABLE> - -<!-- ========== METHOD SUMMARY =========== --> - -<A NAME="method_summary"><!-- --></A> -<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> -<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> -<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2"> -<B>Method Summary</B></FONT></TH> -</TR> -<TR BGCOLOR="white" CLASS="TableRowColor"> -<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> -<CODE>static <A HREF="../../../../org/apache/rat/document/IDocumentAnalyser.html" title="interface in org.apache.rat.document">IDocumentAnalyser</A></CODE></FONT></TD> -<TD><CODE><B><A HREF="../../../../org/apache/rat/analysis/DefaultAnalyserFactory.html#createDefaultAnalyser(org.apache.rat.analysis.IHeaderMatcher)">createDefaultAnalyser</A></B>(<A HREF="../../../../org/apache/rat/analysis/IHeaderMatcher.html" title="interface in org.apache.rat.analysis">IHeaderMatcher</A> matcher)</CODE> - -<BR> - </TD> -</TR> -</TABLE> - <A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A> -<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> -<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor"> -<TH ALIGN="left"><B>Methods inherited from class java.lang.<A HREF="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html" title="class or interface in java.lang">Object</A></B></TH> -</TR> -<TR BGCOLOR="white" CLASS="TableRowColor"> -<TD><CODE><A HREF="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html#clone()" title="class or interface in java.lang">clone</A>, <A HREF="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html#equals(java.lang.Object)" title="class or interface in java.lang">equals</A>, <A HREF="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html#finalize()" title="class or interface in java.lang">finalize</A>, <A HREF="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html#getClass()" title="class or interface in java.lang">getClass</A>, <A HREF="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html#hashCode()" title="class or interface in java.lang">hashCode</A>, <A HREF="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html#notify()" title="class or interface in java.lang">notify</A>, <A HREF="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html#notifyAll()" title="class or interface in java.lang">noti fyAll</A>, <A HREF="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html#toString()" title="class or interface in java.lang">toString</A>, <A HREF="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html#wait()" title="class or interface in java.lang">wait</A>, <A HREF="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html#wait(long)" title="class or interface in java.lang">wait</A>, <A HREF="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html#wait(long, int)" title="class or interface in java.lang">wait</A></CODE></TD> -</TR> -</TABLE> - -<P> - -<!-- ========= CONSTRUCTOR DETAIL ======== --> - -<A NAME="constructor_detail"><!-- --></A> -<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> -<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> -<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2"> -<B>Constructor Detail</B></FONT></TH> -</TR> -</TABLE> - -<A NAME="DefaultAnalyserFactory()"><!-- --></A><H3> -DefaultAnalyserFactory</H3> -<PRE> -public <B>DefaultAnalyserFactory</B>()</PRE> -<DL> -</DL> - -<!-- ============ METHOD DETAIL ========== --> - -<A NAME="method_detail"><!-- --></A> -<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> -<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> -<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2"> -<B>Method Detail</B></FONT></TH> -</TR> -</TABLE> - -<A NAME="createDefaultAnalyser(org.apache.rat.analysis.IHeaderMatcher)"><!-- --></A><H3> -createDefaultAnalyser</H3> -<PRE> -public static final <A HREF="../../../../org/apache/rat/document/IDocumentAnalyser.html" title="interface in org.apache.rat.document">IDocumentAnalyser</A> <B>createDefaultAnalyser</B>(<A HREF="../../../../org/apache/rat/analysis/IHeaderMatcher.html" title="interface in org.apache.rat.analysis">IHeaderMatcher</A> matcher)</PRE> -<DL> -<DD><DL> -</DL> -</DD> -</DL> -<!-- ========= END OF CLASS DATA ========= --> -<HR> - - -<!-- ======= START OF BOTTOM NAVBAR ====== --> -<A NAME="navbar_bottom"><!-- --></A> -<A HREF="#skip-navbar_bottom" title="Skip navigation links"></A> -<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY=""> -<TR> -<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> -<A NAME="navbar_bottom_firstrow"><!-- --></A> -<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY=""> - <TR ALIGN="center" VALIGN="top"> - <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD> - <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD> - <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD> - <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/DefaultAnalyserFactory.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A> </TD> - <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD> - <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD> - <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD> - <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD> - </TR> -</TABLE> -</TD> -<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM> -</EM> -</TD> -</TR> - -<TR> -<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> - PREV CLASS - <A HREF="../../../../org/apache/rat/analysis/DocumentHeaderAnalyser.html" title="class in org.apache.rat.analysis"><B>NEXT CLASS</B></A></FONT></TD> -<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> - <A HREF="../../../../index.html?org/apache/rat/analysis/DefaultAnalyserFactory.html" target="_top"><B>FRAMES</B></A> - <A HREF="DefaultAnalyserFactory.html" target="_top"><B>NO FRAMES</B></A> - <SCRIPT type="text/javascript"> - <!-- - if(window==top) { - document.writeln('<A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>'); - } - //--> -</SCRIPT> -<NOSCRIPT> - <A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A> -</NOSCRIPT> - - -</FONT></TD> -</TR> -<TR> -<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> - SUMMARY: NESTED | FIELD | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD> -<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> -DETAIL: FIELD | <A HREF="#constructor_detail">CONSTR</A> | <A HREF="#method_detail">METHOD</A></FONT></TD> -</TR> -</TABLE> -<A NAME="skip-navbar_bottom"></A> -<!-- ======== END OF BOTTOM NAVBAR ======= --> - -<HR> -Copyright © 2006–2014 <a href="http://www.apache.org">Apache Software Foundation</a>. All rights reserved. -</BODY> -</HTML> \ No newline at end of file +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> +<!-- NewPage --> +<html lang="en"> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<title>DefaultAnalyserFactory (Apache Creadur Rat::Core 0.12 API)</title> +<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style"> +</head> +<body> +<script type="text/javascript"><!-- + if (location.href.indexOf('is-external=true') == -1) { + parent.document.title="DefaultAnalyserFactory (Apache Creadur Rat::Core 0.12 API)"; + } +//--> +</script> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<!-- ========= START OF TOP NAVBAR ======= --> +<div class="topNav"><a name="navbar_top"> +<!-- --> +</a><a href="#skip-navbar_top" title="Skip navigation links"></a><a name="navbar_top_firstrow"> +<!-- --> +</a> +<ul class="navList" title="Navigation"> +<li><a href="../../../../overview-summary.html">Overview</a></li> +<li><a href="package-summary.html">Package</a></li> +<li class="navBarCell1Rev">Class</li> +<li><a href="class-use/DefaultAnalyserFactory.html">Use</a></li> +<li><a href="package-tree.html">Tree</a></li> +<li><a href="../../../../deprecated-list.html">Deprecated</a></li> +<li><a href="../../../../index-all.html">Index</a></li> +<li><a href="../../../../help-doc.html">Help</a></li> +</ul> +</div> +<div class="subNav"> +<ul class="navList"> +<li>Prev Class</li> +<li><a href="../../../../org/apache/rat/analysis/DocumentHeaderAnalyser.html" title="class in org.apache.rat.analysis"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?org/apache/rat/analysis/DefaultAnalyserFactory.html" target="_top">Frames</a></li> +<li><a href="DefaultAnalyserFactory.html" target="_top">No Frames</a></li> +</ul> +<ul class="navList" id="allclasses_navbar_top"> +<li><a href="../../../../allclasses-noframe.html">All Classes</a></li> +</ul> +<div> +<script type="text/javascript"><!-- + allClassesLink = document.getElementById("allclasses_navbar_top"); + if(window==top) { + allClassesLink.style.display = "block"; + } + else { + allClassesLink.style.display = "none"; + } + //--> +</script> +</div> +<div> +<ul class="subNavList"> +<li>Summary: </li> +<li>Nested | </li> +<li>Field | </li> +<li><a href="#constructor_summary">Constr</a> | </li> +<li><a href="#method_summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li>Field | </li> +<li><a href="#constructor_detail">Constr</a> | </li> +<li><a href="#method_detail">Method</a></li> +</ul> +</div> +<a name="skip-navbar_top"> +<!-- --> +</a></div> +<!-- ========= END OF TOP NAVBAR ========= --> +<!-- ======== START OF CLASS DATA ======== --> +<div class="header"> +<div class="subTitle">org.apache.rat.analysis</div> +<h2 title="Class DefaultAnalyserFactory" class="title">Class DefaultAnalyserFactory</h2> +</div> +<div class="contentContainer"> +<ul class="inheritance"> +<li><a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">java.lang.Object</a></li> +<li> +<ul class="inheritance"> +<li>org.apache.rat.analysis.DefaultAnalyserFactory</li> +</ul> +</li> +</ul> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<hr> +<br> +<pre>public class <span class="strong">DefaultAnalyserFactory</span> +extends <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></pre> +<div class="block">Creates default analysers.</div> +</li> +</ul> +</div> +<div class="summary"> +<ul class="blockList"> +<li class="blockList"> +<!-- ======== CONSTRUCTOR SUMMARY ======== --> +<ul class="blockList"> +<li class="blockList"><a name="constructor_summary"> +<!-- --> +</a> +<h3>Constructor Summary</h3> +<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation"> +<caption><span>Constructors</span><span class="tabEnd"> </span></caption> +<tr> +<th class="colOne" scope="col">Constructor and Description</th> +</tr> +<tr class="altColor"> +<td class="colOne"><code><strong><a href="../../../../org/apache/rat/analysis/DefaultAnalyserFactory.html#DefaultAnalyserFactory()">DefaultAnalyserFactory</a></strong>()</code> </td> +</tr> +</table> +</li> +</ul> +<!-- ========== METHOD SUMMARY =========== --> +<ul class="blockList"> +<li class="blockList"><a name="method_summary"> +<!-- --> +</a> +<h3>Method Summary</h3> +<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation"> +<caption><span>Methods</span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Modifier and Type</th> +<th class="colLast" scope="col">Method and Description</th> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>static <a href="../../../../org/apache/rat/document/IDocumentAnalyser.html" title="interface in org.apache.rat.document">IDocumentAnalyser</a></code></td> +<td class="colLast"><code><strong><a href="../../../../org/apache/rat/analysis/DefaultAnalyserFactory.html#createDefaultAnalyser(org.apache.rat.analysis.IHeaderMatcher)">createDefaultAnalyser</a></strong>(<a href="../../../../org/apache/rat/analysis/IHeaderMatcher.html" title="interface in org.apache.rat.analysis">IHeaderMatcher</a> matcher)</code> </td> +</tr> +</table> +<ul class="blockList"> +<li class="blockList"><a name="methods_inherited_from_class_java.lang.Object"> +<!-- --> +</a> +<h3>Methods inherited from class java.lang.<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></h3> +<code><a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true#clone()" title="class or interface in java.lang">clone</a>, <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true#equals(java.lang.Object)" title="class or interface in java.lang">equals</a>, <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true#finalize()" title="class or interface in java.lang">finalize</a>, <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true#getClass()" title="class or interface in java.lang">getClass</a>, <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true#hashCode()" title="class or interface in java.lang">hashCode</a>, <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true#notify()" title="class or interface in java.lang">notify</a>, <a href="http://docs.oracle.com/jav ase/1.5.0/docs/api/java/lang/Object.html?is-external=true#notifyAll()" title="class or interface in java.lang">notifyAll</a>, <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true#toString()" title="class or interface in java.lang">toString</a>, <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true#wait()" title="class or interface in java.lang">wait</a>, <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true#wait(long)" title="class or interface in java.lang">wait</a>, <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true#wait(long,%20int)" title="class or interface in java.lang">wait</a></code></li> +</ul> +</li> +</ul> +</li> +</ul> +</div> +<div class="details"> +<ul class="blockList"> +<li class="blockList"> +<!-- ========= CONSTRUCTOR DETAIL ======== --> +<ul class="blockList"> +<li class="blockList"><a name="constructor_detail"> +<!-- --> +</a> +<h3>Constructor Detail</h3> +<a name="DefaultAnalyserFactory()"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>DefaultAnalyserFactory</h4> +<pre>public DefaultAnalyserFactory()</pre> +</li> +</ul> +</li> +</ul> +<!-- ============ METHOD DETAIL ========== --> +<ul class="blockList"> +<li class="blockList"><a name="method_detail"> +<!-- --> +</a> +<h3>Method Detail</h3> +<a name="createDefaultAnalyser(org.apache.rat.analysis.IHeaderMatcher)"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>createDefaultAnalyser</h4> +<pre>public static final <a href="../../../../org/apache/rat/document/IDocumentAnalyser.html" title="interface in org.apache.rat.document">IDocumentAnalyser</a> createDefaultAnalyser(<a href="../../../../org/apache/rat/analysis/IHeaderMatcher.html" title="interface in org.apache.rat.analysis">IHeaderMatcher</a> matcher)</pre> +</li> +</ul> +</li> +</ul> +</li> +</ul> +</div> +</div> +<!-- ========= END OF CLASS DATA ========= --> +<!-- ======= START OF BOTTOM NAVBAR ====== --> +<div class="bottomNav"><a name="navbar_bottom"> +<!-- --> +</a><a href="#skip-navbar_bottom" title="Skip navigation links"></a><a name="navbar_bottom_firstrow"> +<!-- --> +</a> +<ul class="navList" title="Navigation"> +<li><a href="../../../../overview-summary.html">Overview</a></li> +<li><a href="package-summary.html">Package</a></li> +<li class="navBarCell1Rev">Class</li> +<li><a href="class-use/DefaultAnalyserFactory.html">Use</a></li> +<li><a href="package-tree.html">Tree</a></li> +<li><a href="../../../../deprecated-list.html">Deprecated</a></li> +<li><a href="../../../../index-all.html">Index</a></li> +<li><a href="../../../../help-doc.html">Help</a></li> +</ul> +</div> +<div class="subNav"> +<ul class="navList"> +<li>Prev Class</li> +<li><a href="../../../../org/apache/rat/analysis/DocumentHeaderAnalyser.html" title="class in org.apache.rat.analysis"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?org/apache/rat/analysis/DefaultAnalyserFactory.html" target="_top">Frames</a></li> +<li><a href="DefaultAnalyserFactory.html" target="_top">No Frames</a></li> +</ul> +<ul class="navList" id="allclasses_navbar_bottom"> +<li><a href="../../../../allclasses-noframe.html">All Classes</a></li> +</ul> +<div> +<script type="text/javascript"><!-- + allClassesLink = document.getElementById("allclasses_navbar_bottom"); + if(window==top) { + allClassesLink.style.display = "block"; + } + else { + allClassesLink.style.display = "none"; + } + //--> +</script> +</div> +<div> +<ul class="subNavList"> +<li>Summary: </li> +<li>Nested | </li> +<li>Field | </li> +<li><a href="#constructor_summary">Constr</a> | </li> +<li><a href="#method_summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li>Field | </li> +<li><a href="#constructor_detail">Constr</a> | </li> +<li><a href="#method_detail">Method</a></li> +</ul> +</div> +<a name="skip-navbar_bottom"> +<!-- --> +</a></div> +<!-- ======== END OF BOTTOM NAVBAR ======= --> +<p class="legalCopy"><small>Copyright © 2006–2016 <a href="http://www.apache.org">Apache Software Foundation</a>. All rights reserved.</small></p> +</body> +</html>
