Merge pull request #44 from CJSCommonPlatform/add-java-docs-visitable

Refactor visitable package and add JavaDocs
CJSCommonPlatform · Sep 8, 2017 · 0872e97 · 0872e97
2 parents db58109 + 3a8cb57
commit 0872e97
Show file tree

Hide file tree

Showing 44 changed files with 431 additions and 262 deletions.
diff --git a/...src/test/java/uk/gov/justice/generation/pojo/integration/test/AdditionalPropertiesIT.java b/...src/test/java/uk/gov/justice/generation/pojo/integration/test/AdditionalPropertiesIT.java
@@ -14,9 +14,9 @@
 import uk.gov.justice.generation.pojo.generators.plugin.PluginProvider;
 import uk.gov.justice.generation.pojo.integration.utils.ClassCompiler;
 import uk.gov.justice.generation.pojo.integration.utils.GeneratorFactoryBuilder;
-import uk.gov.justice.generation.pojo.visitable.VisitableSchema;
-import uk.gov.justice.generation.pojo.visitable.VisitableSchemaFactory;
-import uk.gov.justice.generation.pojo.visitable.acceptor.DefaultAcceptorFactory;
+import uk.gov.justice.generation.pojo.visitable.Visitable;
+import uk.gov.justice.generation.pojo.visitable.VisitableFactory;
+import uk.gov.justice.generation.pojo.visitable.acceptor.DefaultAcceptorService;
 import uk.gov.justice.generation.pojo.visitor.DefaultDefinitionFactory;
 import uk.gov.justice.generation.pojo.visitor.DefinitionBuilderVisitor;
 import uk.gov.justice.generation.pojo.write.SourceWriter;
@@ -74,10 +74,10 @@ public void shouldGenerateAClassWithAMapForAdditionalPropertiesIfAdditionalPrope
                 emptyList());
 
         final DefinitionBuilderVisitor definitionBuilderVisitor = new DefinitionBuilderVisitor(definitionFactory);
-        final VisitableSchemaFactory visitableSchemaFactory = new VisitableSchemaFactory();
-        final VisitableSchema visitableSchema = visitableSchemaFactory.createWith(schema, new DefaultAcceptorFactory(visitableSchemaFactory));
+        final VisitableFactory visitableFactory = new VisitableFactory();
+        final Visitable visitableSchema = visitableFactory.createWith(fieldName, schema, new DefaultAcceptorService(visitableFactory));
 
-        visitableSchema.accept(fieldName, definitionBuilderVisitor);
+        visitableSchema.accept(definitionBuilderVisitor);
 
         final List<Class<?>> newClasses = new ArrayList<>();
 

diff --git a/integration-test/src/test/java/uk/gov/justice/generation/pojo/integration/test/ArrayIT.java b/integration-test/src/test/java/uk/gov/justice/generation/pojo/integration/test/ArrayIT.java
@@ -15,9 +15,9 @@
 import uk.gov.justice.generation.pojo.generators.plugin.PluginProvider;
 import uk.gov.justice.generation.pojo.integration.utils.ClassCompiler;
 import uk.gov.justice.generation.pojo.integration.utils.GeneratorFactoryBuilder;
-import uk.gov.justice.generation.pojo.visitable.VisitableSchema;
-import uk.gov.justice.generation.pojo.visitable.VisitableSchemaFactory;
-import uk.gov.justice.generation.pojo.visitable.acceptor.DefaultAcceptorFactory;
+import uk.gov.justice.generation.pojo.visitable.Visitable;
+import uk.gov.justice.generation.pojo.visitable.VisitableFactory;
+import uk.gov.justice.generation.pojo.visitable.acceptor.DefaultAcceptorService;
 import uk.gov.justice.generation.pojo.visitor.DefaultDefinitionFactory;
 import uk.gov.justice.generation.pojo.visitor.DefinitionBuilderVisitor;
 import uk.gov.justice.generation.pojo.write.SourceWriter;
