Skip to content

Add final to public API #1293

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Aug 23, 2022
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 20 additions & 0 deletions driver/clirr-ignored-differences.xml
Original file line number Diff line number Diff line change
Expand Up @@ -371,4 +371,24 @@
<method>org.neo4j.driver.Driver routingDriver(java.lang.Iterable, org.neo4j.driver.AuthToken, org.neo4j.driver.Config)</method>
</difference>

<difference>
<className>org/neo4j/driver/AuthTokens</className>
<differenceType>3003</differenceType>
</difference>

<difference>
<className>org/neo4j/driver/GraphDatabase</className>
<differenceType>3003</differenceType>
</difference>

<difference>
<className>org/neo4j/driver/Query</className>
<differenceType>3003</differenceType>
</difference>

<difference>
<className>org/neo4j/driver/Records</className>
<differenceType>3003</differenceType>
</difference>

</differences>
2 changes: 1 addition & 1 deletion driver/src/main/java/org/neo4j/driver/AuthTokens.java
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@
* @see GraphDatabase#driver(String, AuthToken)
* @since 1.0
*/
public class AuthTokens {
public final class AuthTokens {
private AuthTokens() {}

/**
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -78,7 +78,7 @@ public Optional<BookmarksSupplier> bookmarksSupplier() {
/**
* Builder used to configure {@link BookmarkManagerConfig} which will be used to create a bookmark manager.
*/
public static class BookmarkManagerConfigBuilder {
public static final class BookmarkManagerConfigBuilder {
private Map<String, Set<Bookmark>> initialBookmarks = Collections.emptyMap();
private BiConsumer<String, Set<Bookmark>> bookmarksConsumer;
private BookmarksSupplier bookmarksSupplier;
Expand Down
5 changes: 3 additions & 2 deletions driver/src/main/java/org/neo4j/driver/BookmarkManagers.java
Original file line number Diff line number Diff line change
Expand Up @@ -23,14 +23,15 @@
/**
* Setups new instances of {@link BookmarkManager}.
*/
public interface BookmarkManagers {
public final class BookmarkManagers {
private BookmarkManagers() {}
/**
* Setups a new instance of bookmark manager that can be used in {@link org.neo4j.driver.Config.ConfigBuilder#withBookmarkManager(BookmarkManager)}.
*
* @param config the bookmark manager configuration
* @return the bookmark manager
*/
static BookmarkManager defaultManager(BookmarkManagerConfig config) {
public static BookmarkManager defaultManager(BookmarkManagerConfig config) {
return new Neo4jBookmarkManager(
config.initialBookmarks(),
config.bookmarksConsumer().orElse(null),
Expand Down
6 changes: 3 additions & 3 deletions driver/src/main/java/org/neo4j/driver/Config.java
Original file line number Diff line number Diff line change
Expand Up @@ -70,7 +70,7 @@
* @since 1.0
*/
@Immutable
public class Config implements Serializable {
public final class Config implements Serializable {
@Serial
private static final long serialVersionUID = -4496545746399601108L;

Expand Down Expand Up @@ -268,7 +268,7 @@ public Optional<BookmarkManager> bookmarkManager() {
/**
* Used to build new config instances
*/
public static class ConfigBuilder {
public static final class ConfigBuilder {
private Logging logging = DEV_NULL_LOGGING;
private boolean logLeakedSessions;
private int maxConnectionPoolSize = PoolSettings.DEFAULT_MAX_CONNECTION_POOL_SIZE;
Expand Down Expand Up @@ -702,7 +702,7 @@ public Config build() {
/**
* Control how the driver determines if it can trust the encryption certificates provided by the Neo4j instance it is connected to.
*/
public static class TrustStrategy implements Serializable {
public static final class TrustStrategy implements Serializable {
@Serial
private static final long serialVersionUID = -1631888096243987740L;

Expand Down
2 changes: 1 addition & 1 deletion driver/src/main/java/org/neo4j/driver/GraphDatabase.java
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@
* @see Driver
* @since 1.0
*/
public class GraphDatabase {
public final class GraphDatabase {
private GraphDatabase() {}

/**
Expand Down
16 changes: 3 additions & 13 deletions driver/src/main/java/org/neo4j/driver/Records.java
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@
* @see Result#list()
* @since 1.0
*/
public abstract class Records {
public final class Records {
private Records() {}

public static Function<Record, Value> column(int index) {
Expand All @@ -38,20 +38,10 @@ public static Function<Record, Value> column(String key) {
}

public static <T> Function<Record, T> column(final int index, final Function<Value, T> mapFunction) {
return new Function<Record, T>() {
@Override
public T apply(Record record) {
return mapFunction.apply(record.get(index));
}
};
return record -> mapFunction.apply(record.get(index));
}

public static <T> Function<Record, T> column(final String key, final Function<Value, T> mapFunction) {
return new Function<Record, T>() {
@Override
public T apply(Record recordAccessor) {
return mapFunction.apply(recordAccessor.get(key));
}
};
return recordAccessor -> mapFunction.apply(recordAccessor.get(key));
}
}
4 changes: 2 additions & 2 deletions driver/src/main/java/org/neo4j/driver/SessionConfig.java
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@
/**
* The session configurations used to configure a session.
*/
public class SessionConfig implements Serializable {
public final class SessionConfig implements Serializable {
@Serial
private static final long serialVersionUID = 5773462156979050657L;

Expand Down Expand Up @@ -173,7 +173,7 @@ public String toString() {
/**
* Builder used to configure {@link SessionConfig} which will be used to create a session.
*/
public static class Builder {
public static final class Builder {
private Long fetchSize = null;
private Iterable<Bookmark> bookmarks = null;
private AccessMode defaultAccessMode = AccessMode.WRITE;
Expand Down
4 changes: 2 additions & 2 deletions driver/src/main/java/org/neo4j/driver/TransactionConfig.java
Original file line number Diff line number Diff line change
Expand Up @@ -63,7 +63,7 @@
*
* @see Session
*/
public class TransactionConfig implements Serializable {
public final class TransactionConfig implements Serializable {
@Serial
private static final long serialVersionUID = -7954949878657177280L;

Expand Down Expand Up @@ -160,7 +160,7 @@ public String toString() {
/**
* Builder used to construct {@link TransactionConfig transaction configuration} objects.
*/
public static class Builder {
public static final class Builder {
private Duration timeout;
private Map<String, Object> metadata = emptyMap();

Expand Down
2 changes: 1 addition & 1 deletion driver/src/main/java/org/neo4j/driver/Values.java
Original file line number Diff line number Diff line change
Expand Up @@ -78,7 +78,7 @@
*
* @since 1.0
*/
public abstract class Values {
public final class Values {
public static final Value EmptyMap = value(Collections.emptyMap());
public static final Value NULL = NullValue.NULL;

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -146,8 +146,7 @@ void shouldNotVerifyConnectivity(String uri) {
@Test
void shouldNotCreateDriverMetrics() {
// Given
Config config = mock(Config.class);
when(config.isMetricsEnabled()).thenReturn(false);
Config config = Config.builder().withoutDriverMetrics().build();
// When
MetricsProvider provider = DriverFactory.getOrCreateMetricsProvider(config, Clock.SYSTEM);
// Then
Expand All @@ -157,9 +156,8 @@ void shouldNotCreateDriverMetrics() {
@Test
void shouldCreateDriverMetricsIfMonitoringEnabled() {
// Given
Config config = mock(Config.class);
when(config.isMetricsEnabled()).thenReturn(true);
when(config.logging()).thenReturn(Logging.none());
Config config =
Config.builder().withDriverMetrics().withLogging(Logging.none()).build();
// When
MetricsProvider provider = DriverFactory.getOrCreateMetricsProvider(config, Clock.SYSTEM);
// Then
Expand All @@ -169,10 +167,11 @@ void shouldCreateDriverMetricsIfMonitoringEnabled() {
@Test
void shouldCreateMicrometerDriverMetricsIfMonitoringEnabled() {
// Given
Config config = mock(Config.class);
when(config.isMetricsEnabled()).thenReturn(true);
when(config.metricsAdapter()).thenReturn(MetricsAdapter.MICROMETER);
when(config.logging()).thenReturn(Logging.none());
Config config = Config.builder()
.withDriverMetrics()
.withMetricsAdapter(MetricsAdapter.MICROMETER)
.withLogging(Logging.none())
.build();
// When
MetricsProvider provider = DriverFactory.getOrCreateMetricsProvider(config, Clock.SYSTEM);
// Then
Expand Down