From 7ce85fe5f2fb0ff2b9f4789489588347238f7c69 Mon Sep 17 00:00:00 2001 From: Rob Bygrave Date: Sat, 27 Aug 2022 20:09:27 +1200 Subject: [PATCH] Refactor method names SpiJsonReader and DocStore types --- .../ebeaninternal/api/json/SpiJsonReader.java | 8 +-- .../ebeaninternal/api/json/SpiJsonWriter.java | 2 +- .../server/deploy/BeanDescriptor.java | 6 +- .../BeanDescriptorElementEmbeddedMap.java | 2 +- .../deploy/BeanDescriptorElementScalar.java | 2 +- .../BeanDescriptorElementScalarMap.java | 2 +- .../server/deploy/BeanDescriptorJsonHelp.java | 6 +- .../server/deploy/BeanProperty.java | 6 +- .../server/deploy/BeanPropertyAssoc.java | 2 +- .../server/deploy/BeanPropertyAssocMany.java | 2 +- .../deploy/BeanPropertyAssocManyJsonHelp.java | 4 +- .../BeanPropertyAssocManyJsonTransient.java | 6 +- .../server/deploy/BeanPropertyAssocOne.java | 4 +- .../deploy/DeployDocPropertyOptions.java | 10 +-- .../server/json/DJsonBeanReader.java | 2 +- .../ebeaninternal/server/json/ReadJson.java | 10 +-- .../ebeaninternal/server/json/WriteJson.java | 2 +- .../docstore/api/DocStoreBeanAdapter.java | 6 +- .../docstore/api/DocStoreUpdates.java | 10 +-- .../api/mapping/DocMappingBuilder.java | 25 +++---- .../api/mapping/DocPropertyAdapter.java | 4 +- .../api/mapping/DocPropertyMapping.java | 20 +++--- .../api/mapping/DocPropertyOptions.java | 70 ++++++++----------- .../docstore/api/mapping/DocumentMapping.java | 26 +++---- .../api/support/DocStoreBeanBaseAdapter.java | 28 ++++---- .../api/support/DocStoreDeleteEvent.java | 3 +- .../support/DocStoreEmbeddedInvalidation.java | 1 - .../api/support/DocStoreIndexEvent.java | 4 +- .../docstore/api/support/DocStructure.java | 7 +- .../none/NoneDocStoreBeanAdapter.java | 2 +- .../BeanDescriptor_documentMappingTest.java | 10 +-- .../docstore/DocStoreBeanBaseAdapterTest.java | 2 +- .../docstore/DocStoreDeleteEventTest.java | 2 +- .../docstore/DocStoreIndexEventTest.java | 2 +- 34 files changed, 130 insertions(+), 168 deletions(-) diff --git a/ebean-core/src/main/java/io/ebeaninternal/api/json/SpiJsonReader.java b/ebean-core/src/main/java/io/ebeaninternal/api/json/SpiJsonReader.java index 8082e049a..1aaaf12fe 100644 --- a/ebean-core/src/main/java/io/ebeaninternal/api/json/SpiJsonReader.java +++ b/ebean-core/src/main/java/io/ebeaninternal/api/json/SpiJsonReader.java @@ -12,7 +12,7 @@ import java.util.Map; public interface SpiJsonReader { - PersistenceContext getPersistenceContext(); + PersistenceContext persistenceContext(); SpiJsonReader forJson(JsonParser moreJson); @@ -20,9 +20,9 @@ public interface SpiJsonReader { Object persistenceContextPutIfAbsent(Object id, EntityBean bean, BeanDescriptor beanDesc); - ObjectMapper getObjectMapper(); + ObjectMapper mapper(); - JsonParser getParser(); + JsonParser parser(); JsonToken nextToken() throws IOException; @@ -34,5 +34,5 @@ public interface SpiJsonReader { Object readValueUsingObjectMapper(Class propertyType) throws IOException; - boolean isIntercept(); + boolean intercept(); } diff --git a/ebean-core/src/main/java/io/ebeaninternal/api/json/SpiJsonWriter.java b/ebean-core/src/main/java/io/ebeaninternal/api/json/SpiJsonWriter.java index 4d80bc4f7..f6069b82c 100644 --- a/ebean-core/src/main/java/io/ebeaninternal/api/json/SpiJsonWriter.java +++ b/ebean-core/src/main/java/io/ebeaninternal/api/json/SpiJsonWriter.java @@ -20,7 +20,7 @@ public interface SpiJsonWriter extends JsonWriter { /** * Return true if the value is a parent bean. */ - boolean isParentBean(Object value); + boolean parentBean(Object value); /** * Start an assoc one path. diff --git a/ebean-core/src/main/java/io/ebeaninternal/server/deploy/BeanDescriptor.java b/ebean-core/src/main/java/io/ebeaninternal/server/deploy/BeanDescriptor.java index 1f01cbcfb..5a3b1236b 100644 --- a/ebean-core/src/main/java/io/ebeaninternal/server/deploy/BeanDescriptor.java +++ b/ebean-core/src/main/java/io/ebeaninternal/server/deploy/BeanDescriptor.java @@ -323,7 +323,7 @@ public class BeanDescriptor implements BeanType, STreeType, SpiBeanType { this.jsonHelp = initJsonHelp(); this.draftHelp = new BeanDescriptorDraftHelp<>(this); this.docStoreAdapter = owner.createDocStoreBeanAdapter(this, deploy); - this.docStoreQueueId = docStoreAdapter.getQueueId(); + this.docStoreQueueId = docStoreAdapter.queueId(); // Check if there are no cascade save associated beans ( subject to change // in initialiseOther()). Note that if we are in an inheritance hierarchy // then we also need to check every BeanDescriptors in the InheritInfo as @@ -966,7 +966,7 @@ public class BeanDescriptor implements BeanType, STreeType, SpiBeanType { */ @Override public boolean isDocStoreMapped() { - return docStoreAdapter.isMapped(); + return docStoreAdapter.mapped(); } /** @@ -1072,7 +1072,7 @@ public class BeanDescriptor implements BeanType, STreeType, SpiBeanType { * given the transactions requested mode. */ public DocStoreMode docStoreMode(PersistRequest.Type persistType, DocStoreMode txnMode) { - return docStoreAdapter.getMode(persistType, txnMode); + return docStoreAdapter.mode(persistType, txnMode); } public void docStoreInsert(Object idValue, PersistRequestBean persistRequest, DocStoreUpdateContext bulkUpdate) throws IOException { diff --git a/ebean-core/src/main/java/io/ebeaninternal/server/deploy/BeanDescriptorElementEmbeddedMap.java b/ebean-core/src/main/java/io/ebeaninternal/server/deploy/BeanDescriptorElementEmbeddedMap.java index e6518ad50..ecb283e5c 100644 --- a/ebean-core/src/main/java/io/ebeaninternal/server/deploy/BeanDescriptorElementEmbeddedMap.java +++ b/ebean-core/src/main/java/io/ebeaninternal/server/deploy/BeanDescriptorElementEmbeddedMap.java @@ -49,7 +49,7 @@ class BeanDescriptorElementEmbeddedMap extends BeanDescriptorElementEmbedded< @Override public Object jsonReadCollection(SpiJsonReader readJson, EntityBean parentBean) throws IOException { - JsonParser parser = readJson.getParser(); + JsonParser parser = readJson.parser(); ElementCollector add = elementHelp.createCollector(); do { String fieldName = parser.nextFieldName(); diff --git a/ebean-core/src/main/java/io/ebeaninternal/server/deploy/BeanDescriptorElementScalar.java b/ebean-core/src/main/java/io/ebeaninternal/server/deploy/BeanDescriptorElementScalar.java index 13833eb77..0242c993f 100644 --- a/ebean-core/src/main/java/io/ebeaninternal/server/deploy/BeanDescriptorElementScalar.java +++ b/ebean-core/src/main/java/io/ebeaninternal/server/deploy/BeanDescriptorElementScalar.java @@ -40,7 +40,7 @@ class BeanDescriptorElementScalar extends BeanDescriptorElement { @Override public Object jsonReadCollection(SpiJsonReader readJson, EntityBean parentBean) throws IOException { - JsonParser parser = readJson.getParser(); + JsonParser parser = readJson.parser(); ElementCollector add = elementHelp.createCollector(); do { JsonToken token = parser.nextToken(); diff --git a/ebean-core/src/main/java/io/ebeaninternal/server/deploy/BeanDescriptorElementScalarMap.java b/ebean-core/src/main/java/io/ebeaninternal/server/deploy/BeanDescriptorElementScalarMap.java index a3da1779e..d5b8d91a9 100644 --- a/ebean-core/src/main/java/io/ebeaninternal/server/deploy/BeanDescriptorElementScalarMap.java +++ b/ebean-core/src/main/java/io/ebeaninternal/server/deploy/BeanDescriptorElementScalarMap.java @@ -49,7 +49,7 @@ class BeanDescriptorElementScalarMap extends BeanDescriptorElement { @Override public Object jsonReadCollection(SpiJsonReader readJson, EntityBean parentBean) throws IOException { - JsonParser parser = readJson.getParser(); + JsonParser parser = readJson.parser(); ElementCollector add = elementHelp.createCollector(); do { String fieldName = parser.nextFieldName(); diff --git a/ebean-core/src/main/java/io/ebeaninternal/server/deploy/BeanDescriptorJsonHelp.java b/ebean-core/src/main/java/io/ebeaninternal/server/deploy/BeanDescriptorJsonHelp.java index f20db7315..0e323114b 100644 --- a/ebean-core/src/main/java/io/ebeaninternal/server/deploy/BeanDescriptorJsonHelp.java +++ b/ebean-core/src/main/java/io/ebeaninternal/server/deploy/BeanDescriptorJsonHelp.java @@ -66,7 +66,7 @@ final class BeanDescriptorJsonHelp { @SuppressWarnings("unchecked") T jsonRead(SpiJsonReader jsonRead, String path, boolean withInheritance, T target) throws IOException { - JsonParser parser = jsonRead.getParser(); + JsonParser parser = jsonRead.parser(); //noinspection StatementWithEmptyBody if (parser.getCurrentToken() == JsonToken.START_OBJECT) { // start object token read by Jackson already @@ -85,7 +85,7 @@ final class BeanDescriptorJsonHelp { return jsonReadObject(jsonRead, path, target); } - ObjectNode node = jsonRead.getObjectMapper().readTree(parser); + ObjectNode node = jsonRead.mapper().readTree(parser); if (node.isNull()) { return null; } @@ -127,7 +127,7 @@ final class BeanDescriptorJsonHelp { // unmapped properties, send to JsonReadBeanVisitor later Map unmappedProperties = null; do { - JsonParser parser = readJson.getParser(); + JsonParser parser = readJson.parser(); JsonToken event = parser.nextToken(); if (JsonToken.FIELD_NAME == event) { String key = parser.getCurrentName(); diff --git a/ebean-core/src/main/java/io/ebeaninternal/server/deploy/BeanProperty.java b/ebean-core/src/main/java/io/ebeaninternal/server/deploy/BeanProperty.java index 91e1a0ffa..99765ff5e 100644 --- a/ebean-core/src/main/java/io/ebeaninternal/server/deploy/BeanProperty.java +++ b/ebean-core/src/main/java/io/ebeaninternal/server/deploy/BeanProperty.java @@ -1407,7 +1407,7 @@ public class BeanProperty implements ElPropertyValue, Property, STreeProperty { JsonToken event = ctx.nextToken(); if (JsonToken.VALUE_NULL == event) { if (jsonDeserialize) { - if (ctx.isIntercept()) { + if (ctx.intercept()) { setValueIntercept(bean, null); } else { setValue(bean, null); @@ -1417,7 +1417,7 @@ public class BeanProperty implements ElPropertyValue, Property, STreeProperty { // expect to read non-null json value Object objValue; if (scalarType != null) { - objValue = scalarType.jsonRead(ctx.getParser()); + objValue = scalarType.jsonRead(ctx.parser()); } else { try { objValue = ctx.readValueUsingObjectMapper(propertyType); @@ -1430,7 +1430,7 @@ public class BeanProperty implements ElPropertyValue, Property, STreeProperty { } } if (jsonDeserialize) { - if (ctx.isIntercept()) { + if (ctx.intercept()) { setValueIntercept(bean, objValue); } else { setValue(bean, objValue); diff --git a/ebean-core/src/main/java/io/ebeaninternal/server/deploy/BeanPropertyAssoc.java b/ebean-core/src/main/java/io/ebeaninternal/server/deploy/BeanPropertyAssoc.java index 78d1c2179..4d306564c 100644 --- a/ebean-core/src/main/java/io/ebeaninternal/server/deploy/BeanPropertyAssoc.java +++ b/ebean-core/src/main/java/io/ebeaninternal/server/deploy/BeanPropertyAssoc.java @@ -355,7 +355,7 @@ public abstract class BeanPropertyAssoc extends BeanProperty implements STree mapping.push(nested); targetDescriptor.docStoreMapping(mapping, fullName); mapping.pop(); - if (!nested.getChildren().isEmpty()) { + if (!nested.children().isEmpty()) { mapping.add(nested); } } diff --git a/ebean-core/src/main/java/io/ebeaninternal/server/deploy/BeanPropertyAssocMany.java b/ebean-core/src/main/java/io/ebeaninternal/server/deploy/BeanPropertyAssocMany.java index 78263cf82..feec8f8ce 100644 --- a/ebean-core/src/main/java/io/ebeaninternal/server/deploy/BeanPropertyAssocMany.java +++ b/ebean-core/src/main/java/io/ebeaninternal/server/deploy/BeanPropertyAssocMany.java @@ -998,7 +998,7 @@ public class BeanPropertyAssocMany extends BeanPropertyAssoc implements ST */ private Object jsonReadCollection(String json) throws IOException { SpiJsonReader ctx = descriptor.createJsonReader(json); - JsonParser parser = ctx.getParser(); + JsonParser parser = ctx.parser(); JsonToken event = parser.nextToken(); if (JsonToken.VALUE_NULL == event) { return null; diff --git a/ebean-core/src/main/java/io/ebeaninternal/server/deploy/BeanPropertyAssocManyJsonHelp.java b/ebean-core/src/main/java/io/ebeaninternal/server/deploy/BeanPropertyAssocManyJsonHelp.java index ba06352b7..f09bc4dc6 100644 --- a/ebean-core/src/main/java/io/ebeaninternal/server/deploy/BeanPropertyAssocManyJsonHelp.java +++ b/ebean-core/src/main/java/io/ebeaninternal/server/deploy/BeanPropertyAssocManyJsonHelp.java @@ -38,7 +38,7 @@ class BeanPropertyAssocManyJsonHelp { if (!this.many.jsonDeserialize) { return; } - JsonParser parser = readJson.getParser(); + JsonParser parser = readJson.parser(); JsonToken event = parser.nextToken(); if (JsonToken.VALUE_NULL == event) { return; @@ -50,7 +50,7 @@ class BeanPropertyAssocManyJsonHelp { if (JsonToken.START_ARRAY != event && JsonToken.START_OBJECT != event) { throw new JsonParseException(parser, "Unexpected token " + event + " - expecting start array or object"); } - if (readJson.isIntercept()) { + if (readJson.intercept()) { many.setValueIntercept(parentBean, many.jsonReadCollection(readJson, parentBean)); } else { many.setValue(parentBean, many.jsonReadCollection(readJson, parentBean)); diff --git a/ebean-core/src/main/java/io/ebeaninternal/server/deploy/BeanPropertyAssocManyJsonTransient.java b/ebean-core/src/main/java/io/ebeaninternal/server/deploy/BeanPropertyAssocManyJsonTransient.java index 32a84d584..ae82bd7c6 100644 --- a/ebean-core/src/main/java/io/ebeaninternal/server/deploy/BeanPropertyAssocManyJsonTransient.java +++ b/ebean-core/src/main/java/io/ebeaninternal/server/deploy/BeanPropertyAssocManyJsonTransient.java @@ -20,7 +20,7 @@ class BeanPropertyAssocManyJsonTransient { * Use Jackson ObjectMapper to read the transient 'many' property. */ void jsonReadUsingObjectMapper(BeanPropertyAssocMany many, SpiJsonReader readJson, EntityBean parentBean) throws IOException { - ObjectMapper mapper = readJson.getObjectMapper(); + ObjectMapper mapper = readJson.mapper(); ManyType manyType = many.manyType(); Object value; @@ -29,11 +29,11 @@ class BeanPropertyAssocManyJsonTransient { TypeFactory typeFactory = mapper.getTypeFactory(); JavaType target = typeFactory.constructType(many.targetType()); MapType jacksonType = typeFactory.constructMapType(LinkedHashMap.class, TypeFactory.unknownType(), target); - value = mapper.readValue(readJson.getParser(), jacksonType); + value = mapper.readValue(readJson.parser(), jacksonType); } else { // read list or set using Jackson object mapper CollectionType jacksonType = mapper.getTypeFactory().constructCollectionType(manyType.getCollectionType(), many.targetType()); - value = mapper.readValue(readJson.getParser(), jacksonType); + value = mapper.readValue(readJson.parser(), jacksonType); } many.setValue(parentBean, value); } diff --git a/ebean-core/src/main/java/io/ebeaninternal/server/deploy/BeanPropertyAssocOne.java b/ebean-core/src/main/java/io/ebeaninternal/server/deploy/BeanPropertyAssocOne.java index 37937f194..54eeae122 100644 --- a/ebean-core/src/main/java/io/ebeaninternal/server/deploy/BeanPropertyAssocOne.java +++ b/ebean-core/src/main/java/io/ebeaninternal/server/deploy/BeanPropertyAssocOne.java @@ -768,7 +768,7 @@ public class BeanPropertyAssocOne extends BeanPropertyAssoc implements STr if (value == null) { writeJson.writeNullField(name); } else { - if (!writeJson.isParentBean(value)) { + if (!writeJson.parentBean(value)) { // Hmmm, not writing complex non-entity bean if (value instanceof EntityBean) { writeJson.beginAssocOne(name, bean); @@ -785,7 +785,7 @@ public class BeanPropertyAssocOne extends BeanPropertyAssoc implements STr if (jsonDeserialize && targetDescriptor != null) { T target = (T) value(bean); T assocBean = targetDescriptor.jsonRead(readJson, name, target); - if (readJson.isIntercept()) { + if (readJson.intercept()) { setValueIntercept(bean, assocBean); } else { setValue(bean, assocBean); diff --git a/ebean-core/src/main/java/io/ebeaninternal/server/deploy/DeployDocPropertyOptions.java b/ebean-core/src/main/java/io/ebeaninternal/server/deploy/DeployDocPropertyOptions.java index e6e00b2e9..0ce3a87a5 100644 --- a/ebean-core/src/main/java/io/ebeaninternal/server/deploy/DeployDocPropertyOptions.java +++ b/ebean-core/src/main/java/io/ebeaninternal/server/deploy/DeployDocPropertyOptions.java @@ -33,7 +33,7 @@ public final class DeployDocPropertyOptions { */ public void setDocSortable(DocSortable doc) { createOptions(); - mapping.setSortable(true); + mapping.sortable(true); setStore(doc.store()); setBoost(doc.boost()); setNullValue(doc.nullValue()); @@ -44,7 +44,7 @@ public final class DeployDocPropertyOptions { */ public void setDocCode(DocCode doc) { createOptions(); - mapping.setCode(true); + mapping.code(true); setStore(doc.store()); setBoost(doc.boost()); setNullValue(doc.nullValue()); @@ -52,19 +52,19 @@ public final class DeployDocPropertyOptions { private void setNullValue(String value) { if (!value.isEmpty()) { - mapping.setNullValue(value); + mapping.nullValue(value); } } private void setBoost(float boost) { if (Float.compare(boost, 1.0F) != 0) { - mapping.setBoost(boost); + mapping.boost(boost); } } private void setStore(boolean store) { if (store) { - mapping.setStore(true); + mapping.store(true); } } diff --git a/ebean-core/src/main/java/io/ebeaninternal/server/json/DJsonBeanReader.java b/ebean-core/src/main/java/io/ebeaninternal/server/json/DJsonBeanReader.java index 8ee649981..f1b92a78b 100644 --- a/ebean-core/src/main/java/io/ebeaninternal/server/json/DJsonBeanReader.java +++ b/ebean-core/src/main/java/io/ebeaninternal/server/json/DJsonBeanReader.java @@ -32,7 +32,7 @@ public final class DJsonBeanReader implements JsonBeanReader { @Override public PersistenceContext getPersistenceContext() { - return readJson.getPersistenceContext(); + return readJson.persistenceContext(); } @Override diff --git a/ebean-core/src/main/java/io/ebeaninternal/server/json/ReadJson.java b/ebean-core/src/main/java/io/ebeaninternal/server/json/ReadJson.java index 77f20c185..65db79c08 100644 --- a/ebean-core/src/main/java/io/ebeaninternal/server/json/ReadJson.java +++ b/ebean-core/src/main/java/io/ebeaninternal/server/json/ReadJson.java @@ -86,7 +86,7 @@ public final class ReadJson implements SpiJsonReader { * Return the persistence context being used if any. */ @Override - public PersistenceContext getPersistenceContext() { + public PersistenceContext persistenceContext() { return persistenceContext; } @@ -142,7 +142,7 @@ public final class ReadJson implements SpiJsonReader { * Return the objectMapper used for this request. */ @Override - public ObjectMapper getObjectMapper() { + public ObjectMapper mapper() { if (objectMapper == null) { throw new IllegalStateException( "Jackson ObjectMapper required but has not set. The ObjectMapper can be set on" @@ -155,7 +155,7 @@ public final class ReadJson implements SpiJsonReader { * Return the JsonParser. */ @Override - public JsonParser getParser() { + public JsonParser parser() { return parser; } @@ -209,14 +209,14 @@ public final class ReadJson implements SpiJsonReader { */ @Override public Object readValueUsingObjectMapper(Class propertyType) throws IOException { - return getObjectMapper().readValue(parser, propertyType); + return mapper().readValue(parser, propertyType); } /** * Do we have to set values via intercept or not. */ @Override - public boolean isIntercept() { + public boolean intercept() { return intercept; } } diff --git a/ebean-core/src/main/java/io/ebeaninternal/server/json/WriteJson.java b/ebean-core/src/main/java/io/ebeaninternal/server/json/WriteJson.java index 60b52620f..39e03eb95 100644 --- a/ebean-core/src/main/java/io/ebeaninternal/server/json/WriteJson.java +++ b/ebean-core/src/main/java/io/ebeaninternal/server/json/WriteJson.java @@ -342,7 +342,7 @@ public final class WriteJson implements SpiJsonWriter { } @Override - public boolean isParentBean(Object bean) { + public boolean parentBean(Object bean) { return !parentBeans.isEmpty() && parentBeans.contains(bean); } diff --git a/ebean-core/src/main/java/io/ebeanservice/docstore/api/DocStoreBeanAdapter.java b/ebean-core/src/main/java/io/ebeanservice/docstore/api/DocStoreBeanAdapter.java index c3a8cd6e7..a649dbf8f 100644 --- a/ebean-core/src/main/java/io/ebeanservice/docstore/api/DocStoreBeanAdapter.java +++ b/ebean-core/src/main/java/io/ebeanservice/docstore/api/DocStoreBeanAdapter.java @@ -36,20 +36,20 @@ public interface DocStoreBeanAdapter extends BeanDocType { /** * Return true if this type is mapped for doc storage. */ - boolean isMapped(); + boolean mapped(); /** * Return the unique queueId for this bean type. This is expected to be a relatively short unique * string (rather than a fully qualified class name). */ - String getQueueId(); + String queueId(); /** * Determine and return how this persist type will be processed given the transaction mode. *

* Some transactions (like bulk updates) might specifically turn off indexing for example. */ - DocStoreMode getMode(PersistRequest.Type persistType, DocStoreMode txnMode); + DocStoreMode mode(PersistRequest.Type persistType, DocStoreMode txnMode); /** * Return the index type for this bean type. diff --git a/ebean-core/src/main/java/io/ebeanservice/docstore/api/DocStoreUpdates.java b/ebean-core/src/main/java/io/ebeanservice/docstore/api/DocStoreUpdates.java index 9f2fff8d5..5f8219077 100644 --- a/ebean-core/src/main/java/io/ebeanservice/docstore/api/DocStoreUpdates.java +++ b/ebean-core/src/main/java/io/ebeanservice/docstore/api/DocStoreUpdates.java @@ -10,7 +10,7 @@ import java.util.List; * Collection of document store updates that are either sent to the document store * or queued for future processing */ -public class DocStoreUpdates { +public final class DocStoreUpdates { /** * Persist inserts and updates. @@ -87,28 +87,28 @@ public class DocStoreUpdates { /** * Return the persist insert and update requests to be sent to the document store. */ - public List getPersistEvents() { + public List persistEvents() { return persistEvents; } /** * Return delete events. */ - public List getDeleteEvents() { + public List deleteEvents() { return deleteEvents; } /** * Return the list of nested update events. */ - public List getNestedEvents() { + public List nestedEvents() { return nestedEvents; } /** * Return the entries for sending to the queue. */ - public List getQueueEntries() { + public List queueEntries() { return queueEntries; } diff --git a/ebean-core/src/main/java/io/ebeanservice/docstore/api/mapping/DocMappingBuilder.java b/ebean-core/src/main/java/io/ebeanservice/docstore/api/mapping/DocMappingBuilder.java index dc433105d..c00de4be1 100644 --- a/ebean-core/src/main/java/io/ebeanservice/docstore/api/mapping/DocMappingBuilder.java +++ b/ebean-core/src/main/java/io/ebeanservice/docstore/api/mapping/DocMappingBuilder.java @@ -12,14 +12,11 @@ import java.util.Stack; /** * Builds the DocumentMapping for a given bean type. */ -public class DocMappingBuilder { +public final class DocMappingBuilder { private final PathProperties paths; - private final DocStore docStore; - private final Stack properties = new Stack<>(); - private final Map map = new LinkedHashMap<>(); /** @@ -49,12 +46,11 @@ public class DocMappingBuilder { * Add the property mapping. */ public void add(DocPropertyMapping docMapping) { - DocPropertyMapping currentParent = properties.peek(); currentParent.addChild(docMapping); - String parentName = currentParent.getName(); - String fullName = SplitName.add(parentName, docMapping.getName()); + String parentName = currentParent.name(); + String fullName = SplitName.add(parentName, docMapping.name()); map.put(fullName, docMapping); } @@ -82,7 +78,6 @@ public class DocMappingBuilder { } private void applyFieldMapping(DocMapping docMapping) { - DocPropertyMapping mapping = map.get(docMapping.name()); if (mapping == null) { throw new IllegalStateException("DocMapping for [" + docMapping.name() + "] but property not included in document?"); @@ -94,19 +89,16 @@ public class DocMappingBuilder { * Collect the mapping of properties to 'raw' properties for those marked as sortable. */ public Map collectSortable() { - DocPropertyMapping peek = properties.peek(); SortableVisitor visitor = new SortableVisitor(); peek.visit(visitor); - - return visitor.getSortableMap(); + return visitor.sortableMap(); } /** * Create the document mapping. */ public DocumentMapping create(String queueId, String indexName, String indexType) { - int shards = docStore.shards(); int replicas = docStore.replicas(); DocPropertyMapping root = properties.peek(); @@ -119,19 +111,18 @@ public class DocMappingBuilder { */ private static class SortableVisitor extends DocPropertyAdapter { - private Map sortableMap = new LinkedHashMap<>(); + private final Map sortableMap = new LinkedHashMap<>(); @Override public void visitProperty(DocPropertyMapping property) { - - DocPropertyOptions options = property.getOptions(); + DocPropertyOptions options = property.options(); if (options != null && options.isSortable()) { - String fullPath = pathStack.peekFullPath(property.getName()); + String fullPath = pathStack.peekFullPath(property.name()); sortableMap.put(fullPath, fullPath + ".raw"); } } - private Map getSortableMap() { + private Map sortableMap() { return sortableMap; } } diff --git a/ebean-core/src/main/java/io/ebeanservice/docstore/api/mapping/DocPropertyAdapter.java b/ebean-core/src/main/java/io/ebeanservice/docstore/api/mapping/DocPropertyAdapter.java index 38aac295b..4385be512 100644 --- a/ebean-core/src/main/java/io/ebeanservice/docstore/api/mapping/DocPropertyAdapter.java +++ b/ebean-core/src/main/java/io/ebeanservice/docstore/api/mapping/DocPropertyAdapter.java @@ -27,7 +27,7 @@ public abstract class DocPropertyAdapter implements DocPropertyVisitor { @Override public void visitBeginObject(DocPropertyMapping property) { - pathStack.push(property.getName()); + pathStack.push(property.name()); } @Override @@ -37,7 +37,7 @@ public abstract class DocPropertyAdapter implements DocPropertyVisitor { @Override public void visitBeginList(DocPropertyMapping property) { - pathStack.push(property.getName()); + pathStack.push(property.name()); } @Override diff --git a/ebean-core/src/main/java/io/ebeanservice/docstore/api/mapping/DocPropertyMapping.java b/ebean-core/src/main/java/io/ebeanservice/docstore/api/mapping/DocPropertyMapping.java index 843f60f58..125616071 100644 --- a/ebean-core/src/main/java/io/ebeanservice/docstore/api/mapping/DocPropertyMapping.java +++ b/ebean-core/src/main/java/io/ebeanservice/docstore/api/mapping/DocPropertyMapping.java @@ -9,15 +9,12 @@ import java.util.List; /** * Property mapping in a doc store document structure. */ -public class DocPropertyMapping { +public final class DocPropertyMapping { private String name; - private DocPropertyType type; - private DocPropertyOptions options; - - private List children = new ArrayList<>(); + private final List children = new ArrayList<>(); /** * Construct ROOT. @@ -70,7 +67,6 @@ public class DocPropertyMapping { } private void visitChildren(DocPropertyVisitor visitor) { - for (DocPropertyMapping property : children) { property.visit(visitor); } @@ -78,41 +74,41 @@ public class DocPropertyMapping { @Override public String toString() { - return "name:" + name + " type:" + type + " options(" + options + ")"; + return "name:" + name + " type:" + type + " options:" + options; } /** * Return the type of the property. */ - public DocPropertyType getType() { + public DocPropertyType type() { return type; } /** * Set the type of the property. */ - public void setType(DocPropertyType type) { + public void type(DocPropertyType type) { this.type = type; } /** * Return the property name. */ - public String getName() { + public String name() { return name; } /** * Return the property options. */ - public DocPropertyOptions getOptions() { + public DocPropertyOptions options() { return options; } /** * Return the child nested properties. */ - public List getChildren() { + public List children() { return children; } diff --git a/ebean-core/src/main/java/io/ebeanservice/docstore/api/mapping/DocPropertyOptions.java b/ebean-core/src/main/java/io/ebeanservice/docstore/api/mapping/DocPropertyOptions.java index e7ee70d63..3fe031260 100644 --- a/ebean-core/src/main/java/io/ebeanservice/docstore/api/mapping/DocPropertyOptions.java +++ b/ebean-core/src/main/java/io/ebeanservice/docstore/api/mapping/DocPropertyOptions.java @@ -6,45 +6,32 @@ import io.ebean.annotation.DocProperty; /** * Options for mapping a property for document storage. */ -public class DocPropertyOptions { +public final class DocPropertyOptions { private Boolean code; - private Boolean sortable; - private Boolean store; - private Float boost; - private String nullValue; - private Boolean includeInAll; - private Boolean enabled; - private Boolean norms; - private Boolean docValues; - private String analyzer; - private String searchAnalyzer; - private String copyTo; - private DocProperty.Option options; /** * Construct with no values set. */ public DocPropertyOptions() { - } /** * Construct as a copy of the source options. */ - protected DocPropertyOptions(DocPropertyOptions source) { + DocPropertyOptions(DocPropertyOptions source) { this.code = source.code; this.sortable = source.sortable; this.store = source.store; @@ -85,11 +72,11 @@ public class DocPropertyOptions { return Boolean.TRUE.equals(code); } - public Boolean getCode() { + public Boolean code() { return code; } - public void setCode(Boolean code) { + public void code(Boolean code) { this.code = code; } @@ -97,91 +84,91 @@ public class DocPropertyOptions { return Boolean.TRUE.equals(sortable); } - public Boolean getSortable() { + public Boolean sortable() { return sortable; } - public void setSortable(Boolean sortable) { + public void sortable(Boolean sortable) { this.sortable = sortable; } - public Float getBoost() { + public Float boost() { return boost; } - public void setBoost(Float boost) { + public void boost(Float boost) { this.boost = boost; } - public String getNullValue() { + public String nullValue() { return nullValue; } - public void setNullValue(String nullValue) { + public void nullValue(String nullValue) { this.nullValue = nullValue; } - public Boolean getStore() { + public Boolean store() { return store; } - public void setStore(Boolean store) { + public void store(Boolean store) { this.store = store; } - public Boolean getIncludeInAll() { + public Boolean includeInAll() { return includeInAll; } - public void setIncludeInAll(Boolean includeInAll) { + public void includeInAll(Boolean includeInAll) { this.includeInAll = includeInAll; } - public Boolean getDocValues() { + public Boolean docValues() { return docValues; } - public void setDocValues(Boolean docValues) { + public void docValues(Boolean docValues) { this.docValues = docValues; } - public String getAnalyzer() { + public String analyzer() { return analyzer; } - public void setAnalyzer(String analyzer) { + public void analyzer(String analyzer) { this.analyzer = analyzer; } - public String getSearchAnalyzer() { + public String searchAnalyzer() { return searchAnalyzer; } - public void setSearchAnalyzer(String searchAnalyzer) { + public void searchAnalyzer(String searchAnalyzer) { this.searchAnalyzer = searchAnalyzer; } - public String getCopyTo() { + public String copyTo() { return copyTo; } - public void setCopyTo(String copyTo) { + public void copyTo(String copyTo) { this.copyTo = copyTo; } - public Boolean getEnabled() { + public Boolean enabled() { return enabled; } - public void setEnabled(Boolean enabled) { + public void enabled(Boolean enabled) { this.enabled = enabled; } - public Boolean getNorms() { + public Boolean norms() { return norms; } - public void setNorms(Boolean norms) { + public void norms(Boolean norms) { this.norms = norms; } @@ -192,11 +179,11 @@ public class DocPropertyOptions { return options != null && options != DocProperty.Option.DEFAULT; } - public DocProperty.Option getOptions() { + public DocProperty.Option options() { return options; } - public void setOptions(DocProperty.Option options) { + public void options(DocProperty.Option options) { this.options = options; } @@ -218,7 +205,6 @@ public class DocPropertyOptions { * Apply the property level mapping options. */ public void apply(DocProperty docMapping) { - options = docMapping.options(); if (docMapping.code()) { code = true; diff --git a/ebean-core/src/main/java/io/ebeanservice/docstore/api/mapping/DocumentMapping.java b/ebean-core/src/main/java/io/ebeanservice/docstore/api/mapping/DocumentMapping.java index 0b68545c7..57f8006ef 100644 --- a/ebean-core/src/main/java/io/ebeanservice/docstore/api/mapping/DocumentMapping.java +++ b/ebean-core/src/main/java/io/ebeanservice/docstore/api/mapping/DocumentMapping.java @@ -6,20 +6,14 @@ import io.ebean.docstore.DocMapping; /** * Mapping for a document stored in a doc store (like ElasticSearch). */ -public class DocumentMapping implements DocMapping { +public final class DocumentMapping implements DocMapping { protected final String queueId; - protected final String name; - protected final String type; - protected final FetchPath paths; - protected final DocPropertyMapping properties; - protected int shards; - protected int replicas; public DocumentMapping(String queueId, String name, String type, FetchPath paths, DocPropertyMapping properties, int shards, int replicas) { @@ -42,63 +36,63 @@ public class DocumentMapping implements DocMapping { /** * Return the queueId. */ - public String getQueueId() { + public String queueId() { return queueId; } /** * Return the name. */ - public String getName() { + public String name() { return name; } /** * Return the type. */ - public String getType() { + public String type() { return type; } /** * Return the document structure as PathProperties. */ - public FetchPath getPaths() { + public FetchPath paths() { return paths; } /** * Return the document structure with mapping details. */ - public DocPropertyMapping getProperties() { + public DocPropertyMapping properties() { return properties; } /** * Return the number of shards. */ - public int getShards() { + public int shards() { return shards; } /** * Set the number of shards. */ - public void setShards(int shards) { + public void shards(int shards) { this.shards = shards; } /** * Return the number of replicas. */ - public int getReplicas() { + public int replicas() { return replicas; } /** * Set the number of replicas. */ - public void setReplicas(int replicas) { + public void replicas(int replicas) { this.replicas = replicas; } } diff --git a/ebean-core/src/main/java/io/ebeanservice/docstore/api/support/DocStoreBeanBaseAdapter.java b/ebean-core/src/main/java/io/ebeanservice/docstore/api/support/DocStoreBeanBaseAdapter.java index 626daf1b4..3fddd23cb 100644 --- a/ebean-core/src/main/java/io/ebeanservice/docstore/api/support/DocStoreBeanBaseAdapter.java +++ b/ebean-core/src/main/java/io/ebeanservice/docstore/api/support/DocStoreBeanBaseAdapter.java @@ -196,24 +196,24 @@ public abstract class DocStoreBeanBaseAdapter implements DocStoreBeanAdapter< update = DocStoreMode.UPDATE; } } - embeddedInvalidation.add(getEmbeddedInvalidation(queueId, path, properties)); + embeddedInvalidation.add(embeddedInvalidation(queueId, path, properties)); } /** * Return the DsInvalidationListener based on the properties, path. */ - protected DocStoreEmbeddedInvalidation getEmbeddedInvalidation(String queueId, String path, Set properties) { + protected DocStoreEmbeddedInvalidation embeddedInvalidation(String queueId, String path, Set properties) { if (properties.contains("*")) { return new DocStoreEmbeddedInvalidation(queueId, path); } else { - return new DocStoreEmbeddedInvalidationProperties(queueId, path, getPropertyPositions(properties)); + return new DocStoreEmbeddedInvalidationProperties(queueId, path, propertyPositions(properties)); } } /** * Return the property names as property index positions. */ - protected int[] getPropertyPositions(Set properties) { + protected int[] propertyPositions(Set properties) { List posList = new ArrayList<>(); for (String property : properties) { BeanProperty prop = desc.beanProperty(property); @@ -244,10 +244,10 @@ public abstract class DocStoreBeanBaseAdapter implements DocStoreBeanAdapter< if (pathProps == null) { pathProps = new PathProperties(); } - return getDocStructure(pathProps, includeByDefault); + return docStructure(pathProps, includeByDefault); } - protected DocStructure getDocStructure(PathProperties pathProps, final boolean includeByDefault) { + protected DocStructure docStructure(PathProperties pathProps, final boolean includeByDefault) { final DocStructure docStructure = new DocStructure(pathProps); BeanProperty[] properties = desc.propertiesNonTransient(); for (BeanProperty property : properties) { @@ -267,35 +267,35 @@ public abstract class DocStoreBeanBaseAdapter implements DocStoreBeanAdapter< @Override public FetchPath embedded(String path) { - return docStructure.getEmbedded(path); + return docStructure.embedded(path); } @Override public FetchPath embeddedManyRoot(String path) { - return docStructure.getEmbeddedManyRoot(path); + return docStructure.embeddedManyRoot(path); } @Override - public boolean isMapped() { + public boolean mapped() { return mapped; } @Override - public String getQueueId() { + public String queueId() { return queueId; } @Override - public DocStoreMode getMode(PersistRequest.Type persistType, DocStoreMode txnMode) { + public DocStoreMode mode(PersistRequest.Type persistType, DocStoreMode txnMode) { if (txnMode == null) { - return getMode(persistType); + return mode(persistType); } else if (txnMode == DocStoreMode.IGNORE) { return DocStoreMode.IGNORE; } - return mapped ? txnMode : getMode(persistType); + return mapped ? txnMode : mode(persistType); } - private DocStoreMode getMode(PersistRequest.Type persistType) { + private DocStoreMode mode(PersistRequest.Type persistType) { switch (persistType) { case INSERT: return insert; diff --git a/ebean-core/src/main/java/io/ebeanservice/docstore/api/support/DocStoreDeleteEvent.java b/ebean-core/src/main/java/io/ebeanservice/docstore/api/support/DocStoreDeleteEvent.java index 35c120bd4..f5be5e6c9 100644 --- a/ebean-core/src/main/java/io/ebeanservice/docstore/api/support/DocStoreDeleteEvent.java +++ b/ebean-core/src/main/java/io/ebeanservice/docstore/api/support/DocStoreDeleteEvent.java @@ -10,10 +10,9 @@ import java.io.IOException; /** * A 'Delete by Id' request that is send to the document store. */ -public class DocStoreDeleteEvent implements DocStoreUpdate { +public final class DocStoreDeleteEvent implements DocStoreUpdate { private final BeanType beanType; - private final Object idValue; public DocStoreDeleteEvent(BeanType beanType, Object idValue) { diff --git a/ebean-core/src/main/java/io/ebeanservice/docstore/api/support/DocStoreEmbeddedInvalidation.java b/ebean-core/src/main/java/io/ebeanservice/docstore/api/support/DocStoreEmbeddedInvalidation.java index bbf5ca009..b96f1f839 100644 --- a/ebean-core/src/main/java/io/ebeanservice/docstore/api/support/DocStoreEmbeddedInvalidation.java +++ b/ebean-core/src/main/java/io/ebeanservice/docstore/api/support/DocStoreEmbeddedInvalidation.java @@ -9,7 +9,6 @@ import io.ebeanservice.docstore.api.DocStoreUpdates; public class DocStoreEmbeddedInvalidation { protected final String queueId; - protected final String path; public DocStoreEmbeddedInvalidation(String queueId, String path) { diff --git a/ebean-core/src/main/java/io/ebeanservice/docstore/api/support/DocStoreIndexEvent.java b/ebean-core/src/main/java/io/ebeanservice/docstore/api/support/DocStoreIndexEvent.java index ad1e5a706..e5df3e2ac 100644 --- a/ebean-core/src/main/java/io/ebeanservice/docstore/api/support/DocStoreIndexEvent.java +++ b/ebean-core/src/main/java/io/ebeanservice/docstore/api/support/DocStoreIndexEvent.java @@ -10,12 +10,10 @@ import java.io.IOException; /** * A 'Delete by Id' request that is send to the document store. */ -public class DocStoreIndexEvent implements DocStoreUpdate { +public final class DocStoreIndexEvent implements DocStoreUpdate { private final BeanType beanType; - private final Object idValue; - private final T bean; public DocStoreIndexEvent(BeanType beanType, Object idValue, T bean) { diff --git a/ebean-core/src/main/java/io/ebeanservice/docstore/api/support/DocStructure.java b/ebean-core/src/main/java/io/ebeanservice/docstore/api/support/DocStructure.java index d2d3a3ac4..ffc0942d9 100644 --- a/ebean-core/src/main/java/io/ebeanservice/docstore/api/support/DocStructure.java +++ b/ebean-core/src/main/java/io/ebeanservice/docstore/api/support/DocStructure.java @@ -12,7 +12,7 @@ import java.util.Set; /** * Document structure for mapping to document store. */ -public class DocStructure { +public final class DocStructure { /** * The full document structure. @@ -58,11 +58,11 @@ public class DocStructure { /** * Return the document structure for an embedded path. */ - public FetchPath getEmbedded(String path) { + public FetchPath embedded(String path) { return embedded.get(path); } - public FetchPath getEmbeddedManyRoot(String path) { + public FetchPath embeddedManyRoot(String path) { return manyRoot.get(path); } @@ -83,7 +83,6 @@ public class DocStructure { * Add a PathProperties for an embedded 'many' property (at the root level). */ private void prepare(String prop, BeanPropertyAssoc embProp) { - BeanDescriptor targetDesc = embProp.targetDescriptor(); PathProperties manyRootPath = new PathProperties(); diff --git a/ebean-core/src/main/java/io/ebeanservice/docstore/none/NoneDocStoreBeanAdapter.java b/ebean-core/src/main/java/io/ebeanservice/docstore/none/NoneDocStoreBeanAdapter.java index 2be5d1c13..4449a91a8 100644 --- a/ebean-core/src/main/java/io/ebeanservice/docstore/none/NoneDocStoreBeanAdapter.java +++ b/ebean-core/src/main/java/io/ebeanservice/docstore/none/NoneDocStoreBeanAdapter.java @@ -19,7 +19,7 @@ public final class NoneDocStoreBeanAdapter extends DocStoreBeanBaseAdapter } @Override - public boolean isMapped() { + public boolean mapped() { return false; } diff --git a/ebean-core/src/test/java/io/ebeaninternal/server/deploy/BeanDescriptor_documentMappingTest.java b/ebean-core/src/test/java/io/ebeaninternal/server/deploy/BeanDescriptor_documentMappingTest.java index 6968e3fc7..b4a77dc8b 100644 --- a/ebean-core/src/test/java/io/ebeaninternal/server/deploy/BeanDescriptor_documentMappingTest.java +++ b/ebean-core/src/test/java/io/ebeaninternal/server/deploy/BeanDescriptor_documentMappingTest.java @@ -18,7 +18,7 @@ public class BeanDescriptor_documentMappingTest extends BaseTest { DocumentMapping documentMapping = desc.docMapping(); - DocPropertyMapping properties = documentMapping.getProperties(); + DocPropertyMapping properties = documentMapping.properties(); assertThat(properties).isNotNull(); } @@ -30,7 +30,7 @@ public class BeanDescriptor_documentMappingTest extends BaseTest { DocumentMapping documentMapping = desc.docMapping(); - DocPropertyMapping properties = documentMapping.getProperties(); + DocPropertyMapping properties = documentMapping.properties(); assertThat(properties).isNotNull(); @@ -46,7 +46,7 @@ public class BeanDescriptor_documentMappingTest extends BaseTest { @Override public void visitProperty(DocPropertyMapping property) { - sb.append(property.getName() + ","); + sb.append(property.name() + ","); } @Override @@ -62,7 +62,7 @@ public class BeanDescriptor_documentMappingTest extends BaseTest { @Override public void visitBeginObject(DocPropertyMapping property) { - sb.append(" object{" + property.getName() + ":"); + sb.append(" object{" + property.name() + ":"); } @Override @@ -72,7 +72,7 @@ public class BeanDescriptor_documentMappingTest extends BaseTest { @Override public void visitBeginList(DocPropertyMapping property) { - sb.append(" nested{" + property.getName() + ": ["); + sb.append(" nested{" + property.name() + ": ["); } @Override diff --git a/ebean-test/src/test/java/io/ebean/xtest/docstore/DocStoreBeanBaseAdapterTest.java b/ebean-test/src/test/java/io/ebean/xtest/docstore/DocStoreBeanBaseAdapterTest.java index 2625d992c..76d35ac6c 100644 --- a/ebean-test/src/test/java/io/ebean/xtest/docstore/DocStoreBeanBaseAdapterTest.java +++ b/ebean-test/src/test/java/io/ebean/xtest/docstore/DocStoreBeanBaseAdapterTest.java @@ -34,7 +34,7 @@ public class DocStoreBeanBaseAdapterTest extends BaseTestCase { Assertions.assertThat(adapter.indexName()).isEqualTo("order"); Assertions.assertThat(adapter.indexType()).isEqualTo("order"); - Assertions.assertThat(adapter.getQueueId()).isEqualTo("order"); + Assertions.assertThat(adapter.queueId()).isEqualTo("order"); } static class TDAdapter extends DocStoreBeanBaseAdapter { diff --git a/ebean-test/src/test/java/io/ebean/xtest/docstore/DocStoreDeleteEventTest.java b/ebean-test/src/test/java/io/ebean/xtest/docstore/DocStoreDeleteEventTest.java index 1a626481c..1cb3af85f 100644 --- a/ebean-test/src/test/java/io/ebean/xtest/docstore/DocStoreDeleteEventTest.java +++ b/ebean-test/src/test/java/io/ebean/xtest/docstore/DocStoreDeleteEventTest.java @@ -51,7 +51,7 @@ public class DocStoreDeleteEventTest { DocStoreUpdates updates = new DocStoreUpdates(); event.addToQueue(updates); - List queueEntries = updates.getQueueEntries(); + List queueEntries = updates.queueEntries(); assertThat(queueEntries).hasSize(1); DocStoreQueueEntry entry = queueEntries.get(0); diff --git a/ebean-test/src/test/java/io/ebean/xtest/docstore/DocStoreIndexEventTest.java b/ebean-test/src/test/java/io/ebean/xtest/docstore/DocStoreIndexEventTest.java index 241642e90..5b0860392 100644 --- a/ebean-test/src/test/java/io/ebean/xtest/docstore/DocStoreIndexEventTest.java +++ b/ebean-test/src/test/java/io/ebean/xtest/docstore/DocStoreIndexEventTest.java @@ -55,7 +55,7 @@ public class DocStoreIndexEventTest { DocStoreUpdates updates = new DocStoreUpdates(); event.addToQueue(updates); - List queueEntries = updates.getQueueEntries(); + List queueEntries = updates.queueEntries(); assertThat(queueEntries).hasSize(1); DocStoreQueueEntry entry = queueEntries.get(0);