@@ -76,10 +76,10 @@ public void shouldAnArraySchemaDocumentWithAnArrayOfItemSchemas() throws Excepti
                 emptyList());
 
         final DefinitionBuilderVisitor definitionBuilderVisitor = new DefinitionBuilderVisitor(definitionFactory);
-        final VisitableSchemaFactory visitableSchemaFactory = new VisitableSchemaFactory();
-        final VisitableSchema visitableSchema = visitableSchemaFactory.createWith(schema, new DefaultAcceptorFactory(visitableSchemaFactory));
+        final VisitableFactory visitableFactory = new VisitableFactory();
+        final Visitable visitableSchema = visitableFactory.createWith(fieldName, schema, new DefaultAcceptorService(visitableFactory));
 
-        visitableSchema.accept(fieldName, definitionBuilderVisitor);
+        visitableSchema.accept(definitionBuilderVisitor);
 
         final List<Class<?>> newClasses = new ArrayList<>();
 

diff --git a/...gration-test/src/test/java/uk/gov/justice/generation/pojo/integration/test/BuilderIT.java b/...gration-test/src/test/java/uk/gov/justice/generation/pojo/integration/test/BuilderIT.java
@@ -14,9 +14,9 @@
 import uk.gov.justice.generation.pojo.generators.plugin.PluginProvider;
 import uk.gov.justice.generation.pojo.integration.utils.ClassCompiler;
 import uk.gov.justice.generation.pojo.integration.utils.GeneratorFactoryBuilder;
-import uk.gov.justice.generation.pojo.visitable.VisitableSchema;
-import uk.gov.justice.generation.pojo.visitable.VisitableSchemaFactory;
-import uk.gov.justice.generation.pojo.visitable.acceptor.DefaultAcceptorFactory;
+import uk.gov.justice.generation.pojo.visitable.Visitable;
+import uk.gov.justice.generation.pojo.visitable.VisitableFactory;
+import uk.gov.justice.generation.pojo.visitable.acceptor.DefaultAcceptorService;
 import uk.gov.justice.generation.pojo.visitor.DefaultDefinitionFactory;
 import uk.gov.justice.generation.pojo.visitor.DefinitionBuilderVisitor;
 import uk.gov.justice.generation.pojo.write.SourceWriter;
@@ -73,10 +73,10 @@ public void shouldGenerateAClassWithAMapForAdditionalPropertiesIfAdditionalPrope
                 emptyList());
 
         final DefinitionBuilderVisitor definitionBuilderVisitor = new DefinitionBuilderVisitor(definitionFactory);
-        final VisitableSchemaFactory visitableSchemaFactory = new VisitableSchemaFactory();
-        final VisitableSchema visitableSchema = visitableSchemaFactory.createWith(schema, new DefaultAcceptorFactory(visitableSchemaFactory));
+        final VisitableFactory visitableFactory = new VisitableFactory();
+        final Visitable visitableSchema = visitableFactory.createWith(fieldName, schema, new DefaultAcceptorService(visitableFactory));
 
-        visitableSchema.accept(fieldName, definitionBuilderVisitor);
+        visitableSchema.accept(definitionBuilderVisitor);
 
         final List<Class<?>> newClasses = new ArrayList<>();
 

diff --git a/...-test/src/test/java/uk/gov/justice/generation/pojo/integration/test/CombinedSchemaIT.java b/...-test/src/test/java/uk/gov/justice/generation/pojo/integration/test/CombinedSchemaIT.java
@@ -15,9 +15,9 @@
 import uk.gov.justice.generation.pojo.generators.plugin.PluginProvider;
 import uk.gov.justice.generation.pojo.integration.utils.ClassCompiler;
 import uk.gov.justice.generation.pojo.integration.utils.GeneratorFactoryBuilder;
