#2318 - Refactor internals - final classes in internal api package

2024-04-21 10:51:47 +00:00 · 2021-08-17 21:03:53 +12:00
parent 7521cb530e
commit d096706685
39 changed files with 41 additions and 120 deletions
@@ -6,7 +6,7 @@ import java.util.List;
 /**
 * The results of bean cache hit.
 */
-public class BeanCacheResult<T> {
+public final class BeanCacheResult<T> {

  private final List<Entry<T>> list = new ArrayList<>();

@@ -27,7 +27,7 @@ public class BeanCacheResult<T> {
  /**
   * Bean and cache key pair.
   */
-  static class Entry<T> {
+  static final class Entry<T> {

    private final T bean;
    private final Object key;
@@ -7,7 +7,7 @@ import java.io.IOException;
 /**
 * Context used to read binary format messages.
 */
-public class BinaryReadContext {
+public final class BinaryReadContext {

  private final DataInputStream in;

@@ -6,10 +6,9 @@ import java.io.IOException;
 /**
 * Context used to write binary message (like RemoteTransactionEvent).
 */
-public class BinaryWriteContext {
+public final class BinaryWriteContext {

  private final DataOutputStream out;
-
  private long counter;

  public BinaryWriteContext(DataOutputStream out) {
@@ -13,35 +13,28 @@ import java.util.Map.Entry;
 * Supports ordered or named parameters.
 * </p>
 */
-public class BindParams implements Serializable {
+public final class BindParams implements Serializable {

  private static final long serialVersionUID = 4541081933302086285L;

  private final List<Param> positionedParameters = new ArrayList<>();
-
  private final Map<String, Param> namedParameters = new LinkedHashMap<>();
-
  /**
   * This is the sql. For named parameters this is the sql after the named
   * parameters have been replaced with question mark place holders and the
   * parameters have been ordered by addNamedParamInOrder().
   */
  private String preparedSql;
-
  /**
   * Bind hash and count used to detect when the bind values have changed such
   * that the generated SQL (with named parameters) needs to be recalculated.
   */
  private String bindHash;
-
  /**
   * Helper to add positioned parameters in order.
   */
  private int addPos;

-  public BindParams() {
-  }
-
  /**
   * Reset positioned parameters (usually due to bind parameter expansion).
   */
@@ -9,7 +9,7 @@ import java.util.List;
 * The equals/hashCode implementation must meet the requirement that the query bind values
 * match for L2 query cache hit (given the query plan hash is already a match).
 */
-public class BindValuesKey {
+public final class BindValuesKey {

  private final List<Object> values = new ArrayList<>();

@@ -11,10 +11,9 @@ import java.util.Set;
 /**
 * Used for bean cache lookup with where ids in expression.
 */
-public class CacheIdLookupMany<T> implements CacheIdLookup<T> {
+public final class CacheIdLookupMany<T> implements CacheIdLookup<T> {

  private final IdInExpression idInExpression;
-
  private int remaining;

  public CacheIdLookupMany(IdInExpression idInExpression) {
@@ -7,7 +7,7 @@ import java.util.List;
 /**
 * Used for bean cache lookup with a single id value.
 */
-public class CacheIdLookupSingle<T> implements CacheIdLookup<T> {
+public final class CacheIdLookupSingle<T> implements CacheIdLookup<T> {

  private final Object idValue;
  private boolean found;
@@ -6,7 +6,7 @@ import io.ebean.annotation.Platform;
 * Helper to indicate that an EbeanServer should come up offline
 * typically for DDL generation purposes.
 */
-public class DbOffline {
+public final class DbOffline {

  private static final String KEY = "ebean.dboffline";

@@ -8,7 +8,7 @@ import io.ebean.metric.TimedMetric;
 /**
 * Extra metrics collected to measure internal behaviour.
 */
-public class ExtraMetrics {
+public final class ExtraMetrics {

  private final TimedMetric bindCapture;
  private final TimedMetric planCollect;
@@ -3,7 +3,7 @@ package io.ebeaninternal.api;
 /**
 * A hash key for a query including both the query plan and bind values.
 */
-public class HashQuery {
+public final class HashQuery {

  private final CQueryPlanKey planHash;
  private final BindValuesKey bindValuesKey;
@@ -6,7 +6,7 @@ import io.ebean.TxScope;
 /**
 * Helper object to make AOP generated code simpler.
 */
-public class HelpScopeTrans {
+public final class HelpScopeTrans {
  private static boolean enabled = true;

  /**
@@ -13,16 +13,12 @@ import java.util.Set;
 /**
 * Request for loading ManyToOne and OneToOne relationships.
 */
-public class LoadBeanRequest extends LoadRequest {
+public final class LoadBeanRequest extends LoadRequest {

  private final List<EntityBeanIntercept> batch;
-
  private final LoadBeanBuffer loadBuffer;
-
  private final String lazyLoadProperty;
-
  private final boolean loadCache;
-
  private boolean loadedFromCache;

  /**
@@ -15,16 +15,13 @@ import java.util.List;
 /**
 * Request for loading Associated Many Beans.
 */
-public class LoadManyRequest extends LoadRequest {
+public final class LoadManyRequest extends LoadRequest {

  private static final Logger logger = LoggerFactory.getLogger(LoadManyRequest.class);

  private final List<BeanCollection<?>> batch;
-
  private final LoadManyBuffer loadContext;
-
  private final boolean onlyIds;
-
  private final boolean loadCache;

  /**
@@ -17,16 +17,13 @@ import java.util.TreeSet;
 * Holds the joins needs to support the many where predicates.
 * These joins are independent of any 'fetch' joins on the many.
 */
-public class ManyWhereJoins implements Serializable {
+public final class ManyWhereJoins implements Serializable {

  private static final long serialVersionUID = -6490181101871795417L;

  private final TreeMap<String, PropertyJoin> joins = new TreeMap<>();
-
  private List<String> formulaJoinProperties;
-
  private boolean aggregation;
-
  /**
   * 'Mode' indicating that joins added while this is true are required to be outer joins.
   */
@@ -1,12 +0,0 @@
-package io.ebeaninternal.api;
-
-import java.io.Serializable;
-
-/**
- * Object used as a synchronization monitor that is serializable.
- */
-public class Monitor implements Serializable {
-
-  private static final long serialVersionUID = -2741687226680981940L;
-
-}
@@ -11,7 +11,7 @@ import java.util.Map;
 /**
 * Natural key entry with name value pairs for each of the properties making up the key.
 */
-class NaturalKeyEntryBasic implements NaturalKeyEntry {
+final class NaturalKeyEntryBasic implements NaturalKeyEntry {

  private final Map<String,Object> map = new HashMap<>();
  private final String key;
@@ -1,6 +1,6 @@
 package io.ebeaninternal.api;

-class NaturalKeyEntrySimple implements NaturalKeyEntry {
+final class NaturalKeyEntrySimple implements NaturalKeyEntry {

  private final String key;
  private final Object val;
@@ -3,7 +3,7 @@ package io.ebeaninternal.api;
 /**
 * A property value pair in a natural key lookup.
 */
-public class NaturalKeyEq {
+public final class NaturalKeyEq {

  final String property;
  final Object value;
@@ -11,28 +11,22 @@ import java.util.Set;
 /**
 * Collects the data for processing the natural key cache processing.
 */
-public class NaturalKeyQueryData<T> {
+public final class NaturalKeyQueryData<T> {

  private final BeanNaturalKey naturalKey;
-
  /**
   * Only one of IN or IN PAIRS is allowed.
   */
  private boolean hasIn;
-
  // IN Pairs clause - only one allowed
  private String inProperty0, inProperty1;
  private List<Pairs.Entry> inPairs;
-
  // IN clause - only one allowed
  private List<Object> inValues;
  private String inProperty;
-
  // normal EQ expressions
  private List<NaturalKeyEq> eqList;
-
  private NaturalKeySet set;
-
  private int hitCount;

  public NaturalKeyQueryData(BeanNaturalKey naturalKey) {
@@ -4,8 +4,7 @@ import java.util.LinkedHashMap;
 import java.util.Map;
 import java.util.Set;

-public class NaturalKeySet {
-
+public final class NaturalKeySet {

  private final Map<Object, NaturalKeyEntry> map = new LinkedHashMap<>();

@@ -2,7 +2,7 @@ package io.ebeaninternal.api;

 import io.ebeaninternal.server.type.bindcapture.BindCapture;

-class NoopQueryBindCapture implements SpiQueryBindCapture {
+final class NoopQueryBindCapture implements SpiQueryBindCapture {

  @Override
  public boolean collectFor(long timeMicros) {
@@ -6,7 +6,7 @@ import io.ebean.meta.QueryPlanRequest;
 import java.util.Collections;
 import java.util.List;

-class NoopQueryPlanManager implements QueryPlanManager {
+final class NoopQueryPlanManager implements QueryPlanManager {

  @Override
  public void setDefaultThreshold(long thresholdMicros) {
@@ -3,7 +3,7 @@ package io.ebeaninternal.api;
 import io.ebean.annotation.Platform;
 import io.ebean.util.StringHelper;

-public class PlatformMatch {
+public final class PlatformMatch {

  /**
   * Return true if the script platforms is a match/supported for the given platform.
@@ -15,7 +15,6 @@ public class PlatformMatch {
    if (platforms == null || platforms.trim().isEmpty()) {
      return true;
    }
-
    // match on base platform name and platform name
    for (String name : StringHelper.splitNames(platforms)) {
      if (name.equalsIgnoreCase(platform.base().name()) || name.equalsIgnoreCase(platform.name())) {
@@ -5,16 +5,9 @@ import io.ebeaninternal.server.query.SqlJoinType;
 /**
 * Represents a join required for a given property and whether than needs to be an outer join.
 */
-public class PropertyJoin {
+public final class PropertyJoin {

-  /**
-   * The property name.
-   */
  private final String property;
-
-  /**
-   * Set to true if the property needs to be an outer join.
-   */
  private final SqlJoinType joinType;

  public PropertyJoin(String property, SqlJoinType joinType) {
@@ -7,7 +7,7 @@ import java.util.ArrayList;
 /**
 * Used internally to handle the scoping of transactions for methods.
 */
-public class ScopeTrans {
+public final class ScopeTrans {

  private static final int OPCODE_ATHROW = 191;

@@ -15,43 +15,32 @@ public class ScopeTrans {
   * The transaction in scope (can be null).
   */
  private final SpiTransaction transaction;
-
  /**
   * If true by default rollback on Checked exceptions.
   */
  private final boolean rollbackOnChecked;
-
  /**
   * True if the transaction was created and hence should be committed
   * on finally if it hasn't already been rolled back.
   */
  private final boolean created;
-
  /**
   * Explicit set of Exceptions that DO NOT cause a rollback to occur.
   */
  private final ArrayList<Class<? extends Throwable>> noRollbackFor;
-
  /**
   * Explicit set of Exceptions that DO cause a rollback to occur.
   */
  private final ArrayList<Class<? extends Throwable>> rollbackFor;
-
  private Boolean restoreBatch;
-
  private Boolean restoreBatchOnCascade;
-
  private int restoreBatchSize;
-
  private Boolean restoreBatchGeneratedKeys;
-
  private boolean restoreBatchFlushOnQuery;
-
  /**
   * Flag set when a rollback has occurred.
   */
  private boolean rolledBack;
-
  /**
   * Flag set when nested commit has occurred.
   */
@@ -10,15 +10,13 @@ import javax.persistence.PersistenceException;
 *
 * These can be nested and internally they are pushed and popped from a stack.
 */
-public class ScopedTransaction extends SpiTransactionProxy {
+public final class ScopedTransaction extends SpiTransactionProxy {

  private final TransactionScopeManager manager;
-
  /**
   * Stack of 'nested' transactions.
   */
  private final ArrayStack<ScopeTrans> stack = new ArrayStack<>();
-
  private ScopeTrans current;

  /**
@@ -8,10 +8,9 @@ import java.util.Set;
 /**
 * Property expression validation request for a given root bean type.
 */
-public class SpiExpressionValidation {
+public final class SpiExpressionValidation {

  private final BeanType<?> desc;
-
  private final LinkedHashSet<String> unknown = new LinkedHashSet<>();

  public SpiExpressionValidation(BeanType<?> desc) {
@@ -20,7 +20,7 @@ import java.util.List;
 * to the TransactionEventManager.
 * </p>
 */
-public class TransactionEvent implements Serializable {
+public final class TransactionEvent implements Serializable {

  private static final long serialVersionUID = 7230903304106097120L;

@@ -29,13 +29,9 @@ public class TransactionEvent implements Serializable {
   * the cluster).
   */
  private final transient boolean local;
-
  private TransactionEventTable eventTables;
-
  private transient List<PersistRequestBean<?>> listenerNotify;
-
  private transient DeleteByIdMap deleteByIdMap;
-
  private transient CacheChangeSet changeSet;

  /**
@@ -110,11 +106,9 @@ public class TransactionEvent implements Serializable {
   * Build and return the cache changeSet.
   */
  public CacheChangeSet buildCacheChanges(TransactionManager manager) {
-
    if (changeSet == null && deleteByIdMap == null && eventTables == null) {
      return null;
    }
-
    if (changeSet == null) {
      changeSet = new CacheChangeSet();
    }
@@ -28,20 +28,17 @@ public final class TransactionEventTable implements Serializable, BinaryWritable
  }

  public void add(TransactionEventTable table) {
-
    for (TableIUD iud : table.values()) {
      add(iud);
    }
  }

  public void add(String table, boolean insert, boolean update, boolean delete) {
-
    table = table.toUpperCase();
    add(new TableIUD(table, insert, update, delete));
  }

  public void add(TableIUD newTableIUD) {
-
    TableIUD existingTableIUD = map.put(newTableIUD.getTableName(), newTableIUD);
    if (existingTableIUD != null) {
      newTableIUD.add(existingTableIUD);
@@ -56,7 +53,7 @@ public final class TransactionEventTable implements Serializable, BinaryWritable
    return map.values();
  }

-  public static class TableIUD implements Serializable, BulkTableEvent, BinaryWritable {
+  public static final class TableIUD implements Serializable, BulkTableEvent, BinaryWritable {

    private static final long serialVersionUID = -1958317571064162089L;

@@ -73,12 +70,10 @@ public final class TransactionEventTable implements Serializable, BinaryWritable
    }

    public static TableIUD readBinaryMessage(BinaryReadContext dataInput) throws IOException {
-
      String table = dataInput.readUTF();
      boolean insert = dataInput.readBoolean();
      boolean update = dataInput.readBoolean();
      boolean delete = dataInput.readBoolean();
-
      return new TableIUD(table, insert, update, delete);
    }

@@ -17,7 +17,7 @@ import java.util.Set;
 /**
 * Utility that converts between JSON content and simple java Maps/Lists.
 */
-public class DJsonService implements SpiJsonService {
+public final class DJsonService implements SpiJsonService {

  /**
   * Write the nested Map/List as json.
@@ -14,7 +14,7 @@ import java.util.List;
 import java.util.Map;
 import java.util.NoSuchElementException;

-class EJsonReader {
+final class EJsonReader {

  static final JsonFactory json = new JsonFactory();

@@ -14,7 +14,7 @@ import java.util.Map;
 import java.util.Map.Entry;
 import java.util.Set;

-class EJsonWriter {
+final class EJsonWriter {

  /**
   * Base jsonFactory implementation used when it is not passed in.
@@ -7,7 +7,7 @@ import java.io.Serializable;
 /**
 * Detects when content has been modified and as such needs to be persisted (included in an update).
 */
-public class ModifyAwareFlag implements ModifyAwareType, Serializable {
+public final class ModifyAwareFlag implements ModifyAwareType, Serializable {

  private static final long serialVersionUID = 1;

@@ -7,10 +7,9 @@ import java.util.Iterator;
 /**
 * Wraps an iterator for the purposes of detecting modifications.
 */
-public class ModifyAwareIterator<E> implements Iterator<E> {
+public final class ModifyAwareIterator<E> implements Iterator<E> {

  private final ModifyAwareType owner;
-
  private final Iterator<E> it;

  /**
@@ -13,12 +13,11 @@ import java.util.Objects;
 /**
 * Modify aware wrapper of a list.
 */
-public class ModifyAwareList<E> implements List<E>, ModifyAwareType, Serializable {
+public final class ModifyAwareList<E> implements List<E>, ModifyAwareType, Serializable {

  private static final long serialVersionUID = 1;

  final List<E> list;
-
  final ModifyAwareType owner;

  public ModifyAwareList(List<E> list) {
@@ -7,10 +7,9 @@ import java.util.ListIterator;
 /**
 * Modify aware wrapper of a ListIterator.
 */
-public class ModifyAwareListIterator<E> implements ListIterator<E> {
+public final class ModifyAwareListIterator<E> implements ListIterator<E> {

  final ModifyAwareType owner;
-
  final ListIterator<E> iterator;

  public ModifyAwareListIterator(ModifyAwareType owner, ListIterator<E> iterator) {
@@ -12,15 +12,11 @@ import java.util.Set;
 /**
 * Map that is wraps an underlying map for the purpose of detecting changes.
 */
-public class ModifyAwareMap<K, V> implements Map<K, V>, ModifyAwareType, Serializable {
+public final class ModifyAwareMap<K, V> implements Map<K, V>, ModifyAwareType, Serializable {

  private static final long serialVersionUID = 1;

  final ModifyAwareType owner;
-
-  /**
-   * The underlying map.
-   */
  final Map<K, V> map;

  public ModifyAwareMap(Map<K, V> underlying) {
@@ -11,13 +11,12 @@ import java.util.Set;
 /**
 * Wraps a Set for the purposes of detecting modifications.
 */
-public class ModifyAwareSet<E> implements Set<E>, ModifyAwareType, Serializable {
+public final class ModifyAwareSet<E> implements Set<E>, ModifyAwareType, Serializable {

  private static final long serialVersionUID = 1;

-  protected final ModifyAwareType owner;
-
-  protected final Set<E> set;
+  private final ModifyAwareType owner;
+  private final Set<E> set;

  /**
   * Create as top level with it's own ModifyAwareOwner instance wrapping the given Set.
@@ -5,7 +5,7 @@ import io.ebeaninternal.api.SpiQuery;
 /**
 * Noop service when AutoTuneService is not available.
 */
-public class NoAutoTuneService implements AutoTuneService {
+public final class NoAutoTuneService implements AutoTuneService {

  @Override
  public void startup() {