unquietcode.tools.flapi.builder.Descriptor.DescriptorHelper Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of flapi-builder Show documentation
The newest version!

package unquietcode.tools.flapi.builder.Descriptor;

import java.util.concurrent.atomic.AtomicReference;
import javax.annotation.Generated;
import unquietcode.tools.flapi.Descriptor;
import unquietcode.tools.flapi.builder.Block.BlockHelper;
import unquietcode.tools.flapi.builder.Method.MethodHelper;
import unquietcode.tools.flapi.generator.naming.NameGenerator;


/**
 * This class was generated using Flapi, the fluent API generator for Java.
 * Modifications to this file will be lost upon regeneration.
 * You have been warned!
 * 
 * Visit https://github.com/UnquietCode/Flapi for more information.
 * 
 * 
 * Generated on February 29, 2016 19:16:13 PST using version 1.0
 */
@Generated(value = "unquietcode.tools.flapi", date = "2016-02-29T19:16:13-08:00", comments = "generated using Flapi, the fluent API generator for Java, version 1.0")
public interface DescriptorHelper {
    /**
     * add a new method which proceeds to an existing block
     */
    void addBlockReference(String blockName, String methodSignature, AtomicReference _helper1);

    /**
     * Adds an enum selector, by passing in an enum class.
     */
    void addEnumSelector(Class clazz, String methodSignature, AtomicReference _helper1);

    /**
     * Add a new method to the top level descriptor block.
     */
    void addMethod(String methodSignature, AtomicReference _helper1);

    /**
     * mix in the contents of an annotated block helper
     */
    void addMixin(Class helper);

    /**
     * mix in the contents of another block by name
     */
    void addMixin(String blockName);

    Descriptor build();

    /**
     * Disable the use of timestamps in the generated source code.
     * This will eliminate changes between successive executions so long
     * as the same version of the tool is used each time.
     */
    void disableTimestamps();

    /**
     * Allow class names to be condensed, at the cost of no longer being
     * humanly readable. If your generated class names are too long to be
     * compiled, you will have to use this.
     */
    void enableCondensedClassNames();

    /**
     * set the name of the top level descriptor
     */
    void setDescriptorName(String descriptorName);

    /**
     * set the root package name to use for the generated classes
     */
    void setPackage(String packageName);

    /**
     * set the return type for the top level descriptor (default is void)
     */
    void setReturnType(Class returnType);

    /**
     * set the name of the generator's starting method (default is 'create')
     */
    void setStartingMethodName(String methodName);

    /**
     * Starts a new block.
     */
    void startBlock(String blockName, String methodSignature, AtomicReference _helper1, AtomicReference _helper2);

    /**
     * Starts a new anonymous block.
     */
    void startBlock(String methodSignature, AtomicReference _helper1, AtomicReference _helper2);

    /**
     * set the return type for the top level descriptor (default is void)
     */
    void setReturnType(String returnType);

    /**
     * Provide a custom NameGenerator.
     */
    void useCustomNameGenerator(NameGenerator generator);
}