org.mybatis.generator.api

Class GeneratedJavaFile

java.lang.Object

org.mybatis.generator.api.GeneratedFile

org.mybatis.generator.api.GeneratedJavaFile

public class GeneratedJavaFile
extends GeneratedFile

The Class GeneratedJavaFile.

Author:

Jeff Butler

Field Summary

Fields inherited from class org.mybatis.generator.api.GeneratedFile

targetProject

Constructor Summary

Constructors

Constructor and Description
GeneratedJavaFile(CompilationUnit compilationUnit, String targetProject, JavaFormatter javaFormatter) Instantiates a new generated java file.
GeneratedJavaFile(CompilationUnit compilationUnit, String targetProject, String fileEncoding, JavaFormatter javaFormatter) Default constructor.

Method Summary

Modifier and Type	Method and Description
CompilationUnit	getCompilationUnit() This method is required by the Eclipse Java merger.
String	getFileEncoding() Gets the file encoding.
String	getFileName() Get the file name (without any path).
String	getFormattedContent() This method returns the entire contents of the generated file.
String	getTargetPackage() Get the target package for the file.
boolean	isMergeable() A Java file is mergeable if the getCompilationUnit() method returns a valid compilation unit.

Methods inherited from class org.mybatis.generator.api.GeneratedFile

getTargetProject, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

GeneratedJavaFile

public GeneratedJavaFile(CompilationUnit compilationUnit,
                         String targetProject,
                         String fileEncoding,
                         JavaFormatter javaFormatter)

Default constructor.

Parameters:

compilationUnit - the compilation unit

targetProject - the target project

fileEncoding - the file encoding

javaFormatter - the java formatter

GeneratedJavaFile

public GeneratedJavaFile(CompilationUnit compilationUnit,
                         String targetProject,
                         JavaFormatter javaFormatter)

Instantiates a new generated java file.

Parameters:

compilationUnit - the compilation unit

targetProject - the target project

javaFormatter - the java formatter

Method Detail

getFormattedContent

public String getFormattedContent()

Description copied from class: GeneratedFile

This method returns the entire contents of the generated file. Clients can simply save the value returned from this method as the file contents. Subclasses such as @see org.mybatis.generator.api.GeneratedJavaFile offer more fine grained access to file parts, but still implement this method in the event that the entire contents are desired.

Specified by:

getFormattedContent in class GeneratedFile

Returns:

Returns the content.

getFileName

public String getFileName()

Description copied from class: GeneratedFile

Get the file name (without any path). Clients should use this method to determine how to save the results.

Specified by:

getFileName in class GeneratedFile

Returns:

Returns the file name.

getTargetPackage

public String getTargetPackage()

Description copied from class: GeneratedFile

Get the target package for the file. Clients should use this method to determine how to save the results.

Specified by:

getTargetPackage in class GeneratedFile

Returns:

Returns the target project.

getCompilationUnit

public CompilationUnit getCompilationUnit()

This method is required by the Eclipse Java merger. If you are not running in Eclipse, or some other system that implements the Java merge function, you may return null from this method.

Returns:

the CompilationUnit associated with this file, or null if the file is not mergeable.

isMergeable

public boolean isMergeable()

A Java file is mergeable if the getCompilationUnit() method returns a valid compilation unit.

Specified by:

isMergeable in class GeneratedFile

Returns:

true, if is mergeable

getFileEncoding

public String getFileEncoding()

Gets the file encoding.

Returns:

the file encoding