Uses of Class org.apache.rat.analysis.generation.JavaDocLicenseNotRequired (Apache Creadur Rat::Core 0.13-SNAPSHOT API)

Class Summary
Class	Description
GeneratedLicenseNotRequired
JavaDocLicenseNotRequired	+ JavaDocs are generated and so no license is required. +

java.lang.Object
+
- org.apache.rat.analysis.license.BaseLicense
- +
  - org.apache.rat.analysis.license.SimplePatternBasedLicense
  - +
    - org.apache.rat.analysis.license.ApacheSoftwareLicense20
    +
  +
+

+
+
All Implemented Interfaces:
+
IHeaderMatcher
+
+
+
+
```
public final class ApacheSoftwareLicense20
+extends SimplePatternBasedLicense
```
+
Matches Apache License, Version 2.0
+

+ +
- + + +
  Field Summary
  + + + + + + + + + + + + + + +
  Fields
  Modifier and Type Field and Description
  static String FIRST_LICENSE_LINE
  static String LICENSE_REFERENCE_LINE
  +
+ +
- + + +
  Constructor Summary
  + + + + + + + + +
  Constructors
  Constructor and Description
  ApacheSoftwareLicense20()
  +
+ +
- + + +
  Method Summary
  +
  - + + +
    Methods inherited from class org.apache.rat.analysis.license.SimplePatternBasedLicense
    +getPatterns, match, matches, reset, setPatterns
  +
  - + + +
    Methods inherited from class org.apache.rat.analysis.license.BaseLicense
    +getLicenseFamilyCategory, getLicenseFamilyName, getNotes, prune, reportOnLicense, setLicenseFamilyCategory, setLicenseFamilyName, se tNotes
  +
  - + + +
    Methods inherited from class java.lang.Object
    +clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
  +
+

Fields
Modifier and Type	Field and Description
`static String`	`FIRST_LICENSE_LINE`
`static String`	`LICENSE_REFERENCE_LINE`

Constructors
Constructor and Description
`ApacheSoftwareLicense20()`

+ +
- + + +
  Field Detail
  + + + +
  - +
    FIRST_LICENSE_LINE
    +
```
public static final String FIRST_LICENSE_LINE
```
    +
    +
    See Also:
    +
    Constant Field Values
    +
    +
  + + + +
  - +
    LICENSE_REFERENCE_LINE
    +
```
public static final String LICENSE_REFERENCE_LINE
```
    +
    +
    See Also:
    +
    Constant Field Values
    +
    +
  +
+ +
- + + +
  Constructor Detail
  + + + +
  - +
    ApacheSoftwareLicense20
    +
```
public ApacheSoftwareLicense20()
```
    +
  +
+

java.lang.Object
+
- org.apache.rat.analysis.license.BaseLicense
- +
  - org.apache.rat.analysis.license.CopyrightHeader
  - +
    - org.apache.rat.analysis.license.AppliedApacheSoftwareLicense20
    +
  +
+

+
+
All Implemented Interfaces:
+
IHeaderMatcher
+
+
+
+
```
public class AppliedApacheSoftwareLicense20
+extends CopyrightHeader
```
+
Matches an applied AL 2.0 License header, including a required + initial copyright header line, conforming the template + from the AL 2.0 license itself.
+
+
Since:
+
Rat 0.9
+
+

+ +

+ + +
Field Summary
+ + + + + + + + + + +
Fields
Modifier and Type Field and Description
static String ASL20_LICENSE_DEFN
+
- + + +
  Fields inherited from class org.apache.rat.analysis.license.CopyrightHeader
  +COPYRIGHT_PREFIX_PATTERN_DEFN
+

Fields
Modifier and Type	Field and Description
`static String`	`ASL20_LICENSE_DEFN`

+ +

+ + +
Constructor Summary
+ + + + + + + + + + + +
Constructors
Constructor and Description
AppliedApacheSoftwareLicense20()
AppliedApacheSoftwareLicense20(String copyrightOwner)
+

Constructors
Constructor and Description
`AppliedApacheSoftwareLicense20()`
`AppliedApacheSoftwareLicense20(String copyrightOwner)`

+ +

+ + +

Method Summary

+ + + + + + + + + + + + + + +

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`match(Document subject, + String s)` + Matches the text accumulated to licenses. +
`void`	`reset()` + Resets this matches. +

+ + +
Methods inherited from class org.apache.rat.analysis.license.CopyrightHeader
+getCopyRightOwner, hasCopyrightPattern, isCopyrightMatch, matchCopyright, setCopyrightOwner

+ + +
Methods inherited from class org.apache.rat.analysis.license.BaseLicense
+getLicenseFamilyCategory, getLicenseFamilyName, getNotes, prune, reportOnLicense, setLicenseFamilyCategory, setLicenseFamilyName, se tNotes

+ + +
Methods inherited from class java.lang.Object
+clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

+ +
- + + +
  Field Detail
  + + + +
  - +
    ASL20_LICENSE_DEFN
    +
```
public static final String ASL20_LICENSE_DEFN
```
    +
    +
    See Also:
    +
    Constant Field Values
    +
    +
  +
+ +
- + + +
  Constructor Detail
  + + + +
  - +
    AppliedApacheSoftwareLicense20
    +
```
public AppliedApacheSoftwareLicense20()
```
    +
  + + + +
  - +
    AppliedApacheSoftwareLicense20
    +