-import uk.gov.justice.generation.pojo.visitable.VisitableSchema;
-import uk.gov.justice.generation.pojo.visitable.VisitableSchemaFactory;
-import uk.gov.justice.generation.pojo.visitable.acceptor.DefaultAcceptorFactory;
+import uk.gov.justice.generation.pojo.visitable.Visitable;
+import uk.gov.justice.generation.pojo.visitable.VisitableFactory;
+import uk.gov.justice.generation.pojo.visitable.acceptor.DefaultAcceptorService;
 import uk.gov.justice.generation.pojo.visitor.DefaultDefinitionFactory;
 import uk.gov.justice.generation.pojo.visitor.DefinitionBuilderVisitor;
 import uk.gov.justice.generation.pojo.write.SourceWriter;
@@ -75,10 +75,10 @@ public void shouldParseAVeryComplexSchemaDocument() throws Exception {
                 jsonSchemaFile.getName(), emptyList());
 
         final DefinitionBuilderVisitor definitionBuilderVisitor = new DefinitionBuilderVisitor(definitionFactory);
-        final VisitableSchemaFactory visitableSchemaFactory = new VisitableSchemaFactory();
-        final VisitableSchema visitableSchema = visitableSchemaFactory.createWith(schema, new DefaultAcceptorFactory(visitableSchemaFactory));
+        final VisitableFactory visitableFactory = new VisitableFactory();
+        final Visitable visitableSchema = visitableFactory.createWith(fieldName, schema, new DefaultAcceptorService(visitableFactory));
 
-        visitableSchema.accept(fieldName, definitionBuilderVisitor);
+        visitableSchema.accept(definitionBuilderVisitor);
 
         final List<Class<?>> newClasses = new ArrayList<>();
 

diff --git a/...n-test/src/test/java/uk/gov/justice/generation/pojo/integration/test/ComplexSchemaIT.java b/...n-test/src/test/java/uk/gov/justice/generation/pojo/integration/test/ComplexSchemaIT.java
@@ -11,9 +11,9 @@
 import uk.gov.justice.generation.pojo.generators.plugin.PluginProvider;
 import uk.gov.justice.generation.pojo.integration.utils.ClassCompiler;
 import uk.gov.justice.generation.pojo.integration.utils.GeneratorFactoryBuilder;
-import uk.gov.justice.generation.pojo.visitable.VisitableSchema;
-import uk.gov.justice.generation.pojo.visitable.VisitableSchemaFactory;
-import uk.gov.justice.generation.pojo.visitable.acceptor.DefaultAcceptorFactory;
+import uk.gov.justice.generation.pojo.visitable.Visitable;
+import uk.gov.justice.generation.pojo.visitable.VisitableFactory;
+import uk.gov.justice.generation.pojo.visitable.acceptor.DefaultAcceptorService;
 import uk.gov.justice.generation.pojo.visitor.DefaultDefinitionFactory;
 import uk.gov.justice.generation.pojo.visitor.DefinitionBuilderVisitor;
 import uk.gov.justice.generation.pojo.write.SourceWriter;
@@ -65,10 +65,10 @@ public void shouldParseAVeryComplexSchemaDocument() throws Exception {
                 emptyList());
 
         final DefinitionBuilderVisitor definitionBuilderVisitor = new DefinitionBuilderVisitor(definitionFactory);
-        final VisitableSchemaFactory visitableSchemaFactory = new VisitableSchemaFactory();
-        final VisitableSchema visitableSchema = visitableSchemaFactory.createWith(schema, new DefaultAcceptorFactory(visitableSchemaFactory));
+        final VisitableFactory visitableFactory = new VisitableFactory();
+        final Visitable visitableSchema = visitableFactory.createWith(fieldName, schema, new DefaultAcceptorService(visitableFactory));
 
-        visitableSchema.accept(fieldName, definitionBuilderVisitor);
+        visitableSchema.accept(definitionBuilderVisitor);
 
         final PluginProvider pluginProvider = new DefaultPluginProvider();
 

diff --git a/...st/src/test/java/uk/gov/justice/generation/pojo/integration/test/DefinitionBuilderIT.java b/...st/src/test/java/uk/gov/justice/generation/pojo/integration/test/DefinitionBuilderIT.java
@@ -17,9 +17,9 @@
 import uk.gov.justice.generation.pojo.generators.plugin.DefaultPluginProvider;
 import uk.gov.justice.generation.pojo.generators.plugin.TypeNamePluginProcessor;
 import uk.gov.justice.generation.pojo.integration.utils.ClassCompiler;
