enhancement to #197 which allows for further customization of the generated

names (prior to any hashing or other mangling, which applies to builders only)

Author: UnquietCode

flapi-descriptor/src/main/java/unquietcode/tools/flapi/generator/naming/NameGenerator.java

@@ -47,4 +47,20 @@ public interface NameGenerator {
 	 * @return a new state name, or the same, but not null
 	 */
 	String className(String stateKey);
+
+
+	// *Generator
+	String generatorName(String stateName);
+
+	// *Factory
+	String factoryName(String stateName);
+
+	// *Helper
+	String helperName(String stateName);
+
+	// *Builder
+	String builderName(String stateName);
+
+	// Start
+	String wrapperName(String stateName);
 }

src/main/java/unquietcode/tools/flapi/generator/AbstractGenerator.java

@@ -42,9 +42,8 @@ protected AbstractGenerator(GeneratorContext ctx) {
 
 	protected static final TypeCreationStrategy BUILDER_INTERFACE_STRATEGY = new DefaultTypeCreationStrategy() {
 		public @Override JDefinedClass createStrongType(GeneratorContext ctx, StateClass state) {
-			String name = ctx.getGeneratedName("", "Builder", state);
-
-			Pair<JDefinedClass, Boolean> construction = ctx.getOrCreateInterface(state.getName(), name);
+			final String name = ctx.getGeneratedName(state);
+			final Pair<JDefinedClass, Boolean> construction = ctx.getOrCreateInterface(state.getName(), name);
 			final JDefinedClass _interface = construction.first;
 			final boolean created = construction.second;
 
@@ -128,33 +127,35 @@ public JDefinedClass createStrongType(GeneratorContext ctx, StateClass state) {
 			if (state.getHelperClass() != null) {
 				return null;
 			} else {
-				return ctx.getOrCreateInterface(state.getName(), state.getName() + "Helper").first;
+				String name = ctx.getNameGenerator().helperName(state.getName());
+				return ctx.getOrCreateInterface(state.getName(), name).first;
 			}
 		}
 	};
 
 	protected static final TypeCreationStrategy GENERATOR_CLASS_STRATEGY = new DefaultTypeCreationStrategy() {
 		public JDefinedClass createStrongType(GeneratorContext ctx, StateClass state) {
-			String name = state.getName()+"Generator";
+			String name = ctx.getNameGenerator().generatorName(state.getName());
 			return ctx.getOrCreateClass(state.getName(), name).first;
 		}
 	};
 
 	protected static final TypeCreationStrategy FACTORY_INTERFACE_STRATEGY = new DefaultTypeCreationStrategy() {
 		public JDefinedClass createStrongType(GeneratorContext ctx, StateClass state) {
-			String name = state.getName()+"Factory";
+			String name = ctx.getNameGenerator().factoryName(state.getName());
 			return ctx.getOrCreateInterface(state.getName(), name).first;
 		}
 	};
 
 	public static final TypeCreationStrategy WRAPPER_INTERFACE_STRATEGY = new DefaultTypeCreationStrategy() {
 		public @Override JDefinedClass createStrongType(GeneratorContext ctx, StateClass state) {
-			String name = state.getName()+"Builder";
-			JDefinedClass parent = ctx.getOrCreateInterface(state.getName(), name).first;
+			final String builderName = ctx.getNameGenerator().builderName(state.getName());
+			final JDefinedClass parent = ctx.getOrCreateInterface(state.getName(), builderName).first;
 			JDefinedClass startClass;
 
 			try {
-				startClass = parent._interface("Start");
+				String wrapperName = ctx.getNameGenerator().wrapperName(state.getName());
+				startClass = parent._interface(wrapperName);
 			} catch (JClassAlreadyExistsException ex) {
 				return ex.getExistingClass();
 			}

src/main/java/unquietcode/tools/flapi/generator/GeneratorContext.java

@@ -82,6 +82,10 @@ private String checkPackageName(String name) {
 		return name;
 	}
 
+	public NameGenerator getNameGenerator() {
+		return nameGenerator;
+	}
+
 	public void setNameGenerator(NameGenerator generator) {
 		this.nameGenerator = Objects.requireNonNull(generator);
 	}
@@ -155,14 +159,12 @@ public boolean doesInterfaceExist(String name) {
 	 *  a lack of support for two methods with the same name but
 	 *  different parameters.
 	 *
-	 * @param prefix prefix for the name (eg 'Impl')
-	 * @param suffix suffix for the name (eg 'Builder')
 	 * @param state state to generate a name for
 	 * @return the generated name, which should be unique across the graph
 	 */
-	public String getGeneratedName(String prefix, String suffix, StateClass state) {
-		StringBuilder name = new StringBuilder();
-		name.append(prefix).append(state.getName()).append(suffix);
+	public String getGeneratedName(StateClass state) {
+		final String builderName = nameGenerator.builderName(state.getName());
+		final StringBuilder name = new StringBuilder(builderName);
 
 		for (Transition transition : state.getTransitions()) {
 			final boolean isImplicit = transition.info().isImplicit();

src/main/java/unquietcode/tools/flapi/generator/naming/DefaultNameGenerator.java

@@ -17,8 +17,7 @@
 package unquietcode.tools.flapi.generator.naming;
 
 /**
- * Default name generator, which acts simply as a pass-through
- * for the provided names.
+ * Default name generator.
  *
  * @author Ben Fagin
  * @version 2015-01-14
@@ -34,4 +33,29 @@ public String methodName(String methodKey) {
 	public String className(String stateKey) {
 		return stateKey;
 	}
+
+	@Override
+	public String generatorName(String stateName) {
+		return stateName+"Generator";
+	}
+
+	@Override
+	public String factoryName(String stateName) {
+		return stateName+"Factory";
+	}
+
+	@Override
+	public String helperName(String stateName) {
+		return stateName+"Helper";
+	}
+
+	@Override
+	public String builderName(String stateName) {
+		return stateName+"Builder";
+	}
+
+	@Override
+	public String wrapperName(String stateName) {
+		return "Start";
+	}
 }

src/main/java/unquietcode/tools/flapi/generator/naming/HashedNameGenerator.java

@@ -25,7 +25,7 @@
  * @author Ben Fagin
  * @version 2015-01-14
  */
-public class HashedNameGenerator implements NameGenerator {
+public class HashedNameGenerator extends DefaultNameGenerator {
 	private final Function<String, String> methodNameHasher = new Hasher("m");
 	private final Function<String, String> stateNameHasher = new Hasher("S");
 

src/main/java/unquietcode/tools/flapi/generator/naming/NameGenerator.java

@@ -45,4 +45,20 @@ public interface NameGenerator {
 	 * @return a new state name, or the same, but not null
 	 */
 	String className(String stateKey);
+
+
+	// *Generator
+	String generatorName(String stateName);
+
+	// *Factory
+	String factoryName(String stateName);
+
+	// *Helper
+	String helperName(String stateName);
+
+	// *Builder
+	String builderName(String stateName);
+
+	// Start
+	String wrapperName(String stateName);
 }

src/test/java/unquietcode/tools/flapi/GraphNaming_T.java

@@ -9,6 +9,7 @@
 
 import org.junit.Test;
 import unquietcode.tools.flapi.generator.GeneratorContext;
+import unquietcode.tools.flapi.generator.naming.DefaultNameGenerator;
 import unquietcode.tools.flapi.graph.components.LateralTransition;
 import unquietcode.tools.flapi.graph.components.StateClass;
 import unquietcode.tools.flapi.graph.components.Transition;
@@ -30,16 +31,21 @@ public void twoMethodsInDifferentStatesYieldsDifferentStateNames() {
 		t2.info().setMaxOccurrences(1);
 
 		GeneratorContext ctx = new GeneratorContext("");
+		ctx.setNameGenerator(new DefaultNameGenerator() {
+			public @Override String builderName(String stateName) {
+				return stateName;
+			}
+		});
 
 		StateClass sc1 = new StateClass();
 		sc1.setName("State");
 		sc1.addTransitions(t1);
-		String s1 = ctx.getGeneratedName("", "", sc1);
+		String s1 = ctx.getGeneratedName(sc1);
 
 		StateClass sc2 = new StateClass();
 		sc2.setName("State");
 		sc2.addTransitions(t2);
-		String s2 = ctx.getGeneratedName("", "", sc2);
+		String s2 = ctx.getGeneratedName(sc2);
 
 		assertFalse(s1.equals(s2));
 	}
@@ -62,7 +68,13 @@ public void twoMethodsInTheSameClass() {
 		sc1.addTransitions(t1, t2);
 
 		GeneratorContext ctx = new GeneratorContext("");
-		String name = ctx.getGeneratedName("", "", sc1);
+		ctx.setNameGenerator(new DefaultNameGenerator() {
+			public @Override String builderName(String stateName) {
+				return stateName;
+			}
+		});
+
+		String name = ctx.getGeneratedName(sc1);
 		assertEquals("expected the same name", "State_2method_2method_1A", name);
 	}
 }