You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@commons.apache.org by bo...@apache.org on 2018/05/05 16:37:15 UTC

commons-compress git commit: clarify what to expect from the entry's name

Repository: commons-compress
Updated Branches:
  refs/heads/master 0aeda4fcc -> f763ccc0b


clarify what to expect from the entry's name


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

Branch: refs/heads/master
Commit: f763ccc0bbb0748df1dc8d306e9bf6331327843c
Parents: 0aeda4f
Author: Stefan Bodewig <bo...@apache.org>
Authored: Sat May 5 18:36:46 2018 +0200
Committer: Stefan Bodewig <bo...@apache.org>
Committed: Sat May 5 18:36:46 2018 +0200

----------------------------------------------------------------------
 .../java/org/apache/commons/compress/archivers/ArchiveEntry.java  | 2 ++
 .../apache/commons/compress/archivers/arj/ArjArchiveEntry.java    | 2 ++
 .../apache/commons/compress/archivers/cpio/CpioArchiveEntry.java  | 2 ++
 .../java/org/apache/commons/compress/archivers/dump/Dirent.java   | 3 +++
 .../apache/commons/compress/archivers/dump/DumpArchiveEntry.java  | 3 +++
 .../commons/compress/archivers/sevenz/SevenZArchiveEntry.java     | 2 ++
 .../apache/commons/compress/archivers/tar/TarArchiveEntry.java    | 2 ++
 .../apache/commons/compress/archivers/zip/ZipArchiveEntry.java    | 3 +++
 8 files changed, 19 insertions(+)
----------------------------------------------------------------------