-import uk.gov.justice.generation.pojo.visitable.VisitableSchema;
-import uk.gov.justice.generation.pojo.visitable.VisitableSchemaFactory;
-import uk.gov.justice.generation.pojo.visitable.acceptor.DefaultAcceptorFactory;
+import uk.gov.justice.generation.pojo.visitable.Visitable;
+import uk.gov.justice.generation.pojo.visitable.VisitableFactory;
+import uk.gov.justice.generation.pojo.visitable.acceptor.DefaultAcceptorService;
 import uk.gov.justice.generation.pojo.visitor.DefaultDefinitionFactory;
 import uk.gov.justice.generation.pojo.visitor.DefinitionBuilderVisitor;
 import uk.gov.justice.generation.pojo.write.SourceWriter;
@@ -76,10 +76,10 @@ public void shouldBuildTypeSpecFromSchema() throws Exception {
 
         final DefinitionBuilderVisitor definitionBuilderVisitor = new DefinitionBuilderVisitor(definitionFactory);
 
-        final VisitableSchemaFactory visitableSchemaFactory = new VisitableSchemaFactory();
-        final VisitableSchema visitableSchema = visitableSchemaFactory.createWith(schema, new DefaultAcceptorFactory(visitableSchemaFactory));
+        final VisitableFactory visitableFactory = new VisitableFactory();
+        final Visitable visitableSchema = visitableFactory.createWith(fieldName, schema, new DefaultAcceptorService(visitableFactory));
 
-        visitableSchema.accept(fieldName, definitionBuilderVisitor);
+        visitableSchema.accept(definitionBuilderVisitor);
 
         final ClassDefinition personClassDefinition = (ClassDefinition) definitionBuilderVisitor.getDefinitions().get(0);
 

diff --git a/...ion-test/src/test/java/uk/gov/justice/generation/pojo/integration/test/EmptySchemaIT.java b/...ion-test/src/test/java/uk/gov/justice/generation/pojo/integration/test/EmptySchemaIT.java
@@ -16,9 +16,9 @@
 import uk.gov.justice.generation.pojo.generators.plugin.PluginProvider;
 import uk.gov.justice.generation.pojo.integration.utils.ClassCompiler;
 import uk.gov.justice.generation.pojo.integration.utils.GeneratorFactoryBuilder;
-import uk.gov.justice.generation.pojo.visitable.VisitableSchema;
-import uk.gov.justice.generation.pojo.visitable.VisitableSchemaFactory;
-import uk.gov.justice.generation.pojo.visitable.acceptor.DefaultAcceptorFactory;
+import uk.gov.justice.generation.pojo.visitable.Visitable;
+import uk.gov.justice.generation.pojo.visitable.VisitableFactory;
+import uk.gov.justice.generation.pojo.visitable.acceptor.DefaultAcceptorService;
 import uk.gov.justice.generation.pojo.visitor.DefaultDefinitionFactory;
 import uk.gov.justice.generation.pojo.visitor.DefinitionBuilderVisitor;
 import uk.gov.justice.generation.pojo.write.SourceWriter;
@@ -138,10 +138,10 @@ private List<Class<?>> setupAndGenerate(final String fileName) {
                 emptyList());
 
         final DefinitionBuilderVisitor definitionBuilderVisitor = new DefinitionBuilderVisitor(definitionFactory);
-        final VisitableSchemaFactory visitableSchemaFactory = new VisitableSchemaFactory();
-        final VisitableSchema visitableSchema = visitableSchemaFactory.createWith(schema, new DefaultAcceptorFactory(visitableSchemaFactory));
+        final VisitableFactory visitableSchemaFactory = new VisitableFactory();
+        final Visitable visitableSchema = visitableSchemaFactory.createWith(fieldName, schema, new DefaultAcceptorService(visitableSchemaFactory));
 
-        visitableSchema.accept(fieldName, definitionBuilderVisitor);
+        visitableSchema.accept(definitionBuilderVisitor);
 
         final List<Class<?>> newClasses = new ArrayList<>();
 

diff --git a/...c/test/java/uk/gov/justice/generation/pojo/integration/test/IgnoreHardCodedClassesIT.java b/...c/test/java/uk/gov/justice/generation/pojo/integration/test/IgnoreHardCodedClassesIT.java
@@ -13,9 +13,9 @@
 import uk.gov.justice.generation.pojo.generators.plugin.PluginProvider;
 import uk.gov.justice.generation.pojo.integration.utils.ClassCompiler;
 import uk.gov.justice.generation.pojo.integration.utils.GeneratorFactoryBuilder;
-import uk.gov.justice.generation.pojo.visitable.VisitableSchema;
-import uk.gov.justice.generation.pojo.visitable.VisitableSchemaFactory;
-import uk.gov.justice.generation.pojo.visitable.acceptor.DefaultAcceptorFactory;
+import uk.gov.justice.generation.pojo.visitable.Visitable;
+import uk.gov.justice.generation.pojo.visitable.VisitableFactory;
+import uk.gov.justice.generation.pojo.visitable.acceptor.DefaultAcceptorService;
 import uk.gov.justice.generation.pojo.visitor.DefaultDefinitionFactory;
 import uk.gov.justice.generation.pojo.visitor.DefinitionBuilderVisitor;
 import uk.gov.justice.generation.pojo.write.SourceWriter;
@@ -71,10 +71,10 @@ public void shouldNotAutoGenerateClassesWhichHaveBeenCraftedByHand() throws Exce
                 ignoredClassNames);
 
         final DefinitionBuilderVisitor definitionBuilderVisitor = new DefinitionBuilderVisitor(definitionFactory);
