ctubbsii closed pull request #972: Update parent to 3 URL: https://github.com/apache/fluo/pull/972
This is a PR merged from a forked repository. As GitHub hides the original diff on merge, it is displayed below for the sake of provenance: As this is a foreign pull request (from a fork), the diff is supplied below (as it won't show otherwise due to GitHub magic): diff --git a/modules/accumulo/src/test/java/org/apache/fluo/accumulo/iterators/PrewriteIteratorTest.java b/modules/accumulo/src/test/java/org/apache/fluo/accumulo/iterators/PrewriteIteratorTest.java index ad601f5e..aeedba6b 100644 --- a/modules/accumulo/src/test/java/org/apache/fluo/accumulo/iterators/PrewriteIteratorTest.java +++ b/modules/accumulo/src/test/java/org/apache/fluo/accumulo/iterators/PrewriteIteratorTest.java @@ -4,9 +4,9 @@ * copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance with the License. You may obtain a * copy of the License at - * + * * http://www.apache.org/licenses/LICENSE-2.0 - * + * * Unless required by applicable law or agreed to in writing, software distributed under the License * is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express * or implied. See the License for the specific language governing permissions and limitations under @@ -331,7 +331,8 @@ public void testReadLockPreventsWriteLock() { @Test public void testOnlyDelReadLocks() { - //Garbage collection iter may drop read locks and leave del_read_lock entries. Ensure this case works as expected. + // Garbage collection iter may drop read locks and leave del_read_lock entries. Ensure this case + // works as expected. TestData input = new TestData(); input.add("0 f q DEL_RLOCK 42", "50"); input.add("0 f q DEL_RLOCK 39", "44"); @@ -466,7 +467,7 @@ public void testAbortedReadLock() { TestData output = new TestData(newPI(input, startTs), Range.exact("0", "f", "q")); Assert.assertEquals(0, output.data.size()); } - //add this for 2nd iteration, should ignore because delete rolls back + // add this for 2nd iteration, should ignore because delete rolls back input.add("0 f q RLOCK 55", "0 f q"); } } diff --git a/modules/api/src/main/java/org/apache/fluo/api/client/TransactionBase.java b/modules/api/src/main/java/org/apache/fluo/api/client/TransactionBase.java index bb53da5e..08955918 100644 --- a/modules/api/src/main/java/org/apache/fluo/api/client/TransactionBase.java +++ b/modules/api/src/main/java/org/apache/fluo/api/client/TransactionBase.java @@ -63,10 +63,10 @@ /** * Normally when a Fluo transaction reads data and does not write to it, it will not collide with - * other transactions making concurrent writes. When this method is called, all reads will - * acquire a read lock. These read locks cause collisions with transactions doing concurrent - * writes. However, multiple transactions can get concurrent read locks on the same row+col - * without colliding. + * other transactions making concurrent writes. When this method is called, all reads will acquire + * a read lock. These read locks cause collisions with transactions doing concurrent writes. + * However, multiple transactions can get concurrent read locks on the same row+col without + * colliding. * * <p> * Scanning with read locks is not supported. Attempting to call {@code withReadLock().scanner()} diff --git a/modules/api/src/main/java/org/apache/fluo/api/client/scanner/ScannerBuilder.java b/modules/api/src/main/java/org/apache/fluo/api/client/scanner/ScannerBuilder.java index d0714cfb..201385a2 100644 --- a/modules/api/src/main/java/org/apache/fluo/api/client/scanner/ScannerBuilder.java +++ b/modules/api/src/main/java/org/apache/fluo/api/client/scanner/ScannerBuilder.java @@ -4,9 +4,9 @@ * copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance with the License. You may obtain a * copy of the License at - * + * * http://www.apache.org/licenses/LICENSE-2.0 - * + * * Unless required by applicable law or agreed to in writing, software distributed under the License * is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express * or implied. See the License for the specific language governing permissions and limitations under @@ -32,92 +32,95 @@ ScannerBuilder over(Span span); /** - * - * @since 1.2.0 - * @see org.apache.fluo.api.data.Span#exact(Bytes) - * @param row restrict the scanner to data in an exact row - * @return self - */ + * + * @since 1.2.0 + * @see org.apache.fluo.api.data.Span#exact(Bytes) + * @param row restrict the scanner to data in an exact row + * @return self + */ default ScannerBuilder over(Bytes row) { return over(Span.exact(row)); } /** - * - * @since 1.2.0 - * @see org.apache.fluo.api.data.Span#exact(CharSequence) - * @param row restrict the scanner to data in an exact row. String parameters will be encoded as UTF-8 - * @return self - */ + * + * @since 1.2.0 + * @see org.apache.fluo.api.data.Span#exact(CharSequence) + * @param row restrict the scanner to data in an exact row. String parameters will be encoded as + * UTF-8 + * @return self + */ default ScannerBuilder over(CharSequence row) { return over(Span.exact(row)); } /** - * - * @see org.apache.fluo.api.data.Span#exact(Bytes, Column) - * @param row restrict the scanner to data in an exact row - * @param col restrict the scanner to data in exact {@link org.apache.fluo.api.data.Column}. - * @since 1.2.0 - */ + * + * @see org.apache.fluo.api.data.Span#exact(Bytes, Column) + * @param row restrict the scanner to data in an exact row + * @param col restrict the scanner to data in exact {@link org.apache.fluo.api.data.Column}. + * @since 1.2.0 + */ default ScannerBuilder over(Bytes row, Column col) { return over(Span.exact(row, col)); } /** - * - * @see org.apache.fluo.api.data.Span#exact(CharSequence, Column) - * @param row restrict the scanner to data in an exact row - * @param col restrict the scanner to data in exact {@link org.apache.fluo.api.data.Column}. - * @return self - * @since 1.2.0 - */ + * + * @see org.apache.fluo.api.data.Span#exact(CharSequence, Column) + * @param row restrict the scanner to data in an exact row + * @param col restrict the scanner to data in exact {@link org.apache.fluo.api.data.Column}. + * @return self + * @since 1.2.0 + */ default ScannerBuilder over(CharSequence row, Column col) { return over(Span.exact(row, col)); } /** - * - * @see org.apache.fluo.api.data.Span#prefix(Bytes) - * @param rowPrefix restrict the scanner to data in rows that begins with a prefix - * @return self - * @since 1.2.0 - */ + * + * @see org.apache.fluo.api.data.Span#prefix(Bytes) + * @param rowPrefix restrict the scanner to data in rows that begins with a prefix + * @return self + * @since 1.2.0 + */ default ScannerBuilder overPrefix(Bytes rowPrefix) { return over(Span.prefix(rowPrefix)); } /** - * - * @see org.apache.fluo.api.data.Span#prefix(CharSequence) - * @param rowPrefix restrict the scanner to data in rows that begins with a prefix. - * @return self - * @since 1.2.0 - */ + * + * @see org.apache.fluo.api.data.Span#prefix(CharSequence) + * @param rowPrefix restrict the scanner to data in rows that begins with a prefix. + * @return self + * @since 1.2.0 + */ default ScannerBuilder overPrefix(CharSequence rowPrefix) { return over(Span.prefix(rowPrefix)); } /** - * - * @see org.apache.fluo.api.data.Span#prefix(Bytes, Column) - * @param row restrict the scanner to data in an exact row. - * @param colPrefix restrict scanner to data that begins with specifiec {@link org.apache.fluo.api.data.Column} prefix. - * @return self - * @since 1.2.0 - */ + * + * @see org.apache.fluo.api.data.Span#prefix(Bytes, Column) + * @param row restrict the scanner to data in an exact row. + * @param colPrefix restrict scanner to data that begins with specifiec + * {@link org.apache.fluo.api.data.Column} prefix. + * @return self + * @since 1.2.0 + */ default ScannerBuilder overPrefix(Bytes row, Column colPrefix) { return over(Span.prefix(row, colPrefix)); } /** - * - * @see org.apache.fluo.api.data.Span#prefix(CharSequence, Column) - * @param row restrict the scanner to data in an exact row. - * @param colPrefix restrict scanner to data that begins with specifiec {@link org.apache.fluo.api.data.Column} prefix. - * @return self - * @since 1.2.0 - */ + * + * @see org.apache.fluo.api.data.Span#prefix(CharSequence, Column) + * @param row restrict the scanner to data in an exact row. + * @param colPrefix restrict scanner to data that begins with specifiec + * {@link org.apache.fluo.api.data.Column} prefix. + * @return self + * @since 1.2.0 + */ default ScannerBuilder overPrefix(CharSequence row, Column colPrefix) { return over(Span.prefix(row, colPrefix)); } diff --git a/modules/api/src/main/java/org/apache/fluo/api/config/FluoConfiguration.java b/modules/api/src/main/java/org/apache/fluo/api/config/FluoConfiguration.java index 1180297b..9d3ea6e4 100644 --- a/modules/api/src/main/java/org/apache/fluo/api/config/FluoConfiguration.java +++ b/modules/api/src/main/java/org/apache/fluo/api/config/FluoConfiguration.java @@ -4,9 +4,9 @@ * copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance with the License. You may obtain a * copy of the License at - * + * * http://www.apache.org/licenses/LICENSE-2.0 - * + * * Unless required by applicable law or agreed to in writing, software distributed under the License * is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express * or implied. See the License for the specific language governing permissions and limitations under @@ -277,6 +277,7 @@ public void validate() { /** * Sets the {@value #CONNECTION_APPLICATION_NAME_PROP} + * * @param applicationName Must not be null */ public FluoConfiguration setApplicationName(String applicationName) { @@ -286,11 +287,12 @@ public FluoConfiguration setApplicationName(String applicationName) { } /** - * Returns the application name after verification to avoid characters Zookeeper does not like - * in nodes and Hadoop does not like in HDFS paths. + * Returns the application name after verification to avoid characters Zookeeper does not like in + * nodes and Hadoop does not like in HDFS paths. * <p> * Gets the value of the property {@value #CONNECTION_APPLICATION_NAME_PROP} if set - * @return The application name + * + * @return The application name * @throws NoSuchElementException if the property has not been set */ public String getApplicationName() { @@ -345,6 +347,7 @@ private void verifyApplicationName(String name) { /** * Sets the value of the property {@value #CONNECTION_ZOOKEEPERS_PROP} + * * @param zookeepers The instance to use, must not be null. * */ @@ -353,8 +356,9 @@ public FluoConfiguration setInstanceZookeepers(String zookeepers) { } /** - * Gets the value of the property {@value #CONNECTION_ZOOKEEPERS_PROP} and if not set - * returns the default {@value #CONNECTION_ZOOKEEPERS_DEFAULT} + * Gets the value of the property {@value #CONNECTION_ZOOKEEPERS_PROP} and if not set returns the + * default {@value #CONNECTION_ZOOKEEPERS_DEFAULT} + * * @return The zookeeper instance. */ public String getInstanceZookeepers() { @@ -364,6 +368,7 @@ public String getInstanceZookeepers() { /** * Returns the zookeeper application name string. + * * @return The zookeeper application string. */ public String getAppZookeepers() { @@ -371,7 +376,8 @@ public String getAppZookeepers() { } /** - * Sets the value of the property {@value #CONNECTION_ZOOKEEPER_TIMEOUT_PROP} + * Sets the value of the property {@value #CONNECTION_ZOOKEEPER_TIMEOUT_PROP} + * * @param timeout This must be a positive integer */ public FluoConfiguration setZookeeperTimeout(int timeout) { @@ -380,7 +386,7 @@ public FluoConfiguration setZookeeperTimeout(int timeout) { /** * Gets the value of the property {@value #CONNECTION_ZOOKEEPER_TIMEOUT_PROP} and if not set - * returns the default {@value #CONNECTION_ZOOKEEPER_TIMEOUT_DEFAULT} + * returns the default {@value #CONNECTION_ZOOKEEPER_TIMEOUT_DEFAULT} */ public int getZookeeperTimeout() { return getDepPositiveInt(CONNECTION_ZOOKEEPER_TIMEOUT_PROP, CLIENT_ZOOKEEPER_TIMEOUT_PROP, @@ -425,8 +431,9 @@ public int getClientRetryTimeout() { } /** - * Sets the connection retry timeout property {@value #CONNECTION_RETRY_TIMEOUT_MS_PROP} - * in milliseconds. Must be positive. + * Sets the connection retry timeout property {@value #CONNECTION_RETRY_TIMEOUT_MS_PROP} in + * milliseconds. Must be positive. + * * @since 1.2.0 */ public FluoConfiguration setConnectionRetryTimeout(int timeoutMS) { @@ -437,10 +444,10 @@ public FluoConfiguration setConnectionRetryTimeout(int timeoutMS) { } /** - * Returns the value of the property {@value #CONNECTION_RETRY_TIMEOUT_MS_PROP} if it is set, - * else the default value of {@value #CONNECTION_RETRY_TIMEOUT_MS_DEFAULT}. - * The integer returned represents milliseconds and is always positive. - * + * Returns the value of the property {@value #CONNECTION_RETRY_TIMEOUT_MS_PROP} if it is set, else + * the default value of {@value #CONNECTION_RETRY_TIMEOUT_MS_DEFAULT}. The integer returned + * represents milliseconds and is always positive. + * * @since 1.2.0 */ public int getConnectionRetryTimeout() { @@ -455,7 +462,8 @@ public int getConnectionRetryTimeout() { } /** - * Sets the Apache Accumulo instance property {@value #ACCUMULO_INSTANCE_PROP} + * Sets the Apache Accumulo instance property {@value #ACCUMULO_INSTANCE_PROP} + * * @param accumuloInstance The instance to connect to, must not be empty */ public FluoConfiguration setAccumuloInstance(String accumuloInstance) { @@ -471,6 +479,7 @@ public String getAccumuloInstance() { /** * Sets the value of the property {@value #ACCUMULO_USER_PROP} + * * @param accumuloUser The user name to use, must not be null. */ public FluoConfiguration setAccumuloUser(String accumuloUser) { @@ -486,6 +495,7 @@ public String getAccumuloUser() { /** * Sets the Apache Accumulo password property {@value #ACCUMULO_PASSWORD_PROP} + * * @param accumuloPassword The password to use, must not be null. */ public FluoConfiguration setAccumuloPassword(String accumuloPassword) { @@ -495,6 +505,7 @@ public FluoConfiguration setAccumuloPassword(String accumuloPassword) { /** * Gets the Apache Accumulo password property value {@value #ACCUMULO_PASSWORD_PROP} + * * @throws NoSuchElementException if {@value #ACCUMULO_PASSWORD_PROP} is not set */ public String getAccumuloPassword() { @@ -508,6 +519,7 @@ public String getAccumuloPassword() { /** * Sets the value of the property {@value #ACCUMULO_ZOOKEEPERS_PROP} + * * @param zookeepers Must not be null */ public FluoConfiguration setAccumuloZookeepers(String zookeepers) { @@ -515,8 +527,8 @@ public FluoConfiguration setAccumuloZookeepers(String zookeepers) { } /** - * Gets the value of the property {@value #ACCUMULO_ZOOKEEPERS_PROP} if it is set, - * else returns the value of the property {@value #ACCUMULO_ZOOKEEPERS_DEFAULT} + * Gets the value of the property {@value #ACCUMULO_ZOOKEEPERS_PROP} if it is set, else returns + * the value of the property {@value #ACCUMULO_ZOOKEEPERS_DEFAULT} */ public String getAccumuloZookeepers() { return getDepNonEmptyString(ACCUMULO_ZOOKEEPERS_PROP, CLIENT_ACCUMULO_ZOOKEEPERS_PROP, @@ -577,7 +589,8 @@ public String getAccumuloJars() { } /** - * Sets the root for the Hadoop DFS value in property {@value #DFS_ROOT_PROP} + * Sets the root for the Hadoop DFS value in property {@value #DFS_ROOT_PROP} + * * @param dfsRoot The path for the dfs root eg: hdfs://host:port/path note: may not be empty. * @since 1.2.0 */ @@ -586,8 +599,9 @@ public FluoConfiguration setDfsRoot(String dfsRoot) { } /** - * Gets the value of property {@value #DFS_ROOT_PROP} if set, otherwise gets - * the default {@value #DFS_ROOT_DEFAULT} + * Gets the value of property {@value #DFS_ROOT_PROP} if set, otherwise gets the default + * {@value #DFS_ROOT_DEFAULT} + * * @since 1.2.0 */ public String getDfsRoot() { @@ -595,9 +609,10 @@ public String getDfsRoot() { } /** - * Sets the number of worker threads, must be positive. The default is - * {@value #WORKER_NUM_THREADS_DEFAULT} threads. - * Sets this value in the property {@value #WORKER_NUM_THREADS_PROP} + * Sets the number of worker threads, must be positive. The default is + * {@value #WORKER_NUM_THREADS_DEFAULT} threads. Sets this value in the property + * {@value #WORKER_NUM_THREADS_PROP} + * * @param numThreads The number of threads to use, must be positive */ public FluoConfiguration setWorkerThreads(int numThreads) { @@ -605,8 +620,9 @@ public FluoConfiguration setWorkerThreads(int numThreads) { } /** - * Gets the value of the property {@value #WORKER_NUM_THREADS_PROP} if set - * otherwise returns {@value #WORKER_NUM_THREADS_DEFAULT} + * Gets the value of the property {@value #WORKER_NUM_THREADS_PROP} if set otherwise returns + * {@value #WORKER_NUM_THREADS_DEFAULT} + * * @return The number of worker threads being used. */ public int getWorkerThreads() { @@ -711,7 +727,7 @@ public void setObserverProvider(Class<? extends ObserverProvider> clazz) { * Sets directory where observers jars can found for initialization * <p> * Sets the value of the property {@value #OBSERVER_INIT_DIR_PROP} - * + * * @param observerDir Path to directory, must not be null * @since 1.2.0 */ @@ -751,6 +767,7 @@ public FluoConfiguration setObserverJarsUrl(String observerJarsUrl) { * <p> * Gets the value of the property {@value #OBSERVER_JARS_URL_PROP} if set, * {@value #OBSERVER_JARS_URL_DEFAULT} otherwise + * * @since 1.2.0 */ public String getObserverJarsUrl() { @@ -826,9 +843,10 @@ public FluoConfiguration clearObservers() { } /** - * Sets the transaction rollback time, in milliseconds. + * Sets the transaction rollback time, in milliseconds. * <p> * Sets the value of the property {@value #TRANSACTION_ROLLBACK_TIME_PROP} + * * @param time A long representation of the duration, must be positive * @param tu The TimeUnit to use */ @@ -841,6 +859,7 @@ public FluoConfiguration setTransactionRollbackTime(long time, TimeUnit tu) { * <p> * Gets the value of the property {@value #TRANSACTION_ROLLBACK_TIME_PROP} if set, * {@value #TRANSACTION_ROLLBACK_TIME_DEFAULT} otherwise + * * @return A positive long representation of the rollback time. */ public long getTransactionRollbackTime() { @@ -848,10 +867,11 @@ public long getTransactionRollbackTime() { } /** - * Sets the non negative number of threads each loader runs. If setting to zero, - * must also set the queue size to zero. + * Sets the non negative number of threads each loader runs. If setting to zero, must also set the + * queue size to zero. * <p> * Sets the value of the property {@value #LOADER_NUM_THREADS_PROP} + * * @param numThreads Must be positive */ public FluoConfiguration setLoaderThreads(int numThreads) { @@ -863,18 +883,19 @@ public FluoConfiguration setLoaderThreads(int numThreads) { * <p> * Gets the value of the property {@value #LOADER_NUM_THREADS_PROP} if set, * {@value #LOADER_NUM_THREADS_DEFAULT} otherwise - * + * * @return The number of threads each loader runs. */ public int getLoaderThreads() { return getNonNegativeInt(LOADER_NUM_THREADS_PROP, LOADER_NUM_THREADS_DEFAULT); } - /** - * Sets the queue size for the loader. This should be set to zero if - * the number of loader threads is zero. + /** + * Sets the queue size for the loader. This should be set to zero if the number of loader threads + * is zero. * <p> * Sets the value of the property {@value #LOADER_QUEUE_SIZE_PROP} + * * @param queueSize The non negative size of the queue. */ public FluoConfiguration setLoaderQueueSize(int queueSize) { @@ -886,6 +907,7 @@ public FluoConfiguration setLoaderQueueSize(int queueSize) { * <p> * Gets the value of the property {@value #LOADER_QUEUE_SIZE_PROP} if set, * {@value #LOADER_QUEUE_SIZE_DEFAULT} otherwise + * * @return the loader queue size. */ public int getLoaderQueueSize() { @@ -915,6 +937,7 @@ public SimpleConfiguration getAppConfiguration() { /** * Set the value of the property {@value #MINI_START_ACCUMULO_PROP} + * * @param startAccumulo Flag to mini start Accumulo or not */ public FluoConfiguration setMiniStartAccumulo(boolean startAccumulo) { @@ -923,8 +946,8 @@ public FluoConfiguration setMiniStartAccumulo(boolean startAccumulo) { } /** - * Gets the value of the property {@value #MINI_START_ACCUMULO_PROP} if set, - * else gets the value of {@value #MINI_START_ACCUMULO_DEFAULT} + * Gets the value of the property {@value #MINI_START_ACCUMULO_PROP} if set, else gets the value + * of {@value #MINI_START_ACCUMULO_DEFAULT} */ public boolean getMiniStartAccumulo() { return getBoolean(MINI_START_ACCUMULO_PROP, MINI_START_ACCUMULO_DEFAULT); @@ -932,6 +955,7 @@ public boolean getMiniStartAccumulo() { /** * Sets the value of the property {@value #MINI_DATA_DIR_PROP} + * * @param dataDir The path to the directory, must not be null */ public FluoConfiguration setMiniDataDir(String dataDir) { @@ -939,8 +963,8 @@ public FluoConfiguration setMiniDataDir(String dataDir) { } /** - * Gets the value of the property {@value #MINI_DATA_DIR_PROP} if set, - * otherwise gets the value of the property {@value #MINI_DATA_DIR_DEFAULT} + * Gets the value of the property {@value #MINI_DATA_DIR_PROP} if set, otherwise gets the value of + * the property {@value #MINI_DATA_DIR_DEFAULT} */ public String getMiniDataDir() { return getNonEmptyString(MINI_DATA_DIR_PROP, MINI_DATA_DIR_DEFAULT); @@ -979,6 +1003,7 @@ private boolean verifyStringPropNotSet(String... keys) { /** * Verifies that the connection properties are set and and valid. + * * @return A boolean if the requirements have been met. */ public boolean hasRequiredConnectionProps() { @@ -1055,6 +1080,7 @@ public boolean hasRequiredMiniFluoProps() { /** * Returns a SimpleConfiguration clientConfig with properties set from this configuration + * * @return SimpleConfiguration */ public SimpleConfiguration getClientConfiguration() { diff --git a/modules/api/src/main/java/org/apache/fluo/api/data/Bytes.java b/modules/api/src/main/java/org/apache/fluo/api/data/Bytes.java index e6f41b12..dca8b080 100644 --- a/modules/api/src/main/java/org/apache/fluo/api/data/Bytes.java +++ b/modules/api/src/main/java/org/apache/fluo/api/data/Bytes.java @@ -4,9 +4,9 @@ * copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance with the License. You may obtain a * copy of the License at - * + * * http://www.apache.org/licenses/LICENSE-2.0 - * + * * Unless required by applicable law or agreed to in writing, software distributed under the License * is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express * or implied. See the License for the specific language governing permissions and limitations under @@ -39,12 +39,12 @@ * it at the moment. Its very nice having this immutable type, it avoids having to do defensive * copies to ensure correctness. Maybe one day Java will have equivalents of String, StringBuilder, * and Charsequence for bytes. - * + * * <p> * The reason Fluo did not use ByteBuffer is because its not immutable, even a read only ByteBuffer * has a mutable position. This makes ByteBuffer unsuitable for place where an immutable data type * is desirable, like a key for a map. - * + * * <p> * Bytes.EMPTY is used to represent a Bytes object with no data. * @@ -187,14 +187,14 @@ public void writeTo(OutputStream out) throws IOException { } /** - * Compares this to the passed bytes, byte by byte, returning a negative, zero, or positive result - * if the first sequence is less than, equal to, or greater than the second. The comparison is - * performed starting with the first byte of each sequence, and proceeds until a pair of bytes - * differs, or one sequence runs out of byte (is shorter). A shorter sequence is considered less - * than a longer one. - * - * @return comparison result - */ + * Compares this to the passed bytes, byte by byte, returning a negative, zero, or positive result + * if the first sequence is less than, equal to, or greater than the second. The comparison is + * performed starting with the first byte of each sequence, and proceeds until a pair of bytes + * differs, or one sequence runs out of byte (is shorter). A shorter sequence is considered less + * than a longer one. + * + * @return comparison result + */ @Override public final int compareTo(Bytes other) { if (this == other) { @@ -283,6 +283,7 @@ public final boolean equals(Object other) { /** * Returns true if this Bytes object equals another. + * * @since 1.2.0 */ public boolean contentEquals(byte[] bytes) { @@ -290,8 +291,8 @@ public boolean contentEquals(byte[] bytes) { } /** - * Returns true if this Bytes object equals another. - * This method checks it's arguments. + * Returns true if this Bytes object equals another. This method checks it's arguments. + * * @since 1.2.0 */ public boolean contentEquals(byte[] bytes, int offset, int len) { @@ -300,8 +301,8 @@ public boolean contentEquals(byte[] bytes, int offset, int len) { } /** - * Returns true if this Bytes object equals another. - * This method doesn't check it's arguments. + * Returns true if this Bytes object equals another. This method doesn't check it's arguments. + * * @since 1.2.0 */ private boolean contentEqualsUnchecked(byte[] bytes, int offset, int len) { @@ -357,7 +358,7 @@ public static final Bytes of(byte[] data, int offset, int length) { /** * Creates a Bytes object by copying the data of the given ByteBuffer. - * + * * @param bb Data will be read from this ByteBuffer in such a way that its position is not * changed. */ @@ -430,7 +431,7 @@ public static final Bytes of(String s, Charset c) { /** * Checks if this has the passed prefix - * + * * @param prefix is a Bytes object to compare to this * @return true or false * @since 1.1.0 @@ -453,7 +454,7 @@ public boolean startsWith(Bytes prefix) { /** * Checks if this has the passed suffix - * + * * @param suffix is a Bytes object to compare to this * @return true or false * @since 1.1.0 @@ -559,7 +560,7 @@ public BytesBuilder append(int b) { /** * Append a section of bytes from array - * + * * @param bytes - bytes to be appended * @param offset - start of bytes to be appended * @param length - how many bytes from 'offset' to be appended @@ -574,7 +575,7 @@ public BytesBuilder append(byte[] bytes, int offset, int length) { /** * Append a sequence of bytes from an InputStream - * + * * @param in data source to append from * @param length number of bytes to read from data source * @return self @@ -588,7 +589,7 @@ public BytesBuilder append(InputStream in, int length) throws IOException { /** * Append data from a ByteBuffer - * + * * @param bb data is read from the ByteBuffer in such a way that its position is not changed. * @return self */ @@ -643,7 +644,7 @@ public static BytesBuilder builder(int initialCapacity) { /** * Copy entire Bytes object to specific byte array. Uses the specified offset in the dest byte * array to start the copy. - * + * * @param dest destination array * @param destPos starting position in the destination data. * @exception IndexOutOfBoundsException if copying would cause access of data outside array @@ -659,7 +660,7 @@ public void copyTo(byte[] dest, int destPos) { /** * Copy a subsequence of Bytes to specific byte array. Uses the specified offset in the dest byte * array to start the copy. - * + * * @param start index of subsequence start (inclusive) * @param end index of subsequence end (exclusive) * @param dest destination array diff --git a/modules/core/src/main/java/org/apache/fluo/core/impl/FluoConfigurationImpl.java b/modules/core/src/main/java/org/apache/fluo/core/impl/FluoConfigurationImpl.java index b742a508..3c2f5dfb 100644 --- a/modules/core/src/main/java/org/apache/fluo/core/impl/FluoConfigurationImpl.java +++ b/modules/core/src/main/java/org/apache/fluo/core/impl/FluoConfigurationImpl.java @@ -4,9 +4,9 @@ * copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance with the License. You may obtain a * copy of the License at - * + * * http://www.apache.org/licenses/LICENSE-2.0 - * + * * Unless required by applicable law or agreed to in writing, software distributed under the License * is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express * or implied. See the License for the specific language governing permissions and limitations under @@ -107,12 +107,12 @@ public static int getTxCommitMemory(FluoConfiguration conf) { public static final String TX_INFO_CACHE_WEIGHT = FLUO_IMPL_PREFIX + ".tx.failed.cache.weight.mb"; public static final long TX_INFO_CACHE_WEIGHT_DEFAULT = 10_000_000; - /** - * Gets the txinfo cache weight - * + /** + * Gets the txinfo cache weight + * * @param conf The FluoConfiguration - * @return The size of the cache value from the property value {@value #TX_INFO_CACHE_WEIGHT} - * if it is set, else the value of the default value {@value #TX_INFO_CACHE_WEIGHT_DEFAULT} + * @return The size of the cache value from the property value {@value #TX_INFO_CACHE_WEIGHT} if + * it is set, else the value of the default value {@value #TX_INFO_CACHE_WEIGHT_DEFAULT} */ public static long getTxInfoCacheWeight(FluoConfiguration conf) { @@ -128,12 +128,11 @@ public static long getTxInfoCacheWeight(FluoConfiguration conf) { public static final long TX_INFO_CACHE_TIMEOUT_DEFAULT = 24 * 60 * 1000; /** - * Gets the time before stale entries in the cache are evicted based on age. - * This method returns a long representing the time converted from the - * TimeUnit passed in. - * + * Gets the time before stale entries in the cache are evicted based on age. This method returns a + * long representing the time converted from the TimeUnit passed in. + * * @param conf The FluoConfiguration - * @param tu The TimeUnit desired to represent the cache timeout + * @param tu The TimeUnit desired to represent the cache timeout */ public static long getTxIfoCacheTimeout(FluoConfiguration conf, TimeUnit tu) { @@ -148,12 +147,13 @@ public static long getTxIfoCacheTimeout(FluoConfiguration conf, TimeUnit tu) { FLUO_IMPL_PREFIX + ".visibility.cache.weight.mb"; public static final long VISIBILITY_CACHE_WEIGHT_DEFAULT = 10_000_000; - /** + /** * Gets the visibility cache weight - * + * * @param conf The FluoConfiguration * @return The size of the cache value from the property value {@value #VISIBILITY_CACHE_WEIGHT} - * if it is set, else the value of the default value {@value #VISIBILITY_CACHE_WEIGHT_DEFAULT} + * if it is set, else the value of the default value + * {@value #VISIBILITY_CACHE_WEIGHT_DEFAULT} */ public static long getVisibilityCacheWeight(FluoConfiguration conf) { @@ -170,12 +170,11 @@ public static long getVisibilityCacheWeight(FluoConfiguration conf) { public static final long VISIBILITY_CACHE_TIMEOUT_DEFAULT = 24 * 60 * 1000; /** - * Gets the time before stale entries in the cache are evicted based on age. - * This method returns a long representing the time converted from the - * TimeUnit passed in. - * + * Gets the time before stale entries in the cache are evicted based on age. This method returns a + * long representing the time converted from the TimeUnit passed in. + * * @param conf The FluoConfiguration - * @param tu The TimeUnit desired to represent the cache timeout + * @param tu The TimeUnit desired to represent the cache timeout */ public static long getVisibilityCacheTimeout(FluoConfiguration conf, TimeUnit tu) { @@ -188,13 +187,13 @@ public static long getVisibilityCacheTimeout(FluoConfiguration conf, TimeUnit tu private static final String TRANSACTOR_MAX_CACHE_SIZE = FLUO_IMPL_PREFIX + ".transactor.cache.max.size"; - private static final long TRANSACTOR_MAX_CACHE_SIZE_DEFAULT = 32768; // this equals 2^15 + private static final long TRANSACTOR_MAX_CACHE_SIZE_DEFAULT = 32768; // this equals 2^15 /** - * Gets the specified number of entries the cache can contain, this gets the value - * of {@value #TRANSACTOR_MAX_CACHE_SIZE} if set, the default + * Gets the specified number of entries the cache can contain, this gets the value of + * {@value #TRANSACTOR_MAX_CACHE_SIZE} if set, the default * {@value #TRANSACTOR_CACHE_TIMEOUT_DEFAULT} otherwise - * + * * @param conf The FluoConfiguartion * @return The maximum number of entries permitted in this cache */ diff --git a/modules/integration/src/test/java/org/apache/fluo/integration/ITBase.java b/modules/integration/src/test/java/org/apache/fluo/integration/ITBase.java index 4e481e49..b7f3a00a 100644 --- a/modules/integration/src/test/java/org/apache/fluo/integration/ITBase.java +++ b/modules/integration/src/test/java/org/apache/fluo/integration/ITBase.java @@ -4,9 +4,9 @@ * copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance with the License. You may obtain a * copy of the License at - * + * * http://www.apache.org/licenses/LICENSE-2.0 - * + * * Unless required by applicable law or agreed to in writing, software distributed under the License * is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express * or implied. See the License for the specific language governing permissions and limitations under @@ -61,10 +61,10 @@ private final static long JUNIT_TIMEOUT_SECONDS = 120; - /** - * Gets the duration a test will run before timing out under the JUnit rule. - * This value is in seconds. - * + /** + * Gets the duration a test will run before timing out under the JUnit rule. This value is in + * seconds. + * * @return long representation of the time in seconds * @since 1.2.0 */ diff --git a/modules/integration/src/test/java/org/apache/fluo/integration/impl/WorkerIT.java b/modules/integration/src/test/java/org/apache/fluo/integration/impl/WorkerIT.java index d08730fe..d454d908 100644 --- a/modules/integration/src/test/java/org/apache/fluo/integration/impl/WorkerIT.java +++ b/modules/integration/src/test/java/org/apache/fluo/integration/impl/WorkerIT.java @@ -4,9 +4,9 @@ * copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance with the License. You may obtain a * copy of the License at - * + * * http://www.apache.org/licenses/LICENSE-2.0 - * + * * Unless required by applicable law or agreed to in writing, software distributed under the License * is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express * or implied. See the License for the specific language governing permissions and limitations under @@ -39,7 +39,8 @@ import static org.apache.fluo.api.observer.Observer.NotificationType.STRONG; /** - * A simple test that added links between nodes in a graph. There is an observer that updates an index of node degree. + * A simple test that added links between nodes in a graph. There is an observer that updates an + * index of node degree. */ public class WorkerIT extends ITBaseMini { @Rule diff --git a/pom.xml b/pom.xml index ee9021e4..ccd069e2 100644 --- a/pom.xml +++ b/pom.xml @@ -18,7 +18,7 @@ <parent> <groupId>org.apache.fluo</groupId> <artifactId>fluo-parent</artifactId> - <version>2</version> + <version>3</version> </parent> <artifactId>fluo-project</artifactId> <version>1.2.0-SNAPSHOT</version> ---------------------------------------------------------------- This is an automated message from the Apache Git Service. To respond to the message, please log on GitHub and use the URL above to go to the specific comment. For queries about this service, please contact Infrastructure at: us...@infra.apache.org With regards, Apache Git Services
