commons-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From bode...@apache.org
Subject commons-compress git commit: COMPRESS-415 fix capitalization of CpioArchive(Entry|InputStream)
Date Tue, 27 Jun 2017 08:51:10 GMT
Repository: commons-compress
Updated Branches:
  refs/heads/master 55ef5769b -> 446843e14


COMPRESS-415 fix capitalization of CpioArchive(Entry|InputStream)


Project: http://git-wip-us.apache.org/repos/asf/commons-compress/repo
Commit: http://git-wip-us.apache.org/repos/asf/commons-compress/commit/446843e1
Tree: http://git-wip-us.apache.org/repos/asf/commons-compress/tree/446843e1
Diff: http://git-wip-us.apache.org/repos/asf/commons-compress/diff/446843e1

Branch: refs/heads/master
Commit: 446843e14a7be6d921bd0076d65092829bed3216
Parents: 55ef576
Author: Stefan Bodewig <bodewig@apache.org>
Authored: Tue Jun 27 10:50:34 2017 +0200
Committer: Stefan Bodewig <bodewig@apache.org>
Committed: Tue Jun 27 10:50:34 2017 +0200

----------------------------------------------------------------------
 src/changes/changes.xml                         |  4 +++
 .../archivers/cpio/CpioArchiveEntry.java        | 32 ++++++++++----------
 .../archivers/cpio/CpioArchiveInputStream.java  |  8 ++---
 .../archivers/cpio/CpioArchiveOutputStream.java |  2 +-
 .../compress/archivers/cpio/CpioConstants.java  |  8 ++---
 5 files changed, 29 insertions(+), 25 deletions(-)
----------------------------------------------------------------------


http://git-wip-us.apache.org/repos/asf/commons-compress/blob/446843e1/src/changes/changes.xml
----------------------------------------------------------------------
diff --git a/src/changes/changes.xml b/src/changes/changes.xml
index de5ca43..e430f25 100644
--- a/src/changes/changes.xml
+++ b/src/changes/changes.xml
@@ -95,6 +95,10 @@ wanted to create such files.">
         It is now possible to specify/read custom PAX headers when
         writing/reading tar archives.
       </action>
+      <action issue="COMPRESS-415" type="fix" date="2017-06-27">
+        Fixed classnames of CpioArchiveEntry and
+        CpioArchiveInputStream in variuous javadocs.
+      </action>
     </release>
     <release version="1.14" date="2017-05-14"
              description="Release 1.14">

