DATACASS-395 - Polishing.

Add Javadoc and static constants of converters. Fix static final modifier keyword order.
This commit is contained in:
Mark Paluch
2017-05-04 14:50:38 +02:00
parent 8737126725
commit a596e1db4e
33 changed files with 165 additions and 23 deletions

View File

@@ -31,7 +31,7 @@ import org.springframework.beans.factory.FactoryBean;
*/
public class MultiLevelSetFlattenerFactoryBean<T> implements FactoryBean<Set<T>> {
private final static Logger log = LoggerFactory.getLogger(MultiLevelSetFlattenerFactoryBean.class);
private static final Logger log = LoggerFactory.getLogger(MultiLevelSetFlattenerFactoryBean.class);
private Set<Set<T>> multiLevelSet;

View File

@@ -84,7 +84,7 @@ public class ReactiveCqlTemplate extends ReactiveCassandraAccessor implements Re
/**
* Placeholder for default values.
*/
private final static Statement DEFAULTS = QueryBuilder.select().from("DEFAULT");
private static final Statement DEFAULTS = QueryBuilder.select().from("DEFAULT");
/**
* If this variable is set to a non-negative value, it will be used for setting the {@code fetchSize} property on

View File

@@ -43,7 +43,7 @@ public enum ReservedKeyword {
TABLE, THREE, TOKEN, TRUNCATE, TWO, UPDATE, USE, USING, WHERE, WITH;
private final static Set<String> RESERVED;
private static final Set<String> RESERVED;
static {
RESERVED = new HashSet<>();

View File

@@ -44,7 +44,7 @@ import com.datastax.driver.core.ResultSet;
*/
public abstract class AbstractResultSetConverter<T> implements Converter<ResultSet, T> {
private final static ResultSetToListConverter converter = new ResultSetToListConverter();
private static final ResultSetToListConverter converter = new ResultSetToListConverter();
/**
* Converts the given value to this converter's type or throws {@link IllegalArgumentException}.

View File

@@ -26,5 +26,5 @@ import org.springframework.core.convert.support.DefaultConversionService;
*/
public abstract class AbstractResultSetToBasicFixedTypeConverter<T> extends AbstractResultSetConverter<T> {
protected final static ConversionService CONVERTER = new DefaultConversionService();
protected static final ConversionService CONVERTER = new DefaultConversionService();
}

View File

@@ -17,8 +17,19 @@ package org.springframework.cassandra.core.converter;
import java.math.BigDecimal;
import org.springframework.core.convert.converter.Converter;
import com.datastax.driver.core.ResultSet;
/**
* {@link Converter} from {@link ResultSet} to a single {@link BigDecimal} value.
*
* @author Mark Paluch
*/
public class ResultSetToBigDecimalConverter extends AbstractResultSetToBasicFixedTypeConverter<BigDecimal> {
public static final ResultSetToBigDecimalConverter INSTANCE = new ResultSetToBigDecimalConverter();
/* (non-Javadoc)
* @see org.springframework.cassandra.core.converter.AbstractResultSetConverter#doConvertSingleValue(java.lang.Object)
*/

View File

@@ -17,8 +17,19 @@ package org.springframework.cassandra.core.converter;
import java.math.BigInteger;
import org.springframework.core.convert.converter.Converter;
import com.datastax.driver.core.ResultSet;
/**
* {@link Converter} from {@link ResultSet} to a single {@link BigInteger} value.
*
* @author Mark Paluch
*/
public class ResultSetToBigIntegerConverter extends AbstractResultSetToBasicFixedTypeConverter<BigInteger> {
public static final ResultSetToBigIntegerConverter INSTANCE = new ResultSetToBigIntegerConverter();
/* (non-Javadoc)
* @see org.springframework.cassandra.core.converter.AbstractResultSetConverter#doConvertSingleValue(java.lang.Object)
*/

View File

@@ -15,8 +15,19 @@
*/
package org.springframework.cassandra.core.converter;
import org.springframework.core.convert.converter.Converter;
import com.datastax.driver.core.ResultSet;
/**
* {@link Converter} from {@link ResultSet} to a single {@link Boolean} value.
*
* @author Mark Paluch
*/
public class ResultSetToBooleanConverter extends AbstractResultSetToBasicFixedTypeConverter<Boolean> {
public static final ResultSetToBooleanConverter INSTANCE = new ResultSetToBooleanConverter();
/* (non-Javadoc)
* @see org.springframework.cassandra.core.converter.AbstractResultSetConverter#doConvertSingleValue(java.lang.Object)
*/

View File

@@ -17,8 +17,19 @@ package org.springframework.cassandra.core.converter;
import java.nio.ByteBuffer;
import org.springframework.core.convert.converter.Converter;
import com.datastax.driver.core.ResultSet;
/**
* {@link Converter} from {@link ResultSet} to a single {@link ByteBuffer} value.
*
* @author Mark Paluch
*/
public class ResultSetToByteBufferConverter extends AbstractResultSetConverter<ByteBuffer> {
public static final ResultSetToByteBufferConverter INSTANCE = new ResultSetToByteBufferConverter();
/* (non-Javadoc)
* @see org.springframework.cassandra.core.converter.AbstractResultSetConverter#doConvertSingleValue(java.lang.Object)
*/

View File

@@ -17,8 +17,19 @@ package org.springframework.cassandra.core.converter;
import java.util.Date;
import org.springframework.core.convert.converter.Converter;
import com.datastax.driver.core.ResultSet;
/**
* {@link Converter} from {@link ResultSet} to a single {@link Date} value.
*
* @author Mark Paluch
*/
public class ResultSetToDateConverter extends AbstractResultSetToBasicFixedTypeConverter<Date> {
public static final ResultSetToDateConverter INSTANCE = new ResultSetToDateConverter();
/* (non-Javadoc)
* @see org.springframework.cassandra.core.converter.AbstractResultSetConverter#doConvertSingleValue(java.lang.Object)
*/

View File

@@ -15,8 +15,19 @@
*/
package org.springframework.cassandra.core.converter;
import org.springframework.core.convert.converter.Converter;
import com.datastax.driver.core.ResultSet;
/**
* {@link Converter} from {@link ResultSet} to a single {@link Double} value.
*
* @author Mark Paluch
*/
public class ResultSetToDoubleConverter extends AbstractResultSetToBasicFixedTypeConverter<Double> {
public static final ResultSetToDoubleConverter INSTANCE = new ResultSetToDoubleConverter();
/* (non-Javadoc)
* @see org.springframework.cassandra.core.converter.AbstractResultSetConverter#doConvertSingleValue(java.lang.Object)
*/

View File

@@ -15,8 +15,19 @@
*/
package org.springframework.cassandra.core.converter;
import org.springframework.core.convert.converter.Converter;
import com.datastax.driver.core.ResultSet;
/**
* {@link Converter} from {@link ResultSet} to a single {@link Float} value.
*
* @author Mark Paluch
*/
public class ResultSetToFloatConverter extends AbstractResultSetToBasicFixedTypeConverter<Float> {
public static final ResultSetToFloatConverter INSTANCE = new ResultSetToFloatConverter();
/* (non-Javadoc)
* @see org.springframework.cassandra.core.converter.AbstractResultSetConverter#doConvertSingleValue(java.lang.Object)
*/

View File

@@ -17,8 +17,19 @@ package org.springframework.cassandra.core.converter;
import java.net.InetAddress;
import org.springframework.core.convert.converter.Converter;
import com.datastax.driver.core.ResultSet;
/**
* {@link Converter} from {@link ResultSet} to a single {@link InetAddress} value.
*
* @author Mark Paluch
*/
public class ResultSetToInetAddressConverter extends AbstractResultSetToBasicFixedTypeConverter<InetAddress> {
public static final ResultSetToInetAddressConverter INSTANCE = new ResultSetToInetAddressConverter();
/* (non-Javadoc)
* @see org.springframework.cassandra.core.converter.AbstractResultSetConverter#doConvertSingleValue(java.lang.Object)
*/

View File

@@ -15,8 +15,19 @@
*/
package org.springframework.cassandra.core.converter;
import org.springframework.core.convert.converter.Converter;
import com.datastax.driver.core.ResultSet;
/**
* {@link Converter} from {@link ResultSet} to a single {@link Integer} value.
*
* @author Mark Paluch
*/
public class ResultSetToIntegerConverter extends AbstractResultSetToBasicFixedTypeConverter<Integer> {
public static final ResultSetToIntegerConverter INSTANCE = new ResultSetToIntegerConverter();
/* (non-Javadoc)
* @see org.springframework.cassandra.core.converter.AbstractResultSetConverter#doConvertSingleValue(java.lang.Object)
*/

View File

@@ -20,10 +20,20 @@ import java.util.List;
import java.util.Map;
import java.util.stream.Collectors;
import org.springframework.core.convert.converter.Converter;
import org.springframework.util.StringUtils;
import com.datastax.driver.core.ResultSet;
/**
* {@link Converter} from {@link ResultSet} to a {@link List} of {@link String}.
*
* @author Mark Paluch
*/
public class ResultSetToListOfStringConverter extends AbstractResultSetConverter<List<String>> {
public static final ResultSetToListOfStringConverter INSTANCE = new ResultSetToListOfStringConverter();
/* (non-Javadoc)
* @see org.springframework.cassandra.core.converter.AbstractResultSetConverter#doConvertSingleValue(java.lang.Object)
*/

View File

@@ -15,8 +15,19 @@
*/
package org.springframework.cassandra.core.converter;
import org.springframework.core.convert.converter.Converter;
import com.datastax.driver.core.ResultSet;
/**
* {@link Converter} from {@link ResultSet} to a single {@link Long} value.
*
* @author Mark Paluch
*/
public class ResultSetToLongConverter extends AbstractResultSetToBasicFixedTypeConverter<Long> {
public static final ResultSetToLongConverter INSTANCE = new ResultSetToLongConverter();
/* (non-Javadoc)
* @see org.springframework.cassandra.core.converter.AbstractResultSetConverter#doConvertSingleValue(java.lang.Object)
*/

View File

@@ -18,8 +18,19 @@ package org.springframework.cassandra.core.converter;
import java.util.List;
import java.util.Map;
import org.springframework.core.convert.converter.Converter;
import com.datastax.driver.core.ResultSet;
/**
* {@link Converter} from {@link ResultSet} to a single {@link String} value.
*
* @author Mark Paluch
*/
public class ResultSetToStringConverter extends AbstractResultSetConverter<String> {
public static final ResultSetToStringConverter INSTANCE = new ResultSetToStringConverter();
/* (non-Javadoc)
* @see org.springframework.cassandra.core.converter.AbstractResultSetConverter#doConvertSingleValue(java.lang.Object)
*/

View File

@@ -17,8 +17,19 @@ package org.springframework.cassandra.core.converter;
import java.util.UUID;
import org.springframework.core.convert.converter.Converter;
import com.datastax.driver.core.ResultSet;
/**
* {@link Converter} from {@link ResultSet} to a single {@link UUID} value.
*
* @author Mark Paluch
*/
public class ResultSetToUuidConverter extends AbstractResultSetToBasicFixedTypeConverter<UUID> {
public static final ResultSetToUuidConverter INSTANCE = new ResultSetToUuidConverter();
/* (non-Javadoc)
* @see org.springframework.cassandra.core.converter.AbstractResultSetConverter#doConvertSingleValue(java.lang.Object)
*/

View File

@@ -64,7 +64,7 @@ public class CassandraAccessor implements InitializingBean {
/**
* Placeholder for default values.
*/
private final static Statement DEFAULTS = QueryBuilder.select().from("DEFAULT");
private static final Statement DEFAULTS = QueryBuilder.select().from("DEFAULT");
/** Logger available to subclasses */
protected final Logger logger = LoggerFactory.getLogger(getClass());

View File

@@ -38,7 +38,7 @@ public abstract class AbstractEmbeddedCassandraIntegrationTest {
/**
* Initiate a Cassandra environment in test class scope.
*/
@ClassRule public final static CassandraRule cassandraEnvironment = new CassandraRule("embedded-cassandra.yaml");
@ClassRule public static final CassandraRule cassandraEnvironment = new CassandraRule("embedded-cassandra.yaml");
/**
* Initiate a Cassandra environment in test scope.

View File

@@ -40,7 +40,7 @@ public abstract class AbstractKeyspaceCreatingIntegrationTest extends AbstractEm
* Class rule to prepare a keyspace to give tests a keyspace context. The keyspace name is random and changes per
* test.
*/
@ClassRule public final static KeyspaceRule keyspaceRule = new KeyspaceRule(cassandraEnvironment);
@ClassRule public static final KeyspaceRule keyspaceRule = new KeyspaceRule(cassandraEnvironment);
/**
* The session that's connected to the keyspace used in the current instance's test.

View File

@@ -384,9 +384,9 @@ public class CassandraRule extends ExternalResource {
*/
public static class InvocationMode {
private final static InvocationMode once = new InvocationMode();
private final static InvocationMode each = new InvocationMode();
private final static InvocationMode never = new InvocationMode();
private static final InvocationMode once = new InvocationMode();
private static final InvocationMode each = new InvocationMode();
private static final InvocationMode never = new InvocationMode();
/**
* Invocation mode to invoke an action once at before the first test.

View File

@@ -50,8 +50,8 @@ class EmbeddedCassandraServerHelper {
public static final long DEFAULT_STARTUP_TIMEOUT_MS = TimeUnit.SECONDS.toMillis(20);
public static final String DEFAULT_TMP_DIR = "target/embeddedCassandra";
private final static AtomicReference<Object> sync = new AtomicReference<>();
private final static AtomicReference<CassandraDaemon> cassandraRef = new AtomicReference<>();
private static final AtomicReference<Object> sync = new AtomicReference<>();
private static final AtomicReference<CassandraDaemon> cassandraRef = new AtomicReference<>();
private static String launchedYamlFile;

View File

@@ -31,7 +31,7 @@ import com.datastax.driver.core.Host.StateListener;
*/
public class TestHostStateListener implements StateListener {
private final static Logger log = LoggerFactory.getLogger(TestHostStateListener.class);
private static final Logger log = LoggerFactory.getLogger(TestHostStateListener.class);
@Override
public void onAdd(Host host) {

View File

@@ -33,7 +33,7 @@ import com.datastax.driver.core.Statement;
*/
public class TestLatencyTracker implements LatencyTracker {
private final static Logger LOG = LoggerFactory.getLogger(TestLatencyTracker.class);
private static final Logger LOG = LoggerFactory.getLogger(TestLatencyTracker.class);
@Override
public void update(Host host, Statement statement, Exception exception, long newLatencyNanos) {

View File

@@ -41,7 +41,7 @@ import com.datastax.driver.core.TableOptionsMetadata;
*/
public class CqlTableSpecificationAssertions {
private final static Logger log = LoggerFactory.getLogger(CqlTableSpecificationAssertions.class);
private static final Logger log = LoggerFactory.getLogger(CqlTableSpecificationAssertions.class);
public static double DELTA = 1e-6; // delta for comparisons of doubles

View File

@@ -34,7 +34,7 @@ import org.springframework.cassandra.test.integration.AbstractKeyspaceCreatingIn
*/
public class IndexLifecycleCqlGeneratorIntegrationTests extends AbstractKeyspaceCreatingIntegrationTest {
private final static Logger log = LoggerFactory.getLogger(IndexLifecycleCqlGeneratorIntegrationTests.class);
private static final Logger log = LoggerFactory.getLogger(IndexLifecycleCqlGeneratorIntegrationTests.class);
@Before
public void setUp() throws Exception {

View File

@@ -36,7 +36,7 @@ import org.springframework.cassandra.test.integration.AbstractKeyspaceCreatingIn
*/
public class TableLifecycleIntegrationTests extends AbstractKeyspaceCreatingIntegrationTest {
private final static Logger log = LoggerFactory.getLogger(TableLifecycleIntegrationTests.class);
private static final Logger log = LoggerFactory.getLogger(TableLifecycleIntegrationTests.class);
CreateTableCqlGeneratorUnitTests.MultipleOptionsTest createTableTest = new CreateTableCqlGeneratorUnitTests.MultipleOptionsTest();

View File

@@ -31,7 +31,7 @@ import org.springframework.cassandra.test.integration.AbstractKeyspaceCreatingIn
*/
public class TableOptionsIntegrationTests extends AbstractKeyspaceCreatingIntegrationTest {
private final static Logger log = LoggerFactory.getLogger(TableOptionsIntegrationTests.class);
private static final Logger log = LoggerFactory.getLogger(TableOptionsIntegrationTests.class);
@Test
public void test() {

View File

@@ -30,7 +30,7 @@ import com.datastax.driver.core.QueryOptions;
@Configuration
public abstract class AbstractTestJavaConfig extends AbstractSessionConfiguration {
private final static CassandraConnectionProperties PROPERTIES = new CassandraConnectionProperties();
private static final CassandraConnectionProperties PROPERTIES = new CassandraConnectionProperties();
@Override
protected int getPort() {

View File

@@ -32,7 +32,7 @@ import com.datastax.driver.core.NettyOptions;
*/
public class IntegrationTestNettyOptions extends NettyOptions {
public final static IntegrationTestNettyOptions INSTANCE = new IntegrationTestNettyOptions();
public static final IntegrationTestNettyOptions INSTANCE = new IntegrationTestNettyOptions();
private volatile static EventLoopGroup eventLoopGroup;
private volatile static Timer timer;

View File

@@ -44,7 +44,7 @@ import com.datastax.driver.core.TypeCodec;
*/
class ConvertingParameterAccessor implements CassandraParameterAccessor {
private final static TypeInformation<Set> SET = ClassTypeInformation.from(Set.class);
private static final TypeInformation<Set> SET = ClassTypeInformation.from(Set.class);
private final CassandraConverter converter;

View File

@@ -48,7 +48,7 @@ import com.google.common.util.concurrent.Service;
*/
class CassandraOperationsProducer {
public final static String KEYSPACE_NAME = RandomKeySpaceName.create();
public static final String KEYSPACE_NAME = RandomKeySpaceName.create();
@Produces
@Singleton