Author: scolebourne
Date: Mon Aug 22 12:47:12 2005
New Revision: 239232
URL: http://svn.apache.org/viewcvs?rev=239232&view=rev
Log:
Javadoc
Modified:
jakarta/commons/proper/io/trunk/src/java/org/apache/commons/io/HexDump.java
Modified:
jakarta/commons/proper/io/trunk/src/java/org/apache/commons/io/HexDump.java
URL:
http://svn.apache.org/viewcvs/jakarta/commons/proper/io/trunk/src/java/org/apache/commons/io/HexDump.java?rev=239232&r1=239231&r2=239232&view=diff
==============================================================================
--- jakarta/commons/proper/io/trunk/src/java/org/apache/commons/io/HexDump.java
(original)
+++ jakarta/commons/proper/io/trunk/src/java/org/apache/commons/io/HexDump.java
Mon Aug 22 12:47:12 2005
@@ -1,5 +1,5 @@
/*
- * Copyright 2002,2004 The Apache Software Foundation.
+ * Copyright 2002,2004-2005 The Apache Software Foundation.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
@@ -20,9 +20,9 @@
/**
* Dumps data in hexadecimal format.
- *
+ * <p>
* Derived from a HexDump utility I wrote in June 2001.
- *
+ * <p>
* Taken from the POI project.
*
* @author Scott Sanders (sanders at apache dot org)
@@ -34,7 +34,9 @@
/**
* Instances should NOT be constructed in standard programming.
*/
- public HexDump() { }
+ public HexDump() {
+ super();
+ }
/**
* Dump an array of bytes to an OutputStream.
@@ -45,18 +47,18 @@
* written
* @param index initial index into the byte array
*
- * @exception IOException is thrown if anything goes wrong writing
- * the data to stream
- * @exception ArrayIndexOutOfBoundsException if the index is
- * outside the data array's bounds
- * @exception IllegalArgumentException if the output stream is
- * null
+ * @throws IOException is thrown if anything goes wrong writing
+ * the data to stream
+ * @throws ArrayIndexOutOfBoundsException if the index is
+ * outside the data array's bounds
+ * @throws IllegalArgumentException if the output stream is null
*/
public static void dump(byte[] data, long offset,
OutputStream stream, int index)
throws IOException, ArrayIndexOutOfBoundsException,
IllegalArgumentException {
+
if ((index < 0) || (index >= data.length)) {
throw new ArrayIndexOutOfBoundsException(
"illegal index: " + index + " into array of length "
@@ -98,7 +100,9 @@
}
}
- /** line-separator (initializes to "line.separator" system property. */
+ /**
+ * The line-separator (initializes to "line.separator" system property.
+ */
public static final String EOL =
System.getProperty("line.separator");
private static final StringBuffer _lbuffer = new StringBuffer(8);
---------------------------------------------------------------------
To unsubscribe, e-mail: [EMAIL PROTECTED]
For additional commands, e-mail: [EMAIL PROTECTED]
