Return-Path: X-Original-To: archive-asf-public-internal@cust-asf2.ponee.io Delivered-To: archive-asf-public-internal@cust-asf2.ponee.io Received: from cust-asf.ponee.io (cust-asf.ponee.io [163.172.22.183]) by cust-asf2.ponee.io (Postfix) with ESMTP id DF003200BA4 for ; Sat, 10 Sep 2016 01:40:10 +0200 (CEST) Received: by cust-asf.ponee.io (Postfix) id DD78A160ACA; Fri, 9 Sep 2016 23:40:10 +0000 (UTC) Delivered-To: archive-asf-public@cust-asf.ponee.io Received: from mail.apache.org (hermes.apache.org [140.211.11.3]) by cust-asf.ponee.io (Postfix) with SMTP id E13FB160AE4 for ; Sat, 10 Sep 2016 01:40:06 +0200 (CEST) Received: (qmail 38129 invoked by uid 500); 9 Sep 2016 23:40:06 -0000 Mailing-List: contact commits-help@creadur.apache.org; run by ezmlm Precedence: bulk List-Help: List-Unsubscribe: List-Post: List-Id: Reply-To: dev@creadur.apache.org Delivered-To: mailing list commits@creadur.apache.org Received: (qmail 37602 invoked by uid 99); 9 Sep 2016 23:40:05 -0000 Received: from git1-us-west.apache.org (HELO git1-us-west.apache.org) (140.211.11.23) by apache.org (qpsmtpd/0.29) with ESMTP; Fri, 09 Sep 2016 23:40:05 +0000 Received: by git1-us-west.apache.org (ASF Mail Server at git1-us-west.apache.org, from userid 33) id AD594EEE18; Fri, 9 Sep 2016 23:40:05 +0000 (UTC) Content-Type: text/plain; charset="us-ascii" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit From: khmarbaise@apache.org To: commits@creadur.apache.org Date: Fri, 09 Sep 2016 23:40:23 -0000 Message-Id: <32f2c25afe8d4ee79d52e51617dbcda5@git.apache.org> In-Reply-To: <44ab2c6ede6c471497612debaedd8af4@git.apache.org> References: <44ab2c6ede6c471497612debaedd8af4@git.apache.org> X-Mailer: ASF-Git Admin Mailer Subject: [19/51] [abbrv] [partial] creadur-site git commit: Upgraded site remove apache-rat on root level Updated apache-rat part. archived-at: Fri, 09 Sep 2016 23:40:11 -0000 http://git-wip-us.apache.org/repos/asf/creadur-site/blob/3e6a0709/rat/apache-rat-core/apidocs/org/apache/rat/annotation/AbstractLicenseAppender.html ---------------------------------------------------------------------- diff --git a/rat/apache-rat-core/apidocs/org/apache/rat/annotation/AbstractLicenseAppender.html b/rat/apache-rat-core/apidocs/org/apache/rat/annotation/AbstractLicenseAppender.html new file mode 100644 index 0000000..0ba20af --- /dev/null +++ b/rat/apache-rat-core/apidocs/org/apache/rat/annotation/AbstractLicenseAppender.html @@ -0,0 +1,386 @@ + + + + + +AbstractLicenseAppender (Apache Creadur Rat::Core 0.12 API) + + + + + + + + + + +
+
org.apache.rat.annotation
+

Class AbstractLicenseAppender

+
+
+ +
+
    +
  • +
    +
    Direct Known Subclasses:
    +
    ApacheV2LicenseAppender
    +
    +
    +
    +
    public abstract class AbstractLicenseAppender
    +extends Object
    +
    Add a license header to a document. This appender does not check for the + existence of an existing license header, it is assumed that either a second + license header is intentional or that there is no license header present + already.
    +
  • +
