public abstract class

GeneratedFile

extends Object
java.lang.Object
   ↳ org.mybatis.generator.api.GeneratedFile
Known Direct Subclasses

Class Overview

Abstract class that holds information common to all generated files.

Summary

Public Constructors
GeneratedFile(String targetProject)
Public Methods
abstract String getFileName()
Get the file name (without any path).
abstract String getFormattedContent()
This method returns the entire contents of the generated file.
abstract String getTargetPackage()
Get the target package for the file.
String getTargetProject()
Gets the target project.
abstract boolean isMergeable()
String toString()
[Expand]
Inherited Methods
From class java.lang.Object

Public Constructors

public GeneratedFile (String targetProject)

Public Methods

public abstract String getFileName ()

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

Returns
  • Returns the file name.

public abstract String getFormattedContent ()

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.

Returns
  • Returns the content.

public abstract String getTargetPackage ()

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

Returns
  • Returns the target project.

public String getTargetProject ()

Gets the target project. Clients can call this method to determine how to save the results.

Returns
  • the target project

public abstract boolean isMergeable ()

public String toString ()