http://git-wip-us.apache.org/repos/asf/commons-compress/blob/446843e1/src/main/java/org/apache/commons/compress/archivers/cpio/CpioArchiveEntry.java
----------------------------------------------------------------------
diff --git a/src/main/java/org/apache/commons/compress/archivers/cpio/CpioArchiveEntry.java
b/src/main/java/org/apache/commons/compress/archivers/cpio/CpioArchiveEntry.java
index e5675f0..ef0fc1f 100644
--- a/src/main/java/org/apache/commons/compress/archivers/cpio/CpioArchiveEntry.java
+++ b/src/main/java/org/apache/commons/compress/archivers/cpio/CpioArchiveEntry.java
@@ -188,7 +188,7 @@ public class CpioArchiveEntry implements CpioConstants, ArchiveEntry {
     private long uid = 0;
 
     /**
-     * Creates a CPIOArchiveEntry with a specified format.
+     * Creates a CpioArchiveEntry with a specified format.
      * 
      * @param format
      *            The cpio format for this entry.
@@ -226,7 +226,7 @@ public class CpioArchiveEntry implements CpioConstants, ArchiveEntry {
     }
 
     /**
-     * Creates a CPIOArchiveEntry with a specified name. The format of
+     * Creates a CpioArchiveEntry with a specified name. The format of
      * this entry will be the new format.
      * 
      * @param name
@@ -237,7 +237,7 @@ public class CpioArchiveEntry implements CpioConstants, ArchiveEntry {
     }
 
     /**
-     * Creates a CPIOArchiveEntry with a specified name.
+     * Creates a CpioArchiveEntry with a specified name.
      * 
      * @param format
      *            The cpio format for this entry.
@@ -260,7 +260,7 @@ public class CpioArchiveEntry implements CpioConstants, ArchiveEntry {
     }
 
     /**
-     * Creates a CPIOArchiveEntry with a specified name. The format of
+     * Creates a CpioArchiveEntry with a specified name. The format of
      * this entry will be the new format.
      * 
      * @param name
@@ -274,7 +274,7 @@ public class CpioArchiveEntry implements CpioConstants, ArchiveEntry {
     }
 
     /**
-     * Creates a CPIOArchiveEntry with a specified name.
+     * Creates a CpioArchiveEntry with a specified name.
      * 
      * @param format
      *            The cpio format for this entry.
@@ -300,7 +300,7 @@ public class CpioArchiveEntry implements CpioConstants, ArchiveEntry {
     }
 
     /**
-     * Creates a CPIOArchiveEntry with a specified name for a
+     * Creates a CpioArchiveEntry with a specified name for a
      * specified file. The format of this entry will be the new
      * format.
      * 
@@ -314,7 +314,7 @@ public class CpioArchiveEntry implements CpioConstants, ArchiveEntry {
     }
 
     /**
-     * Creates a CPIOArchiveEntry with a specified name for a
+     * Creates a CpioArchiveEntry with a specified name for a
      * specified file.
      * 
      * @param format
@@ -384,7 +384,7 @@ public class CpioArchiveEntry implements CpioConstants, ArchiveEntry {
      * 
      * @return Returns the device id.
      * @throws UnsupportedOperationException
-     *             if this method is called for a CPIOArchiveEntry with a new
+     *             if this method is called for a CpioArchiveEntry with a new
      *             format.
      */
     public long getDevice() {
@@ -397,7 +397,7 @@ public class CpioArchiveEntry implements CpioConstants, ArchiveEntry {
      * 
      * @return Returns the major device id.
      * @throws UnsupportedOperationException
-     *             if this method is called for a CPIOArchiveEntry with an old
+     *             if this method is called for a CpioArchiveEntry with an old
      *             format.
      */
     public long getDeviceMaj() {
@@ -540,7 +540,7 @@ public class CpioArchiveEntry implements CpioConstants, ArchiveEntry {
      * 
      * @return Returns the remote device id.
      * @throws UnsupportedOperationException
-     *             if this method is called for a CPIOArchiveEntry with a new
+     *             if this method is called for a CpioArchiveEntry with a new
      *             format.
      */
     public long getRemoteDevice() {
@@ -553,7 +553,7 @@ public class CpioArchiveEntry implements CpioConstants, ArchiveEntry {
      * 
      * @return Returns the remote major device id.
      * @throws UnsupportedOperationException
-     *             if this method is called for a CPIOArchiveEntry with an old
+     *             if this method is called for a CpioArchiveEntry with an old
      *             format.
      */
     public long getRemoteDeviceMaj() {
@@ -566,7 +566,7 @@ public class CpioArchiveEntry implements CpioConstants, ArchiveEntry {
      * 
      * @return Returns the remote minor device id.
      * @throws UnsupportedOperationException
-     *             if this method is called for a CPIOArchiveEntry with an old
+     *             if this method is called for a CpioArchiveEntry with an old
      *             format.
      */
     public long getRemoteDeviceMin() {
@@ -688,7 +688,7 @@ public class CpioArchiveEntry implements CpioConstants, ArchiveEntry {
      * @param device
      *            The device id to set.
      * @throws UnsupportedOperationException
-     *             if this method is called for a CPIOArchiveEntry with a new
+     *             if this method is called for a CpioArchiveEntry with a new
      *             format.
      */
     public void setDevice(final long device) {
@@ -806,7 +806,7 @@ public class CpioArchiveEntry implements CpioConstants, ArchiveEntry {
      * @param device
      *            The remote device id to set.
      * @throws UnsupportedOperationException
-     *             if this method is called for a CPIOArchiveEntry with a new
+     *             if this method is called for a CpioArchiveEntry with a new
      *             format.
      */
     public void setRemoteDevice(final long device) {
@@ -820,7 +820,7 @@ public class CpioArchiveEntry implements CpioConstants, ArchiveEntry {
      * @param rmaj
      *            The remote major device id to set.
      * @throws UnsupportedOperationException
-     *             if this method is called for a CPIOArchiveEntry with an old
+     *             if this method is called for a CpioArchiveEntry with an old
      *             format.
      */
     public void setRemoteDeviceMaj(final long rmaj) {
@@ -834,7 +834,7 @@ public class CpioArchiveEntry implements CpioConstants, ArchiveEntry {
      * @param rmin
      *            The remote minor device id to set.
      * @throws UnsupportedOperationException
-     *             if this method is called for a CPIOArchiveEntry with an old
+     *             if this method is called for a CpioArchiveEntry with an old
      *             format.
      */
     public void setRemoteDeviceMin(final long rmin) {

http://git-wip-us.apache.org/repos/asf/commons-compress/blob/446843e1/src/main/java/org/apache/commons/compress/archivers/cpio/CpioArchiveInputStream.java
----------------------------------------------------------------------
diff --git a/src/main/java/org/apache/commons/compress/archivers/cpio/CpioArchiveInputStream.java
b/src/main/java/org/apache/commons/compress/archivers/cpio/CpioArchiveInputStream.java
index 7cf95fd..69bfc87 100644
--- a/src/main/java/org/apache/commons/compress/archivers/cpio/CpioArchiveInputStream.java
+++ b/src/main/java/org/apache/commons/compress/archivers/cpio/CpioArchiveInputStream.java
@@ -31,7 +31,7 @@ import org.apache.commons.compress.utils.CharsetNames;
 import org.apache.commons.compress.utils.IOUtils;
 
 /**
- * CPIOArchiveInputStream is a stream for reading cpio streams. All formats of
+ * CpioArchiveInputStream is a stream for reading cpio streams. All formats of
  * cpio are supported (old ascii, old binary, new portable format and the new
  * portable format with crc).
  *
@@ -41,9 +41,9 @@ import org.apache.commons.compress.utils.IOUtils;
  * specified by the entry.
  * </p>
  * <pre>
- * CPIOArchiveInputStream cpioIn = new CPIOArchiveInputStream(
+ * CpioArchiveInputStream cpioIn = new CpioArchiveInputStream(
  *         Files.newInputStream(Paths.get(&quot;test.cpio&quot;)));
- * CPIOArchiveEntry cpioEntry;
+ * CpioArchiveEntry cpioEntry;
  *
  * while ((cpioEntry = cpioIn.getNextEntry()) != null) {
  *     System.out.println(cpioEntry.getName());
@@ -224,7 +224,7 @@ public class CpioArchiveInputStream extends ArchiveInputStream implements
      * Reads the next CPIO file entry and positions stream at the beginning of
      * the entry data.
      * 
-     * @return the CPIOArchiveEntry just read
+     * @return the CpioArchiveEntry just read
      * @throws IOException
      *             if an I/O error has occurred or if a CPIO file error has
      *             occurred

http://git-wip-us.apache.org/repos/asf/commons-compress/blob/446843e1/src/main/java/org/apache/commons/compress/archivers/cpio/CpioArchiveOutputStream.java
----------------------------------------------------------------------
diff --git a/src/main/java/org/apache/commons/compress/archivers/cpio/CpioArchiveOutputStream.java
b/src/main/java/org/apache/commons/compress/archivers/cpio/CpioArchiveOutputStream.java
index 88ec07e..6423b52 100644
--- a/src/main/java/org/apache/commons/compress/archivers/cpio/CpioArchiveOutputStream.java
+++ b/src/main/java/org/apache/commons/compress/archivers/cpio/CpioArchiveOutputStream.java
@@ -32,7 +32,7 @@ import org.apache.commons.compress.utils.ArchiveUtils;
 import org.apache.commons.compress.utils.CharsetNames;
 
 /**
- * CPIOArchiveOutputStream is a stream for writing CPIO streams. All formats of
+ * CpioArchiveOutputStream is a stream for writing CPIO streams. All formats of
  * CPIO are supported (old ASCII, old binary, new portable format and the new
  * portable format with CRC).
  *

http://git-wip-us.apache.org/repos/asf/commons-compress/blob/446843e1/src/main/java/org/apache/commons/compress/archivers/cpio/CpioConstants.java
----------------------------------------------------------------------
diff --git a/src/main/java/org/apache/commons/compress/archivers/cpio/CpioConstants.java b/src/main/java/org/apache/commons/compress/archivers/cpio/CpioConstants.java
index 2c8dfb0..398ace4 100644
--- a/src/main/java/org/apache/commons/compress/archivers/cpio/CpioConstants.java
+++ b/src/main/java/org/apache/commons/compress/archivers/cpio/CpioConstants.java
@@ -39,16 +39,16 @@ public interface CpioConstants {
 
     // These FORMAT_ constants are internal to the code
 
-    /** write/read a CPIOArchiveEntry in the new format */
+    /** write/read a CpioArchiveEntry in the new format */
     short FORMAT_NEW = 1;
 
-    /** write/read a CPIOArchiveEntry in the new format with crc */
+    /** write/read a CpioArchiveEntry in the new format with crc */
     short FORMAT_NEW_CRC = 2;
 
-    /** write/read a CPIOArchiveEntry in the old ascii format */
+    /** write/read a CpioArchiveEntry in the old ascii format */
     short FORMAT_OLD_ASCII = 4;
 
-    /** write/read a CPIOArchiveEntry in the old binary format */
+    /** write/read a CpioArchiveEntry in the old binary format */
     short FORMAT_OLD_BINARY = 8;
 
     /** Mask for both new formats */


Mime
View raw message