+
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        AbstractLicenseAppender

        +
        public AbstractLicenseAppender()
        +
      • +
      +
    • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        append

        +
        public void append(File document)
        +            throws IOException
        +
        Append the default license header to the supplied document.
        +
        Parameters:
        document - document to append to.
        +
        Throws:
        +
        IOException - if there is a problem while reading or writing the file
        +
      • +
      + + + +
        +
      • +

        getType

        +
        protected int getType(File document)
        +
        Detect the type of document.
        +
        Parameters:
        document - to retrieve type from.
        +
        Returns:
        not null + TODO use existing mechanism to detect the type of a file and record it in the report output, thus we will not need this duplication here.
        +
      • +
      + + + +
        +
      • +

        setForce

        +
        public void setForce(boolean force)
        +
        Set the force flag on this appender. If this flag is set + to true then files will be modified directly, otherwise + new files will be created alongside the existing files.
        +
        Parameters:
        force - force flag.
        +
      • +
      + + + +
        +
      • +

        getLicenseHeader

        +
        public abstract String getLicenseHeader(File document)
        +
        Parameters:
        document - document to extract from.
        +
        Returns:
        Get the license header of a document.
        +
      • +
      + + + +
        +
      • +

        getFirstLine

        +
        protected String getFirstLine(int type)
        +
        Get the first line of the license header formatted + for the given type of file.
        +
        Parameters:
        type - the type of file, see the TYPE_* constants
        +
        Returns:
        not null
        +
      • +
      + + + +
        +
      • +

        getLastLine

        +
        protected String getLastLine(int type)
        +
        Get the last line of the license header formatted + for the given type of file.
        +
        Parameters:
        type - the type of file, see the TYPE_* constants
        +
        Returns:
        not null
        +
      • +
      + + + +
        +
      • +

        getLine

        +
        protected String getLine(int type,
        +             String content)
        +
        Get a line of the license header formatted + for the given type of file.
        +
        Parameters:
        type - the type of file, see the TYPE_* constants
        content - the content for this line
        +
        Returns:
        not null
        +
      • +
      +
    • +
    +
  • +
+
+
+ + + + + +

Copyright © 2006–2016 Apache Software Foundation. All rights reserved.

+ + http://git-wip-us.apache.org/repos/asf/creadur-site/blob/3e6a0709/rat/apache-rat-core/apidocs/org/apache/rat/annotation/ApacheV2LicenseAppender.html ---------------------------------------------------------------------- diff --git a/rat/apache-rat-core/apidocs/org/apache/rat/annotation/ApacheV2LicenseAppender.html b/rat/apache-rat-core/apidocs/org/apache/rat/annotation/ApacheV2LicenseAppender.html new file mode 100644 index 0000000..31b0f67 --- /dev/null +++ b/rat/apache-rat-core/apidocs/org/apache/rat/annotation/ApacheV2LicenseAppender.html @@ -0,0 +1,298 @@ + + + + + +ApacheV2LicenseAppender (Apache Creadur Rat::Core 0.12 API) + + + + + + + + + + +
+
org.apache.rat.annotation
+

Class ApacheV2LicenseAppender

+
+
+ +
+
    +
  • +
    +
    +
    public class ApacheV2LicenseAppender
    +extends AbstractLicenseAppender
    +
    Add an Apache License V2 license header to a + document. This appender does not check for the + existence of an existing license header, it is assumed that either a second + license header is intentional or that there is no license header present + already.
    +
  • +
+
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        ApacheV2LicenseAppender

        +
        public ApacheV2LicenseAppender()
        +
        Create a license appender with the standard ASF license header.
        +
      • +
      + + + +
        +
      • +

        ApacheV2LicenseAppender

        +
        public ApacheV2LicenseAppender(String copyright)
        +
        Create a license appender with the given copyright line. This should be of + the form "Copyright 2008 Foo"
        +
        Parameters:
        copyright - copyright line.
        +
      • +
      +
    • +
    + + +
  • +
+
+
+ + + + + +

Copyright © 2006–2016 Apache Software Foundation. All rights reserved.