http://git-wip-us.apache.org/repos/asf/commons-compress/blob/f763ccc0/src/main/java/org/apache/commons/compress/archivers/ArchiveEntry.java
----------------------------------------------------------------------
diff --git a/src/main/java/org/apache/commons/compress/archivers/ArchiveEntry.java b/src/main/java/org/apache/commons/compress/archivers/ArchiveEntry.java
index bf31f00..d5fa746 100644
--- a/src/main/java/org/apache/commons/compress/archivers/ArchiveEntry.java
+++ b/src/main/java/org/apache/commons/compress/archivers/ArchiveEntry.java
@@ -28,6 +28,8 @@ public interface ArchiveEntry {
     /**
      * Gets the name of the entry in this archive. May refer to a file or directory or other item.
      *
+     * <p>This method returns the raw name as it is stored inside of the archive.</p>
+     *
      * @return The name of this entry in the archive.
      */
     String getName();

http://git-wip-us.apache.org/repos/asf/commons-compress/blob/f763ccc0/src/main/java/org/apache/commons/compress/archivers/arj/ArjArchiveEntry.java
----------------------------------------------------------------------
diff --git a/src/main/java/org/apache/commons/compress/archivers/arj/ArjArchiveEntry.java b/src/main/java/org/apache/commons/compress/archivers/arj/ArjArchiveEntry.java
index 7bee5bc..ab847db 100644
--- a/src/main/java/org/apache/commons/compress/archivers/arj/ArjArchiveEntry.java
+++ b/src/main/java/org/apache/commons/compress/archivers/arj/ArjArchiveEntry.java
@@ -44,6 +44,8 @@ public class ArjArchiveEntry implements ArchiveEntry {
     /**
      * Get this entry's name.
      *
+     * <p>This method returns the raw name as it is stored inside of the archive.</p>
+     *
      * @return This entry's name.
      */
     @Override

http://git-wip-us.apache.org/repos/asf/commons-compress/blob/f763ccc0/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 e1e04e9..28e5823 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
@@ -517,6 +517,8 @@ public class CpioArchiveEntry implements CpioConstants, ArchiveEntry {
     /**
      * Get the name.
      *
+     * <p>This method returns the raw name as it is stored inside of the archive.</p>
+     *
      * @return Returns the name.
      */
     @Override

http://git-wip-us.apache.org/repos/asf/commons-compress/blob/f763ccc0/src/main/java/org/apache/commons/compress/archivers/dump/Dirent.java
----------------------------------------------------------------------
diff --git a/src/main/java/org/apache/commons/compress/archivers/dump/Dirent.java b/src/main/java/org/apache/commons/compress/archivers/dump/Dirent.java
index ff9b53f..b5af964 100644
--- a/src/main/java/org/apache/commons/compress/archivers/dump/Dirent.java
+++ b/src/main/java/org/apache/commons/compress/archivers/dump/Dirent.java
@@ -68,6 +68,9 @@ class Dirent {
 
     /**
      * Get name of directory entry.
+     *
+     * <p>This method returns the raw name as it is stored inside of the archive.</p>
+     *
      * @return the directory name
      */
     String getName() {

http://git-wip-us.apache.org/repos/asf/commons-compress/blob/f763ccc0/src/main/java/org/apache/commons/compress/archivers/dump/DumpArchiveEntry.java
----------------------------------------------------------------------
diff --git a/src/main/java/org/apache/commons/compress/archivers/dump/DumpArchiveEntry.java b/src/main/java/org/apache/commons/compress/archivers/dump/DumpArchiveEntry.java
index 43db740..e284505 100644
--- a/src/main/java/org/apache/commons/compress/archivers/dump/DumpArchiveEntry.java
+++ b/src/main/java/org/apache/commons/compress/archivers/dump/DumpArchiveEntry.java
@@ -562,6 +562,9 @@ public class DumpArchiveEntry implements ArchiveEntry {
 
     /**
      * Returns the name of the entry.
+     *
+     * <p>This method returns the raw name as it is stored inside of the archive.</p>
+     *
      * @return the name of the entry.
      */
     @Override

http://git-wip-us.apache.org/repos/asf/commons-compress/blob/f763ccc0/src/main/java/org/apache/commons/compress/archivers/sevenz/SevenZArchiveEntry.java
----------------------------------------------------------------------
diff --git a/src/main/java/org/apache/commons/compress/archivers/sevenz/SevenZArchiveEntry.java b/src/main/java/org/apache/commons/compress/archivers/sevenz/SevenZArchiveEntry.java
index df78eae..f95426b 100644
--- a/src/main/java/org/apache/commons/compress/archivers/sevenz/SevenZArchiveEntry.java
+++ b/src/main/java/org/apache/commons/compress/archivers/sevenz/SevenZArchiveEntry.java
@@ -55,6 +55,8 @@ public class SevenZArchiveEntry implements ArchiveEntry {
     /**
      * Get this entry's name.
      *
+     * <p>This method returns the raw name as it is stored inside of the archive.</p>
+     *
      * @return This entry's name.
      */
     @Override

http://git-wip-us.apache.org/repos/asf/commons-compress/blob/f763ccc0/src/main/java/org/apache/commons/compress/archivers/tar/TarArchiveEntry.java
----------------------------------------------------------------------
diff --git a/src/main/java/org/apache/commons/compress/archivers/tar/TarArchiveEntry.java b/src/main/java/org/apache/commons/compress/archivers/tar/TarArchiveEntry.java
index 2989eff..ac98f0a 100644
--- a/src/main/java/org/apache/commons/compress/archivers/tar/TarArchiveEntry.java
+++ b/src/main/java/org/apache/commons/compress/archivers/tar/TarArchiveEntry.java
@@ -455,6 +455,8 @@ public class TarArchiveEntry implements ArchiveEntry, TarConstants {
     /**
      * Get this entry's name.
      *
+     * <p>This method returns the raw name as it is stored inside of the archive.</p>
+     *
      * @return This entry's name.
      */
     @Override

http://git-wip-us.apache.org/repos/asf/commons-compress/blob/f763ccc0/src/main/java/org/apache/commons/compress/archivers/zip/ZipArchiveEntry.java
----------------------------------------------------------------------
diff --git a/src/main/java/org/apache/commons/compress/archivers/zip/ZipArchiveEntry.java b/src/main/java/org/apache/commons/compress/archivers/zip/ZipArchiveEntry.java
index bbb451b..4a09eac 100644
--- a/src/main/java/org/apache/commons/compress/archivers/zip/ZipArchiveEntry.java
+++ b/src/main/java/org/apache/commons/compress/archivers/zip/ZipArchiveEntry.java
@@ -671,6 +671,9 @@ public class ZipArchiveEntry extends java.util.zip.ZipEntry
 
     /**
      * Get the name of the entry.
+     *
+     * <p>This method returns the raw name as it is stored inside of the archive.</p>
+     *
      * @return the entry name
      */
     @Override