DescriptorConfigurator.java

package unquietcode.tools.flapi.builder;

import unquietcode.tools.flapi.Descriptor;
import unquietcode.tools.flapi.DescriptorMaker;
import unquietcode.tools.flapi.Flapi;
import unquietcode.tools.flapi.generator.naming.HashedNameGenerator;

/**
 * Smaller descriptor for customizing the creation of a
 * descriptor from an annotated class.
 *
 * @author Benjamin Fagin
 * @version 08-03-2014
 */
public class DescriptorConfigurator implements DescriptorMaker {
	private static final int NAME_GROUP = 3;

	@Override
	public Descriptor descriptor() {
		Descriptor builder = Flapi.builder()
			.setPackage("unquietcode.tools.flapi.configurator")
			.setDescriptorName("DescriptorConfigurator")
			.useCustomNameGenerator(new HashedNameGenerator())

			// descriptor methods

			.addMethod("setPackage(String packageName)")
				.withDocumentation("set the root package name to use for the generated classes")
			.atMost(1)

			.addMethod("setStartingMethodName(String methodName)")
				.withDocumentation("set the name of the generator's starting method (default is 'create')")
			.atMost(1)

			.addMethod("enableCondensedClassNames()")
				.withDocumentation()
					.addContent("Allow class names to be condensed, at the cost of no longer being\n")
					.addContent("humanly readable. If your generated class names are too long to be\n")
					.addContent("compiled, you will have to use this.")
				.finish()
			.atMost(1, NAME_GROUP)

			.addMethod("useCustomNameGenerator(unquietcode.tools.flapi.generator.naming.NameGenerator generator)")
				.withDocumentation()
					.addContent("Provide a custom NameGenerator.")
				.finish()
			.atMost(1, NAME_GROUP)

			.addMethod("disableTimestamps()")
				.withDocumentation()
					.addContent("Disable the use of timestamps in the generated source code.\n")
					.addContent("This will eliminate changes between successive executions so long\n")
					.addContent("as the same version of the tool is used each time.")
				.finish()
			.atMost(1)

			.addMethod("build()").last(Descriptor.class)
		.build();

		return builder;
	}
}