+ + http://git-wip-us.apache.org/repos/asf/creadur-site/blob/3e6a0709/rat/apache-rat-core/apidocs/org/apache/rat/annotation/class-use/AbstractLicenseAppender.html ---------------------------------------------------------------------- diff --git a/rat/apache-rat-core/apidocs/org/apache/rat/annotation/class-use/AbstractLicenseAppender.html b/rat/apache-rat-core/apidocs/org/apache/rat/annotation/class-use/AbstractLicenseAppender.html new file mode 100644 index 0000000..f1ee056 --- /dev/null +++ b/rat/apache-rat-core/apidocs/org/apache/rat/annotation/class-use/AbstractLicenseAppender.html @@ -0,0 +1,158 @@ + + + + + +Uses of Class org.apache.rat.annotation.AbstractLicenseAppender (Apache Creadur Rat::Core 0.12 API) + + + + + + + + + +
+

Uses of Class
org.apache.rat.annotation.AbstractLicenseAppender

+
+
+ +
+ + + + +

Copyright © 2006–2016 Apache Software Foundation. All rights reserved.

+ + http://git-wip-us.apache.org/repos/asf/creadur-site/blob/3e6a0709/rat/apache-rat-core/apidocs/org/apache/rat/annotation/class-use/ApacheV2LicenseAppender.html ---------------------------------------------------------------------- diff --git a/rat/apache-rat-core/apidocs/org/apache/rat/annotation/class-use/ApacheV2LicenseAppender.html b/rat/apache-rat-core/apidocs/org/apache/rat/annotation/class-use/ApacheV2LicenseAppender.html new file mode 100644 index 0000000..2041913 --- /dev/null +++ b/rat/apache-rat-core/apidocs/org/apache/rat/annotation/class-use/ApacheV2LicenseAppender.html @@ -0,0 +1,115 @@ + + + + + +Uses of Class org.apache.rat.annotation.ApacheV2LicenseAppender (Apache Creadur Rat::Core 0.12 API) + + + + + + + + + +
+

Uses of Class
org.apache.rat.annotation.ApacheV2LicenseAppender

+
+
No usage of org.apache.rat.annotation.ApacheV2LicenseAppender
+ + + + +

Copyright © 2006–2016 Apache Software Foundation. All rights reserved.

+ + http://git-wip-us.apache.org/repos/asf/creadur-site/blob/3e6a0709/rat/apache-rat-core/apidocs/org/apache/rat/annotation/package-frame.html ---------------------------------------------------------------------- diff --git a/rat/apache-rat-core/apidocs/org/apache/rat/annotation/package-frame.html b/rat/apache-rat-core/apidocs/org/apache/rat/annotation/package-frame.html index c39779d..e77d838 100644 --- a/rat/apache-rat-core/apidocs/org/apache/rat/annotation/package-frame.html +++ b/rat/apache-rat-core/apidocs/org/apache/rat/annotation/package-frame.html @@ -1,34 +1,19 @@ - - - - - - -org.apache.rat.annotation (Apache Creadur Rat::Core 0.11 API) - - - - - - - - - - - -org.apache.rat.annotation - - - - -
-Classes  - -
-AbstractLicenceAppender -
-ApacheV2LicenceAppender
- - - - \ No newline at end of file + + + + + +org.apache.rat.annotation (Apache Creadur Rat::Core 0.12 API) + + + +

org.apache.rat.annotation

+ + + http://git-wip-us.apache.org/repos/asf/creadur-site/blob/3e6a0709/rat/apache-rat-core/apidocs/org/apache/rat/annotation/package-summary.html ---------------------------------------------------------------------- diff --git a/rat/apache-rat-core/apidocs/org/apache/rat/annotation/package-summary.html b/rat/apache-rat-core/apidocs/org/apache/rat/annotation/package-summary.html index 87146ae..5fb629e 100644 --- a/rat/apache-rat-core/apidocs/org/apache/rat/annotation/package-summary.html +++ b/rat/apache-rat-core/apidocs/org/apache/rat/annotation/package-summary.html @@ -1,159 +1,142 @@ - - - - - - -org.apache.rat.annotation (Apache Creadur Rat::Core 0.11 API) - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- -
- - - -
-

