Author: thomasm
Date: Wed Mar 12 09:46:25 2014
New Revision: 1576674
URL: http://svn.apache.org/r1576674
Log:
OAK-98 Source code formatting, code conventions, Javadocs
Modified:
jackrabbit/oak/trunk/oak-commons/src/main/java/org/apache/jackrabbit/oak/commons/IOUtils.java
jackrabbit/oak/trunk/oak-commons/src/main/java/org/apache/jackrabbit/oak/commons/PathUtils.java
jackrabbit/oak/trunk/oak-commons/src/main/java/org/apache/jackrabbit/oak/commons/cache/Cache.java
jackrabbit/oak/trunk/oak-commons/src/main/java/org/apache/jackrabbit/oak/commons/json/JsopBuilder.java
jackrabbit/oak/trunk/oak-commons/src/main/java/org/apache/jackrabbit/oak/commons/json/JsopReader.java
jackrabbit/oak/trunk/oak-commons/src/main/java/org/apache/jackrabbit/oak/commons/json/JsopStream.java
jackrabbit/oak/trunk/oak-commons/src/main/java/org/apache/jackrabbit/oak/commons/json/JsopTokenizer.java
jackrabbit/oak/trunk/oak-commons/src/test/java/org/apache/jackrabbit/oak/commons/IOUtilsTest.java
jackrabbit/oak/trunk/oak-commons/src/test/java/org/apache/jackrabbit/oak/commons/concurrent/Concurrent.java
Modified:
jackrabbit/oak/trunk/oak-commons/src/main/java/org/apache/jackrabbit/oak/commons/IOUtils.java
URL:
http://svn.apache.org/viewvc/jackrabbit/oak/trunk/oak-commons/src/main/java/org/apache/jackrabbit/oak/commons/IOUtils.java?rev=1576674&r1=1576673&r2=1576674&view=diff
==============================================================================
---
jackrabbit/oak/trunk/oak-commons/src/main/java/org/apache/jackrabbit/oak/commons/IOUtils.java
(original)
+++
jackrabbit/oak/trunk/oak-commons/src/main/java/org/apache/jackrabbit/oak/commons/IOUtils.java
Wed Mar 12 09:46:25 2014
@@ -128,7 +128,7 @@ public final class IOUtils {
public static byte[] readBytes(InputStream in) throws IOException {
int len = readVarInt(in);
byte[] data = new byte[len];
- for (int pos = 0; pos < len; ) {
+ for (int pos = 0; pos < len;) {
int l = in.read(data, pos, data.length - pos);
if (l < 0) {
throw new EOFException();
@@ -166,7 +166,7 @@ public final class IOUtils {
return x;
}
x &= 0x7f;
- for (int s = 7; ; s += 7) {
+ for (int s = 7;; s += 7) {
int b = in.read();
if (b < 0) {
throw new EOFException();
@@ -259,7 +259,7 @@ public final class IOUtils {
return x;
}
x &= 0x7f;
- for (int s = 7; ; s += 7) {
+ for (int s = 7;; s += 7) {
long b = in.read();
if (b < 0) {
throw new EOFException();
Modified:
jackrabbit/oak/trunk/oak-commons/src/main/java/org/apache/jackrabbit/oak/commons/PathUtils.java
URL:
http://svn.apache.org/viewvc/jackrabbit/oak/trunk/oak-commons/src/main/java/org/apache/jackrabbit/oak/commons/PathUtils.java?rev=1576674&r1=1576673&r2=1576674&view=diff
==============================================================================
---
jackrabbit/oak/trunk/oak-commons/src/main/java/org/apache/jackrabbit/oak/commons/PathUtils.java
(original)
+++
jackrabbit/oak/trunk/oak-commons/src/main/java/org/apache/jackrabbit/oak/commons/PathUtils.java
Wed Mar 12 09:46:25 2014
@@ -170,9 +170,8 @@ public final class PathUtils {
Matcher matcher = SNS_PATTERN.matcher(name);
if (matcher.matches()) {
return matcher.group(1);
- } else {
- return name;
}
+ return name;
}
/**
Modified:
jackrabbit/oak/trunk/oak-commons/src/main/java/org/apache/jackrabbit/oak/commons/cache/Cache.java
URL:
http://svn.apache.org/viewvc/jackrabbit/oak/trunk/oak-commons/src/main/java/org/apache/jackrabbit/oak/commons/cache/Cache.java?rev=1576674&r1=1576673&r2=1576674&view=diff
==============================================================================
---
jackrabbit/oak/trunk/oak-commons/src/main/java/org/apache/jackrabbit/oak/commons/cache/Cache.java
(original)
+++
jackrabbit/oak/trunk/oak-commons/src/main/java/org/apache/jackrabbit/oak/commons/cache/Cache.java
Wed Mar 12 09:46:25 2014
@@ -30,6 +30,7 @@ public class Cache<K, V extends Cache.Va
private static final long serialVersionUID = 1L;
+ @Override
protected boolean removeEldestEntry(Map.Entry<K, V> eldest) {
if (memoryUsed.get() < maxMemoryBytes) {
return false;
@@ -102,7 +103,7 @@ public class Cache<K, V extends Cache.Va
/**
* A cacheable object.
*/
- public static interface Value {
+ public interface Value {
/**
* Get the memory required in bytes. The method must always return the
@@ -120,7 +121,7 @@ public class Cache<K, V extends Cache.Va
* @param <K> the key class
* @param <V> the value class
*/
- public static interface Backend<K, V> {
+ public interface Backend<K, V> {
/**
* Load the object. The method does not need to be synchronized
Modified:
jackrabbit/oak/trunk/oak-commons/src/main/java/org/apache/jackrabbit/oak/commons/json/JsopBuilder.java
URL:
http://svn.apache.org/viewvc/jackrabbit/oak/trunk/oak-commons/src/main/java/org/apache/jackrabbit/oak/commons/json/JsopBuilder.java?rev=1576674&r1=1576673&r2=1576674&view=diff
==============================================================================
---
jackrabbit/oak/trunk/oak-commons/src/main/java/org/apache/jackrabbit/oak/commons/json/JsopBuilder.java
(original)
+++
jackrabbit/oak/trunk/oak-commons/src/main/java/org/apache/jackrabbit/oak/commons/json/JsopBuilder.java
Wed Mar 12 09:46:25 2014
@@ -33,11 +33,13 @@ public class JsopBuilder implements Jsop
/**
* Resets this instance.
*/
+ @Override
public void resetWriter() {
needComma = false;
buff.setLength(0);
}
+ @Override
public void setLineLength(int length) {
lineLength = length;
}
@@ -48,6 +50,7 @@ public class JsopBuilder implements Jsop
* @param buffer the buffer
* @return this
*/
+ @Override
public JsopBuilder append(JsopWriter buffer) {
appendTag(buffer.toString());
return this;
@@ -59,6 +62,7 @@ public class JsopBuilder implements Jsop
* @param tag the string to append
* @return this
*/
+ @Override
public JsopBuilder tag(char tag) {
buff.append(tag);
needComma = false;
@@ -84,6 +88,7 @@ public class JsopBuilder implements Jsop
*
* @return this
*/
+ @Override
public JsopBuilder newline() {
buff.append('\n');
return this;
@@ -94,6 +99,7 @@ public class JsopBuilder implements Jsop
*
* @return this
*/
+ @Override
public JsopBuilder object() {
optionalCommaAndNewline(1);
buff.append('{');
@@ -106,6 +112,7 @@ public class JsopBuilder implements Jsop
*
* @return this
*/
+ @Override
public JsopBuilder endObject() {
if (JSON_NEWLINES) {
buff.append("\n}");
@@ -121,6 +128,7 @@ public class JsopBuilder implements Jsop
*
* @return this
*/
+ @Override
public JsopBuilder array() {
optionalCommaAndNewline(1);
buff.append('[');
@@ -133,6 +141,7 @@ public class JsopBuilder implements Jsop
*
* @return this
*/
+ @Override
public JsopBuilder endArray() {
buff.append(']');
needComma = true;
@@ -146,6 +155,7 @@ public class JsopBuilder implements Jsop
* @param name the key
* @return this
*/
+ @Override
public JsopBuilder key(String name) {
optionalCommaAndNewline(name.length());
if (JSON_NEWLINES) {
@@ -162,6 +172,7 @@ public class JsopBuilder implements Jsop
* @param value the value
* @return this
*/
+ @Override
public JsopBuilder value(long value) {
return encodedValue(Long.toString(value));
}
@@ -173,6 +184,7 @@ public class JsopBuilder implements Jsop
* @param value the value
* @return this
*/
+ @Override
public JsopBuilder value(boolean value) {
return encodedValue(Boolean.toString(value));
}
@@ -183,6 +195,7 @@ public class JsopBuilder implements Jsop
* @param value the value
* @return this
*/
+ @Override
public JsopBuilder value(String value) {
return encodedValue(encode(value));
}
@@ -193,6 +206,7 @@ public class JsopBuilder implements Jsop
* @param value the value
* @return this
*/
+ @Override
public JsopBuilder encodedValue(String value) {
optionalCommaAndNewline(value.length());
buff.append(value);
@@ -216,6 +230,7 @@ public class JsopBuilder implements Jsop
/**
* Get the generated string.
*/
+ @Override
public String toString() {
return buff.toString();
}
Modified:
jackrabbit/oak/trunk/oak-commons/src/main/java/org/apache/jackrabbit/oak/commons/json/JsopReader.java
URL:
http://svn.apache.org/viewvc/jackrabbit/oak/trunk/oak-commons/src/main/java/org/apache/jackrabbit/oak/commons/json/JsopReader.java?rev=1576674&r1=1576673&r2=1576674&view=diff
==============================================================================
---
jackrabbit/oak/trunk/oak-commons/src/main/java/org/apache/jackrabbit/oak/commons/json/JsopReader.java
(original)
+++
jackrabbit/oak/trunk/oak-commons/src/main/java/org/apache/jackrabbit/oak/commons/json/JsopReader.java
Wed Mar 12 09:46:25 2014
@@ -26,47 +26,47 @@ public interface JsopReader {
/**
* The token type that signals the end of the stream.
*/
- static final int END = 0;
+ int END = 0;
/**
* The token type of a string value.
*/
- public static final int STRING = 1;
+ int STRING = 1;
/**
* The token type of a number value.
*/
- public static final int NUMBER = 2;
+ int NUMBER = 2;
/**
* The token type of the value "true".
*/
- public static final int TRUE = 3;
+ int TRUE = 3;
/**
* The token type of the value "false".
*/
- public static final int FALSE = 4;
+ int FALSE = 4;
/**
* The token type of "null".
*/
- public static final int NULL = 5;
+ int NULL = 5;
/**
* The token type of a parse error.
*/
- public static final int ERROR = 6;
+ int ERROR = 6;
/**
* The token type of an identifier (an unquoted string), if supported by
the reader.
*/
- public static final int IDENTIFIER = 7;
+ int IDENTIFIER = 7;
/**
* The token type of a comment, if supported by the reader.
*/
- public static final int COMMENT = 8;
+ int COMMENT = 8;
/**
* Read a token which must match a given token type.
Modified:
jackrabbit/oak/trunk/oak-commons/src/main/java/org/apache/jackrabbit/oak/commons/json/JsopStream.java
URL:
http://svn.apache.org/viewvc/jackrabbit/oak/trunk/oak-commons/src/main/java/org/apache/jackrabbit/oak/commons/json/JsopStream.java?rev=1576674&r1=1576673&r2=1576674&view=diff
==============================================================================
---
jackrabbit/oak/trunk/oak-commons/src/main/java/org/apache/jackrabbit/oak/commons/json/JsopStream.java
(original)
+++
jackrabbit/oak/trunk/oak-commons/src/main/java/org/apache/jackrabbit/oak/commons/json/JsopStream.java
Wed Mar 12 09:46:25 2014
@@ -28,6 +28,7 @@ public class JsopStream implements JsopR
// write
+ @Override
public JsopStream append(JsopWriter w) {
JsopStream s = (JsopStream) w;
for (int i = s.pos; i < s.len; i++) {
@@ -74,12 +75,14 @@ public class JsopStream implements JsopR
values = v2;
}
+ @Override
public JsopStream tag(char tag) {
addToken(tag);
needComma = false;
return this;
}
+ @Override
public JsopStream array() {
optionalComma();
addToken('[');
@@ -87,6 +90,7 @@ public class JsopStream implements JsopR
return this;
}
+ @Override
public JsopStream encodedValue(String raw) {
optionalComma();
addToken(COMMENT + addValue(raw));
@@ -94,18 +98,21 @@ public class JsopStream implements JsopR
return this;
}
+ @Override
public JsopStream endArray() {
addToken(']');
needComma = true;
return this;
}
+ @Override
public JsopStream endObject() {
addToken('}');
needComma = true;
return this;
}
+ @Override
public JsopStream key(String key) {
optionalComma();
addToken(STRING + addValue(key));
@@ -114,11 +121,13 @@ public class JsopStream implements JsopR
return this;
}
+ @Override
public JsopStream newline() {
addToken('\n');
return this;
}
+ @Override
public JsopStream object() {
optionalComma();
addToken('{');
@@ -126,6 +135,7 @@ public class JsopStream implements JsopR
return this;
}
+ @Override
public JsopStream value(String value) {
optionalComma();
if (value == null) {
@@ -137,6 +147,7 @@ public class JsopStream implements JsopR
return this;
}
+ @Override
public JsopStream value(long x) {
optionalComma();
addToken(NUMBER + addValue(Long.valueOf(x)));
@@ -144,22 +155,26 @@ public class JsopStream implements JsopR
return this;
}
+ @Override
public JsopStream value(boolean b) {
optionalComma();
addToken(b ? TRUE : FALSE);
needComma = true;
return this;
}
-
+
+ @Override
public void resetReader() {
pos = 0;
}
+ @Override
public void resetWriter() {
needComma = false;
len = 0;
}
+ @Override
public void setLineLength(int i) {
// ignore
}
@@ -172,6 +187,7 @@ public class JsopStream implements JsopR
// read
+ @Override
public String getToken() {
int x = tokens[lastPos];
switch (x & 255) {
@@ -190,10 +206,12 @@ public class JsopStream implements JsopR
return Character.toString((char) (x & 255));
}
+ @Override
public int getTokenType() {
return tokens[lastPos] & 255;
}
+ @Override
public boolean matches(int type) {
if (getType() == type) {
lastPos = pos;
@@ -208,6 +226,7 @@ public class JsopStream implements JsopR
return tokens[pos] & 255;
}
+ @Override
public String read(int type) {
if (matches(type)) {
return getToken();
@@ -215,6 +234,7 @@ public class JsopStream implements JsopR
throw new IllegalArgumentException("expected: " + type + " got: " +
tokens[pos]);
}
+ @Override
public int read() {
int t = getType();
lastPos = pos++;
@@ -231,6 +251,7 @@ public class JsopStream implements JsopR
}
}
+ @Override
public String readRawValue() {
skipNewline();
int x = tokens[pos];
@@ -263,10 +284,12 @@ public class JsopStream implements JsopR
return Character.toString((char) (x & 255));
}
+ @Override
public String readString() {
return read(STRING);
}
+ @Override
public String toString() {
JsopBuilder buff = new JsopBuilder();
for (int i = 0; i < len; i++) {
Modified:
jackrabbit/oak/trunk/oak-commons/src/main/java/org/apache/jackrabbit/oak/commons/json/JsopTokenizer.java
URL:
http://svn.apache.org/viewvc/jackrabbit/oak/trunk/oak-commons/src/main/java/org/apache/jackrabbit/oak/commons/json/JsopTokenizer.java?rev=1576674&r1=1576673&r2=1576674&view=diff
==============================================================================
---
jackrabbit/oak/trunk/oak-commons/src/main/java/org/apache/jackrabbit/oak/commons/json/JsopTokenizer.java
(original)
+++
jackrabbit/oak/trunk/oak-commons/src/main/java/org/apache/jackrabbit/oak/commons/json/JsopTokenizer.java
Wed Mar 12 09:46:25 2014
@@ -47,11 +47,13 @@ public class JsopTokenizer implements Js
this(json, 0);
}
+ @Override
public void resetReader() {
pos = 0;
read();
}
+ @Override
public String toString() {
return jsop;
}
@@ -61,6 +63,7 @@ public class JsopTokenizer implements Js
*
* @return the token type
*/
+ @Override
public int getTokenType() {
return lastType;
}
@@ -72,6 +75,7 @@ public class JsopTokenizer implements Js
*
* @return the token
*/
+ @Override
public String getToken() {
if (lastType > COMMENT) {
return String.valueOf((char) lastType);
@@ -95,6 +99,7 @@ public class JsopTokenizer implements Js
* @return the token (a null object when reading a null value)
* @throws IllegalStateException if the token type doesn't match
*/
+ @Override
public String read(int type) {
if (matches(type)) {
return getToken();
@@ -114,6 +119,7 @@ public class JsopTokenizer implements Js
* @return the de-escaped string
* @throws IllegalStateException if the token type doesn't match
*/
+ @Override
public String readString() {
return read(STRING);
}
@@ -124,6 +130,7 @@ public class JsopTokenizer implements Js
* @param type the token type
* @return true if there was a match
*/
+ @Override
public boolean matches(int type) {
if (currentType == type) {
read();
@@ -137,6 +144,7 @@ public class JsopTokenizer implements Js
*
* @return the token type
*/
+ @Override
public int read() {
lastPos = pos;
lastType = currentType;
@@ -391,6 +399,7 @@ public class JsopTokenizer implements Js
*
* @return the Json representation of the value
*/
+ @Override
public String readRawValue() {
int start = lastPos;
while (start < length && jsop.charAt(start) <= ' ') {
Modified:
jackrabbit/oak/trunk/oak-commons/src/test/java/org/apache/jackrabbit/oak/commons/IOUtilsTest.java
URL:
http://svn.apache.org/viewvc/jackrabbit/oak/trunk/oak-commons/src/test/java/org/apache/jackrabbit/oak/commons/IOUtilsTest.java?rev=1576674&r1=1576673&r2=1576674&view=diff
==============================================================================
---
jackrabbit/oak/trunk/oak-commons/src/test/java/org/apache/jackrabbit/oak/commons/IOUtilsTest.java
(original)
+++
jackrabbit/oak/trunk/oak-commons/src/test/java/org/apache/jackrabbit/oak/commons/IOUtilsTest.java
Wed Mar 12 09:46:25 2014
@@ -38,6 +38,7 @@ public class IOUtilsTest extends TestCas
final AtomicInteger readCount = new AtomicInteger();
r.nextBytes(data);
FilterInputStream in = new FilterInputStream(new
ByteArrayInputStream(data)) {
+ @Override
public int read(byte[] buffer, int off, int max) throws
IOException {
readCount.incrementAndGet();
if (r.nextInt(10) == 0) {
@@ -67,6 +68,7 @@ public class IOUtilsTest extends TestCas
byte[] data = new byte[1000];
r.nextBytes(data);
FilterInputStream in = new FilterInputStream(new
ByteArrayInputStream(data)) {
+ @Override
public int read(byte[] buffer, int off, int max) throws
IOException {
return in.read(buffer, off, Math.min(10, max));
}
@@ -95,6 +97,7 @@ public class IOUtilsTest extends TestCas
IOUtils.writeString(out, s);
byte[] data = out.toByteArray();
ByteArrayInputStream in = new ByteArrayInputStream(data) {
+ @Override
public int read(byte[] b, int off, int len) {
if (r.nextBoolean()) {
len = r.nextInt(len);
Modified:
jackrabbit/oak/trunk/oak-commons/src/test/java/org/apache/jackrabbit/oak/commons/concurrent/Concurrent.java
URL:
http://svn.apache.org/viewvc/jackrabbit/oak/trunk/oak-commons/src/test/java/org/apache/jackrabbit/oak/commons/concurrent/Concurrent.java?rev=1576674&r1=1576673&r2=1576674&view=diff
==============================================================================
---
jackrabbit/oak/trunk/oak-commons/src/test/java/org/apache/jackrabbit/oak/commons/concurrent/Concurrent.java
(original)
+++
jackrabbit/oak/trunk/oak-commons/src/test/java/org/apache/jackrabbit/oak/commons/concurrent/Concurrent.java
Wed Mar 12 09:46:25 2014
@@ -26,8 +26,6 @@ import java.util.concurrent.atomic.Atomi
*/
public class Concurrent {
- private static final boolean PROFILE = false;
-
private Concurrent() {
}