-        final VisitableSchemaFactory visitableSchemaFactory = new VisitableSchemaFactory();
-        final VisitableSchema visitableSchema = visitableSchemaFactory.createWith(schema, new DefaultAcceptorFactory(visitableSchemaFactory));
+        final VisitableFactory visitableFactory = new VisitableFactory();
+        final Visitable visitableSchema = visitableFactory.createWith(fieldName, schema, new DefaultAcceptorService(visitableFactory));
 
-        visitableSchema.accept(fieldName, definitionBuilderVisitor);
+        visitableSchema.accept(definitionBuilderVisitor);
 
         final List<Class<?>> newClasses = new ArrayList<>();
 
@@ -116,10 +116,10 @@ public void shouldHandleTheRootObjectBeingCraftedByHand() throws Exception {
                 ignoredClassNames);
 
         final DefinitionBuilderVisitor definitionBuilderVisitor = new DefinitionBuilderVisitor(definitionFactory);
-        final VisitableSchemaFactory visitableSchemaFactory = new VisitableSchemaFactory();
-        final VisitableSchema visitableSchema = visitableSchemaFactory.createWith(schema, new DefaultAcceptorFactory(visitableSchemaFactory));
+        final VisitableFactory visitableFactory = new VisitableFactory();
+        final Visitable visitableSchema = visitableFactory.createWith(fieldName, schema, new DefaultAcceptorService(visitableFactory));
 
-        visitableSchema.accept(fieldName, definitionBuilderVisitor);
+        visitableSchema.accept(definitionBuilderVisitor);
 
         final List<Class<?>> newClasses = new ArrayList<>();
 

diff --git a/...tion-test/src/test/java/uk/gov/justice/generation/pojo/integration/test/NullSchemaIT.java b/...tion-test/src/test/java/uk/gov/justice/generation/pojo/integration/test/NullSchemaIT.java
@@ -11,9 +11,9 @@
 import uk.gov.justice.generation.pojo.generators.plugin.PluginProvider;
 import uk.gov.justice.generation.pojo.integration.utils.ClassCompiler;
 import uk.gov.justice.generation.pojo.integration.utils.GeneratorFactoryBuilder;