```
public AppliedApacheSoftwareLicense20(String copyrightOwner)
```
    +
  +
+ +
- + + +
  Method Detail
  + + + +
  - +
    match
    +
```
public boolean match(Document subject,
+                     String s)
+              throws RatHeaderAnalysisException
```
    +
    Description copied from interface: IHeaderMatcher
    +
    Matches the text accumulated to licenses. + TODO probably a poor design choice - hope to fix later
    +
    +
    Specified by:
    +
    match in interface IHeaderMatcher
    +
    Overrides:
    +
    match in class CopyrightHeader
    +
    Parameters:
    +
    subject - current document.
    +
    s - next line of text, not null
    +
    Returns:
    +
    whether the current line matched in the document.
    +
    Throws:
    +
    RatHeaderAnalysisException - in case of internal RAT errors.
    +
    +
  + + + +
  - +
    reset
    +
```
public void reset()
```
    +
    Description copied from interface: IHeaderMatcher
    +
    Resets this matches. + Subsequent calls to IHeaderMatcher.match(org.apache.rat.api.Document, java.lang.String) will accumulate new text.
    +
    +
    Specified by:
    +
    reset in interface IHeaderMatcher
    +
    Overrides:
    +
    reset in class CopyrightHeader
    +
    +
  +
+

java.lang.Object
+
- org.apache.rat.analysis.license.BaseLicense
+

+
+
Direct Known Subclasses:
+
CDDL1License, CopyrightHeader, FullTextMatchingLicense, SimplePatternBasedLicense
+
+
+
+
```
public class BaseLicense
+extends Object
```
+

+ +

+ + +
Constructor Summary
+ + + + + + + + + + + +
Constructors
Constructor and Description
BaseLicense()
BaseLicense(MetaData.Datum licenseFamilyCategory, + MetaData.Datum licenseFamilyName, + String notes)
+

Constructors
Constructor and Description
`BaseLicense()`
`BaseLicense(MetaData.Datum licenseFamilyCategory, + MetaData.Datum licenseFamilyName, + String notes)`

+ +

+ + +

Method Summary

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`String`	`getLicenseFamilyCategory()`
`String`	`getLicenseFamilyName()`
`String`	`getNotes()`
`protected static String`	`prune(String text)`
`void`	`reportOnLicense(Document subject)`
`void`	`setLicenseFamilyCategory(String pDocumentCategory)`
`void`	`setLicenseFamilyName(String pLicenseFamilyCategory)`
`void`	`setNotes(String pNotes)`

+ + +
Methods inherited from class java.lang.Object
+clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

+ +

+ + +

Constructor Detail

+ + + +

+
BaseLicense
+
```
public BaseLicense()
```
+

+ + + +

BaseLicense

public BaseLicense(MetaData.Datum licenseFamilyCategory,
+                   MetaData.Datum licenseFamilyName,
+                   String notes)

+ +

+ + +

Method Detail

+ + + +

getLicenseFamilyCategory

public String getLicenseFamilyCategory()

+ + + +

setLicenseFamilyCategory

public void setLicenseFamilyCategory(String pDocumentCategory)

+ + + +

+
getLicenseFamilyName
+
```
public String getLicenseFamilyName()
```
+

+ + + +

setLicenseFamilyName

public void setLicenseFamilyName(String pLicenseFamilyCategory)

+ + + +

+
getNotes
+
```
public String getNotes()
```
+

+ + + +

+
setNotes
+
```
public void setNotes(String pNotes)
```
+

+ + + +

reportOnLicense

public final void reportOnLicense(Document subject)

+ + + +

prune

protected static final String prune(String text)

Uses of Classorg.apache.rat.analysis.generation.JavaDocLicenseNotRequired

org.apache.rat.analysis.generation

Classes

Package org.apache.rat.analysis.generation

Hierarchy For Package org.apache.rat.analysis.generation

Class Hierarchy

Uses of Packageorg.apache.rat.analysis.generation

Class ApacheSoftwareLicense20

Field Summary

Constructor Summary

Method Summary

Methods inherited from class org.apache.rat.analysis.license.SimplePatternBasedLicense

Methods inherited from class org.apache.rat.analysis.license.BaseLicense

Methods inherited from class java.lang.Object

Field Detail

FIRST_LICENSE_LINE

LICENSE_REFERENCE_LINE

Constructor Detail

ApacheSoftwareLicense20

Class AppliedApacheSoftwareLicense20

Field Summary

Fields inherited from class org.apache.rat.analysis.license.CopyrightHeader

Constructor Summary

Method Summary

Methods inherited from class org.apache.rat.analysis.license.CopyrightHeader

Methods inherited from class org.apache.rat.analysis.license.BaseLicense

Methods inherited from class java.lang.Object

Field Detail

ASL20_LICENSE_DEFN

Constructor Detail

AppliedApacheSoftwareLicense20

AppliedApacheSoftwareLicense20

Method Detail

match

reset

Class BaseLicense

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

BaseLicense

BaseLicense

Method Detail

getLicenseFamilyCategory

setLicenseFamilyCategory

getLicenseFamilyName

setLicenseFamilyName

getNotes

setNotes

reportOnLicense

prune

Uses of Class
org.apache.rat.analysis.generation.JavaDocLicenseNotRequired

Uses of Package
org.apache.rat.analysis.generation