[jboss-svn-commits] JBoss Common SVN: r3987 - in shrinkwrap/trunk: api/src/main/java/org/jboss/shrinkwrap/api/formatter and 3 other directories.
jboss-svn-commits at lists.jboss.org
jboss-svn-commits at lists.jboss.org
Fri Feb 5 16:47:09 EST 2010
Author: ALRubinger
Date: 2010-02-05 16:47:07 -0500 (Fri, 05 Feb 2010)
New Revision: 3987
Modified:
shrinkwrap/trunk/api/src/main/java/org/jboss/shrinkwrap/api/Archive.java
shrinkwrap/trunk/api/src/main/java/org/jboss/shrinkwrap/api/ArchivePath.java
shrinkwrap/trunk/api/src/main/java/org/jboss/shrinkwrap/api/formatter/Formatters.java
shrinkwrap/trunk/api/src/main/java/org/jboss/shrinkwrap/api/formatter/FormattingConstants.java
shrinkwrap/trunk/api/src/main/java/org/jboss/shrinkwrap/api/formatter/SimpleFormatter.java
shrinkwrap/trunk/api/src/main/java/org/jboss/shrinkwrap/api/formatter/VerboseFormatter.java
shrinkwrap/trunk/impl-base/src/main/java/org/jboss/shrinkwrap/impl/base/exporter/JdkZipExporterDelegate.java
shrinkwrap/trunk/impl-base/src/main/java/org/jboss/shrinkwrap/impl/base/path/BasicPath.java
shrinkwrap/trunk/impl-base/src/main/java/org/jboss/shrinkwrap/impl/base/path/PathUtil.java
shrinkwrap/trunk/impl-base/src/test/java/org/jboss/shrinkwrap/impl/base/formatter/SimpleFormatterTestCase.java
shrinkwrap/trunk/impl-base/src/test/java/org/jboss/shrinkwrap/impl/base/formatter/VerboseFormatterTestCase.java
Log:
[SHRINKWRAP-97] Applied patch by Jason Porter for Formatters unification and introduction of Formatters.FULL
Modified: shrinkwrap/trunk/api/src/main/java/org/jboss/shrinkwrap/api/Archive.java
===================================================================
--- shrinkwrap/trunk/api/src/main/java/org/jboss/shrinkwrap/api/Archive.java 2010-02-05 21:32:39 UTC (rev 3986)
+++ shrinkwrap/trunk/api/src/main/java/org/jboss/shrinkwrap/api/Archive.java 2010-02-05 21:47:07 UTC (rev 3987)
@@ -20,8 +20,6 @@
import org.jboss.shrinkwrap.api.formatter.Formatter;
import org.jboss.shrinkwrap.api.formatter.Formatters;
-import org.jboss.shrinkwrap.api.formatter.SimpleFormatter;
-import org.jboss.shrinkwrap.api.formatter.VerboseFormatter;
/**
* Archive
@@ -222,7 +220,7 @@
/**
* Acts as a shorthand for {@link Archive#toString(Formatter)}
- * where the {@link SimpleFormatter} is leveraged.
+ * where the {@link Formatters#SIMPLE} is leveraged.
*
* @return
*/
@@ -230,7 +228,8 @@
/**
* If "true" is specified, acts as a shorthand for {@link Archive#toString(Formatter)}
- * where the {@link VerboseFormatter} is leveraged. Otherwise the {@link SimpleFormatter}
+ * where the {@link Formatters#VERBOSE} is leveraged. Otherwise the
+ * {@link Formatters#SIMPLE}
* will be used (equivalent to {@link Archive#toString()}).
*
* @return
Modified: shrinkwrap/trunk/api/src/main/java/org/jboss/shrinkwrap/api/ArchivePath.java
===================================================================
--- shrinkwrap/trunk/api/src/main/java/org/jboss/shrinkwrap/api/ArchivePath.java 2010-02-05 21:32:39 UTC (rev 3986)
+++ shrinkwrap/trunk/api/src/main/java/org/jboss/shrinkwrap/api/ArchivePath.java 2010-02-05 21:47:07 UTC (rev 3987)
@@ -31,4 +31,13 @@
* @return
*/
String get();
+
+ /**
+ * Obtains the parent of this Path, if exists, else null.
+ * For instance if the Path is "/my/path", the parent
+ * will be "/my". Each call will result in a new object reference,
+ * though subsequent calls upon the same Path will be equal by value.
+ * @return
+ */
+ ArchivePath getParent();
}
Modified: shrinkwrap/trunk/api/src/main/java/org/jboss/shrinkwrap/api/formatter/Formatters.java
===================================================================
--- shrinkwrap/trunk/api/src/main/java/org/jboss/shrinkwrap/api/formatter/Formatters.java 2010-02-05 21:32:39 UTC (rev 3986)
+++ shrinkwrap/trunk/api/src/main/java/org/jboss/shrinkwrap/api/formatter/Formatters.java 2010-02-05 21:47:07 UTC (rev 3987)
@@ -31,8 +31,25 @@
//-------------------------------------------------------------------------------------||
// Types ------------------------------------------------------------------------------||
//-------------------------------------------------------------------------------------||
- VERBOSE(VerboseFormatter.INSTANCE), SIMPLE(SimpleFormatter.INSTANCE);
+ /**
+ * {@link Formatter} implementation to provide an "ls -l"-esque
+ * output for an {@link Archive}, listing all internal contents
+ * in sorted order.
+ */
+ VERBOSE(VerboseFormatter.INSTANCE),
+ /**
+ * {@link Formatter} implementation to provide a simple, one-line
+ * description of an {@link Archive}, including its name.
+ */
+ SIMPLE(SimpleFormatter.INSTANCE),
+
+ /**
+ * {@link Formatter} implementation to provide a full description
+ * of the contents of the archive, similar to jar -tf archive.
+ */
+ FULL(FullFormatter.INSTANCE);
+
//-------------------------------------------------------------------------------------||
// Internal Members -------------------------------------------------------------------||
//-------------------------------------------------------------------------------------||
Modified: shrinkwrap/trunk/api/src/main/java/org/jboss/shrinkwrap/api/formatter/FormattingConstants.java
===================================================================
--- shrinkwrap/trunk/api/src/main/java/org/jboss/shrinkwrap/api/formatter/FormattingConstants.java 2010-02-05 21:32:39 UTC (rev 3986)
+++ shrinkwrap/trunk/api/src/main/java/org/jboss/shrinkwrap/api/formatter/FormattingConstants.java 2010-02-05 21:47:07 UTC (rev 3987)
@@ -38,4 +38,9 @@
* Space character
*/
char SPACE = ' ';
+
+ /**
+ * Slash character.
+ */
+ char SLASH = '/';
}
Modified: shrinkwrap/trunk/api/src/main/java/org/jboss/shrinkwrap/api/formatter/SimpleFormatter.java
===================================================================
--- shrinkwrap/trunk/api/src/main/java/org/jboss/shrinkwrap/api/formatter/SimpleFormatter.java 2010-02-05 21:32:39 UTC (rev 3986)
+++ shrinkwrap/trunk/api/src/main/java/org/jboss/shrinkwrap/api/formatter/SimpleFormatter.java 2010-02-05 21:47:07 UTC (rev 3987)
@@ -25,7 +25,7 @@
* @author <a href="mailto:andrew.rubinger at jboss.org">ALR</a>
* @version $Revision: $
*/
-public enum SimpleFormatter implements Formatter {
+enum SimpleFormatter implements Formatter {
INSTANCE;
//-------------------------------------------------------------------------------------||
Modified: shrinkwrap/trunk/api/src/main/java/org/jboss/shrinkwrap/api/formatter/VerboseFormatter.java
===================================================================
--- shrinkwrap/trunk/api/src/main/java/org/jboss/shrinkwrap/api/formatter/VerboseFormatter.java 2010-02-05 21:32:39 UTC (rev 3986)
+++ shrinkwrap/trunk/api/src/main/java/org/jboss/shrinkwrap/api/formatter/VerboseFormatter.java 2010-02-05 21:47:07 UTC (rev 3987)
@@ -31,7 +31,7 @@
* @author <a href="mailto:andrew.rubinger at jboss.org">ALR</a>
* @version $Revision: $
*/
-public enum VerboseFormatter implements Formatter {
+enum VerboseFormatter implements Formatter {
INSTANCE;
//-------------------------------------------------------------------------------------||
Modified: shrinkwrap/trunk/impl-base/src/main/java/org/jboss/shrinkwrap/impl/base/exporter/JdkZipExporterDelegate.java
===================================================================
--- shrinkwrap/trunk/impl-base/src/main/java/org/jboss/shrinkwrap/impl/base/exporter/JdkZipExporterDelegate.java 2010-02-05 21:32:39 UTC (rev 3986)
+++ shrinkwrap/trunk/impl-base/src/main/java/org/jboss/shrinkwrap/impl/base/exporter/JdkZipExporterDelegate.java 2010-02-05 21:47:07 UTC (rev 3987)
@@ -232,12 +232,12 @@
* by recursing first and adding parents that
* haven't already been written.
*/
- final ArchivePath parent = PathUtil.getParent(path);
+ final ArchivePath parent = path.getParent();
if (parent != null && !this.pathsExported.contains(parent))
{
// If this is not the root
// SHRINKWRAP-96
- final ArchivePath grandParent = PathUtil.getParent(parent);
+ final ArchivePath grandParent = parent.getParent();
final boolean isRoot = grandParent == null;
if (!isRoot)
{
@@ -355,7 +355,7 @@
private boolean isParentOfSpecifiedHierarchy(final ArchivePath path, final ArchivePath compare)
{
// If we've reached the root, we're not a parent of any paths already exported
- final ArchivePath parent = PathUtil.getParent(compare);
+ final ArchivePath parent = compare.getParent();
if (parent == null)
{
return false;
Modified: shrinkwrap/trunk/impl-base/src/main/java/org/jboss/shrinkwrap/impl/base/path/BasicPath.java
===================================================================
--- shrinkwrap/trunk/impl-base/src/main/java/org/jboss/shrinkwrap/impl/base/path/BasicPath.java 2010-02-05 21:32:39 UTC (rev 3986)
+++ shrinkwrap/trunk/impl-base/src/main/java/org/jboss/shrinkwrap/impl/base/path/BasicPath.java 2010-02-05 21:47:07 UTC (rev 3987)
@@ -134,6 +134,16 @@
/**
* {@inheritDoc}
+ * @see org.jboss.shrinkwrap.api.ArchivePath#getParent()
+ */
+ @Override
+ public ArchivePath getParent()
+ {
+ return PathUtil.getParent(this);
+ }
+
+ /**
+ * {@inheritDoc}
* @see java.lang.Comparable#compareTo(java.lang.Object)
*/
@Override
Modified: shrinkwrap/trunk/impl-base/src/main/java/org/jboss/shrinkwrap/impl/base/path/PathUtil.java
===================================================================
--- shrinkwrap/trunk/impl-base/src/main/java/org/jboss/shrinkwrap/impl/base/path/PathUtil.java 2010-02-05 21:32:39 UTC (rev 3986)
+++ shrinkwrap/trunk/impl-base/src/main/java/org/jboss/shrinkwrap/impl/base/path/PathUtil.java 2010-02-05 21:47:07 UTC (rev 3987)
@@ -235,17 +235,17 @@
// Return as-is
return resolved;
}
-
+
/**
* Obtains the parent of this Path, if exists, else null.
- * For instance if the Path is "/my/path", the parent
+ * For instance if the Path is "/my/path", the parent
* will be "/my". Each call will result in a new object reference,
* though subsequent calls upon the same Path will be equal by value.
* @return
- *
+ *
* @param path The path whose parent context we should return
*/
- public static ArchivePath getParent(final ArchivePath path)
+ static ArchivePath getParent(final ArchivePath path)
{
// Precondition checks
assert path != null : "Path must be specified";
Modified: shrinkwrap/trunk/impl-base/src/test/java/org/jboss/shrinkwrap/impl/base/formatter/SimpleFormatterTestCase.java
===================================================================
--- shrinkwrap/trunk/impl-base/src/test/java/org/jboss/shrinkwrap/impl/base/formatter/SimpleFormatterTestCase.java 2010-02-05 21:32:39 UTC (rev 3986)
+++ shrinkwrap/trunk/impl-base/src/test/java/org/jboss/shrinkwrap/impl/base/formatter/SimpleFormatterTestCase.java 2010-02-05 21:47:07 UTC (rev 3987)
@@ -17,10 +17,10 @@
package org.jboss.shrinkwrap.impl.base.formatter;
import org.jboss.shrinkwrap.api.formatter.Formatter;
-import org.jboss.shrinkwrap.api.formatter.SimpleFormatter;
+import org.jboss.shrinkwrap.api.formatter.Formatters;
/**
- * Ensures that the {@link SimpleFormatter} is functioning
+ * Ensures that the {@link Formatters.SIMPLE} is functioning
* as expected
*
* @author <a href="mailto:andrew.rubinger at jboss.org">ALR</a>
@@ -49,7 +49,7 @@
@Override
Formatter getFormatter()
{
- return SimpleFormatter.INSTANCE;
+ return Formatters.SIMPLE;
}
/**
Modified: shrinkwrap/trunk/impl-base/src/test/java/org/jboss/shrinkwrap/impl/base/formatter/VerboseFormatterTestCase.java
===================================================================
--- shrinkwrap/trunk/impl-base/src/test/java/org/jboss/shrinkwrap/impl/base/formatter/VerboseFormatterTestCase.java 2010-02-05 21:32:39 UTC (rev 3986)
+++ shrinkwrap/trunk/impl-base/src/test/java/org/jboss/shrinkwrap/impl/base/formatter/VerboseFormatterTestCase.java 2010-02-05 21:47:07 UTC (rev 3987)
@@ -17,10 +17,10 @@
package org.jboss.shrinkwrap.impl.base.formatter;
import org.jboss.shrinkwrap.api.formatter.Formatter;
-import org.jboss.shrinkwrap.api.formatter.VerboseFormatter;
+import org.jboss.shrinkwrap.api.formatter.Formatters;
/**
- * Ensures that the {@link VerboseFormatter} is functioning
+ * Ensures that the {@link Formatters.VERBOSE} is functioning
* as expected
*
* @author <a href="mailto:andrew.rubinger at jboss.org">ALR</a>
@@ -47,7 +47,7 @@
@Override
Formatter getFormatter()
{
- return VerboseFormatter.INSTANCE;
+ return Formatters.VERBOSE;
}
/**
More information about the jboss-svn-commits
mailing list