net.sf.esfinge.classmock.api

Interface IClassWriter

All Superinterfaces:

IAnnotationWriter

All Known Implementing Classes:

ClassMock

public interface IClassWriter
extends IAnnotationWriter

Class responsible for define all properties at class level.

Method Summary

Modifier and Type	Method and Description
IClassWriter	asAbstract() Define your generated entity to be an Abstract Class.
IClassWriter	asAnnotation() Define your generated entity to be an Annotation.
IClassWriter	asClass() Define your generated entity to be a Concrete Class (default).
IClassWriter	asEnum() Define your generated entity to be an Enum.
IClassWriter	asInterface() Define your generated entity to be an Interface.
Class<?>	build() Build your entity.
IClassWriter	clone(String name) Define a clone of all defined for your entity, but with a new name because the old one is already in use.
IFieldWriter	field(String name, Class<?> type) Add a field to your entity.
IFieldWriter	fieldByParse(String fieldSignature) Define a way to parse a field with all properties and annotations from a String.
IClassWriter	interfaces(Class<?>... classes) Define the interfaces that your generated entity will implements.
IMethodWriter	method(IMethodReader method) Add a method to your entity.
IMethodWriter	method(String name) Add a method to your entity.
IMethodWriter	methodByParse(String methodSignature) Define a way to parse a method with all properties and annotations from a String.
IClassWriter	modifiers(ModifierEnum... modifiers) Define the modifiers that you want in your entity.
IClassWriter	name(String name) Define the name of your entity, you can also inform the package as a prefix.
ISuperClassWriter	superclass(Class<?> superclass) Define a super class that your generated entity will extends.
IClassWriter	version(JavaEnum javaEnum) Define the version of JRE that your entity will be compiled.
IClassWriter	visibility(VisibilityEnum visibility) Define the visibility of your entity.

Methods inherited from interface net.sf.esfinge.classmock.api.IAnnotationWriter

annotation, annotation, annotation

Method Detail

asClass

IClassWriter asClass()

Define your generated entity to be a Concrete Class (default).

Returns:

IClassWriter

asInterface

IClassWriter asInterface()

Define your generated entity to be an Interface.

Returns:

IClassWriter

asAbstract

IClassWriter asAbstract()

Define your generated entity to be an Abstract Class.

Returns:

IClassWriter

asEnum

IClassWriter asEnum()

Define your generated entity to be an Enum.

Returns:

IClassWriter

asAnnotation

IClassWriter asAnnotation()

Define your generated entity to be an Annotation.

Returns:

IClassWriter

version

IClassWriter version(JavaEnum javaEnum)

Define the version of JRE that your entity will be compiled.

Parameters:

javaEnum - the version of java entity

Returns:

IClassWriter

name

IClassWriter name(String name)

Define the name of your entity, you can also inform the package as a prefix.

Ex: my.fake.package.MyGenericDynClass

Parameters:

name - of the entity

Returns:

IClassWriter

visibility

IClassWriter visibility(VisibilityEnum visibility)

Define the visibility of your entity.

Ex: PUBLIC, PRIVATE or PROTECTED

Parameters:

visibility - of the entity

Returns:

IClassWriter

modifiers

IClassWriter modifiers(ModifierEnum... modifiers)

Define the modifiers that you want in your entity.

Ex: FINAL, ABSTRACT...

Parameters:

modifiers - of the entity

Returns:

IClassWriter

superclass

ISuperClassWriter superclass(Class<?> superclass)

Define a super class that your generated entity will extends.

Parameters:

superclass - to be extended

Returns:

ISuperClassWriter

interfaces

IClassWriter interfaces(Class<?>... classes)

Define the interfaces that your generated entity will implements.

Parameters:

classes - of interfaces

Returns:

IClassWriter

field

IFieldWriter field(String name,
                   Class<?> type)

Add a field to your entity.

Parameters:

name - of the field

type - class type of the field

Returns:

IFieldWriter

fieldByParse

IFieldWriter fieldByParse(String fieldSignature)

Define a way to parse a field with all properties and annotations from a String. You must remember this:

- Semicolon is Optional

- Is better specify all class type with their respective packages, if you don't it will try to find your class type for you. So, it is possible to load a class type with the same name but in a different package.

Ex:
java.lang.String myField; // the default visibility is private

Ex:
final static String myField; // with modifiers (static and final)

Ex:
public String myField; // with visibility (public)

Ex:
private static final String myField; // with visibility and modifiers

Ex:
@Id // with annotation
@Column(name = \"MY_COLUMN_NAME\", nullable = false) // annotation and properties
private static final String myField; // with visibility and modifiers

Parameters:

fieldSignature - the signature of your field to parse.

Returns:

IFieldWriter

method

IMethodWriter method(String name)

Add a method to your entity.

Parameters:

name - of the method to be added

Returns:

IMethodWriter

method

IMethodWriter method(IMethodReader method)

Add a method to your entity.

Parameters:

method - to be added

Returns:

IMethodWriter

methodByParse

IMethodWriter methodByParse(String methodSignature)

Define a way to parse a method with all properties and annotations from a String. You must remember this:

- parentheses and braces are Optional

- Is better specify all class type with their respective packages, if you don't it will try to find your class type for you. So, it is possible to load a class type with the same name but in a different package.

Ex:
java.lang.String getMyMethod(){}; // the default visibility is public

Ex:
final static String getMyMethod; // with modifiers (static and final)

Ex:
public String getMyMethod; // with visibility (public)

Ex:
private static final String getMyMethod; // with visibility and modifiers

Ex:
@Id // with annotation
@Column(name = \"MY_COLUMN_NAME\", nullable = false) // annotation
private static final String getMyMethod; // with visibility and modifiers

Ex:
public String findById(@NotNull String code) throws NullPointerException; // with parameter and exception

Parameters:

methodSignature - the signature of your method to parse.

Returns:

IMethodWriter

build

Class<?> build()

Build your entity.

Returns:

entity created

clone

IClassWriter clone(String name)

Define a clone of all defined for your entity, but with a new name because the old one is already in use.

Parameters:

name - of your new entity

Returns:

a new instance of IClassWriter