-Package org.apache.rat.annotation -

- - - - - - - - - - - - - -
-Class Summary
AbstractLicenceAppenderAdd a licence header to a document.
ApacheV2LicenceAppenderAdd an Apache Licence V2 licence header to a - document.
-  - -

-

-
-
- - - - - - - - - - - - - - - -
- -
- - - -
-Copyright © 2006–2014 Apache Software Foundation. All rights reserved. - - \ No newline at end of file + + + + + +org.apache.rat.annotation (Apache Creadur Rat::Core 0.12 API) + + + + + + +
+ + + + + +
+ + +
+

Package org.apache.rat.annotation

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

Copyright © 2006–2016 Apache Software Foundation. All rights reserved.

+ + http://git-wip-us.apache.org/repos/asf/creadur-site/blob/3e6a0709/rat/apache-rat-core/apidocs/org/apache/rat/annotation/package-tree.html ---------------------------------------------------------------------- diff --git a/rat/apache-rat-core/apidocs/org/apache/rat/annotation/package-tree.html b/rat/apache-rat-core/apidocs/org/apache/rat/annotation/package-tree.html index 8323040..a2264d3 100644 --- a/rat/apache-rat-core/apidocs/org/apache/rat/annotation/package-tree.html +++ b/rat/apache-rat-core/apidocs/org/apache/rat/annotation/package-tree.html @@ -1,151 +1,132 @@ - - - - - - -org.apache.rat.annotation Class Hierarchy (Apache Creadur Rat::Core 0.11 API) - - - - - - - - - - - - - - - - - - - - - - - - - - -
- -
- - - -
-
-

-Hierarchy For Package org.apache.rat.annotation -

-
-
-
Package Hierarchies:
All Packages
-
-

-Class Hierarchy -

- -
- - - - - - - - - - - - - - - -
- -
- - - -
-Copyright © 2006–2014 Apache Software Foundation. All rights reserved. - - \ No newline at end of file + + + + + +org.apache.rat.annotation Class Hierarchy (Apache Creadur Rat::Core 0.12 API) + + + + + + +
+ + + + + +
+ + +
+

Hierarchy For Package org.apache.rat.annotation

+Package Hierarchies: + +
+
+

Class Hierarchy

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

Copyright © 2006–2016 Apache Software Foundation. All rights reserved.

+ + http://git-wip-us.apache.org/repos/asf/creadur-site/blob/3e6a0709/rat/apache-rat-core/apidocs/org/apache/rat/annotation/package-use.html ---------------------------------------------------------------------- diff --git a/rat/apache-rat-core/apidocs/org/apache/rat/annotation/package-use.html b/rat/apache-rat-core/apidocs/org/apache/rat/annotation/package-use.html index 9080992..690952e 100644 --- a/rat/apache-rat-core/apidocs/org/apache/rat/annotation/package-use.html +++ b/rat/apache-rat-core/apidocs/org/apache/rat/annotation/package-use.html @@ -1,166 +1,150 @@ - - - - - - -Uses of Package org.apache.rat.annotation (Apache Creadur Rat::Core 0.11 API) - - - - - - - - - - - - - - - - - - - - - - - - - - -
- -
- - - -
-
-

-Uses of Package
org.apache.rat.annotation

-
- - - - - - - - - -
-Packages that use org.apache.rat.annotation
org.apache.rat.annotation  
-  -

- - - - - - - - -
-Classes in org.apache.rat.annotation used by org.apache.rat.annotation
AbstractLicenceAppender - -
-          Add a licence header to a document.
-  -

-


- - - - - - - - - - - - - - - -
- -
- - - -
-Copyright © 2006–2014 Apache Software Foundation. All rights reserved. - - \ No newline at end of file + + + + + +Uses of Package org.apache.rat.annotation (Apache Creadur Rat::Core 0.12 API) + + + + + + + + + +
+

Uses of Package
org.apache.rat.annotation

+
+
+ +
+ + + + +

Copyright © 2006–2016 Apache Software Foundation. All rights reserved.

+ +