-import uk.gov.justice.generation.pojo.visitable.VisitableSchema;
-import uk.gov.justice.generation.pojo.visitable.VisitableSchemaFactory;
-import uk.gov.justice.generation.pojo.visitable.acceptor.DefaultAcceptorFactory;
+import uk.gov.justice.generation.pojo.visitable.Visitable;
+import uk.gov.justice.generation.pojo.visitable.VisitableFactory;
+import uk.gov.justice.generation.pojo.visitable.acceptor.DefaultAcceptorService;
 import uk.gov.justice.generation.pojo.visitor.DefaultDefinitionFactory;
 import uk.gov.justice.generation.pojo.visitor.DefinitionBuilderVisitor;
 import uk.gov.justice.generation.pojo.write.SourceWriter;
@@ -65,10 +65,10 @@ public void shouldGeneratePojosFromANullSchema() throws Exception {
                 emptyList());
 
         final DefinitionBuilderVisitor definitionBuilderVisitor = new DefinitionBuilderVisitor(definitionFactory);
-        final VisitableSchemaFactory visitableSchemaFactory = new VisitableSchemaFactory();
-        final VisitableSchema visitableSchema = visitableSchemaFactory.createWith(schema, new DefaultAcceptorFactory(visitableSchemaFactory));
+        final VisitableFactory visitableFactory = new VisitableFactory();
+        final Visitable visitableSchema = visitableFactory.createWith(fieldName, schema, new DefaultAcceptorService(visitableFactory));
 
-        visitableSchema.accept(fieldName, definitionBuilderVisitor);
+        visitableSchema.accept(definitionBuilderVisitor);
 
         final PluginProvider pluginProvider = new DefaultPluginProvider();
 

diff --git a/...-test/src/test/java/uk/gov/justice/generation/pojo/integration/test/OptionalFieldsIT.java b/...-test/src/test/java/uk/gov/justice/generation/pojo/integration/test/OptionalFieldsIT.java
@@ -16,9 +16,9 @@
 import uk.gov.justice.generation.pojo.generators.plugin.PluginProvider;
 import uk.gov.justice.generation.pojo.integration.utils.ClassCompiler;
 import uk.gov.justice.generation.pojo.integration.utils.GeneratorFactoryBuilder;
-import uk.gov.justice.generation.pojo.visitable.VisitableSchema;
-import uk.gov.justice.generation.pojo.visitable.VisitableSchemaFactory;
-import uk.gov.justice.generation.pojo.visitable.acceptor.DefaultAcceptorFactory;
+import uk.gov.justice.generation.pojo.visitable.Visitable;
+import uk.gov.justice.generation.pojo.visitable.VisitableFactory;
+import uk.gov.justice.generation.pojo.visitable.acceptor.DefaultAcceptorService;
 import uk.gov.justice.generation.pojo.visitor.DefaultDefinitionFactory;
 import uk.gov.justice.generation.pojo.visitor.DefinitionBuilderVisitor;
 import uk.gov.justice.generation.pojo.write.SourceWriter;
@@ -76,10 +76,10 @@ public void shouldParseAVeryComplexSchemaDocument() throws Exception {
                 emptyList());
 
         final DefinitionBuilderVisitor definitionBuilderVisitor = new DefinitionBuilderVisitor(definitionFactory);
-        final VisitableSchemaFactory visitableSchemaFactory = new VisitableSchemaFactory();
-        final VisitableSchema visitableSchema = visitableSchemaFactory.createWith(schema, new DefaultAcceptorFactory(visitableSchemaFactory));
+        final VisitableFactory visitableFactory = new VisitableFactory();
+        final Visitable visitableSchema = visitableFactory.createWith(fieldName, schema, new DefaultAcceptorService(visitableFactory));
 
-        visitableSchema.accept(fieldName, definitionBuilderVisitor);
+        visitableSchema.accept(definitionBuilderVisitor);
 
         final ArrayList<Class<?>> classes = new ArrayList<>();
         final PluginProvider pluginProvider = new DefaultPluginProvider();