org.mybatis.generator.api

Class GeneratedXmlFile

java.lang.Object

org.mybatis.generator.api.GeneratedFile

org.mybatis.generator.api.GeneratedXmlFile

public class GeneratedXmlFile
extends GeneratedFile

The Class GeneratedXmlFile.

Author:

Jeff Butler

Field Summary

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

targetProject

Constructor Summary

Constructors

Constructor and Description
GeneratedXmlFile(Document document, String fileName, String targetPackage, String targetProject, boolean isMergeable, XmlFormatter xmlFormatter) Instantiates a new generated xml file.

Method Summary

Modifier and Type	Method and Description
String	getFileName() Gets the file name.
String	getFormattedContent() This method returns the entire contents of the generated file.
String	getTargetPackage() Gets the target package.
boolean	isMergeable() Checks if is mergeable.

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

GeneratedXmlFile

public GeneratedXmlFile(Document document,
                        String fileName,
                        String targetPackage,
                        String targetProject,
                        boolean isMergeable,
                        XmlFormatter xmlFormatter)

Instantiates a new generated xml file.

Parameters:

document - the document

fileName - the file name

targetPackage - the target package

targetProject - the target project

isMergeable - true if the file can be merged by the built in XML file merger.

xmlFormatter - the xml 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()

Gets the file name.

Specified by:

getFileName in class GeneratedFile

Returns:

Returns the fileName.

getTargetPackage

public String getTargetPackage()

Gets the target package.

Specified by:

getTargetPackage in class GeneratedFile

Returns:

Returns the targetPackage.

isMergeable

public boolean isMergeable()

Description copied from class: GeneratedFile

Checks if is mergeable.

Specified by:

isMergeable in class GeneratedFile

Returns:

true, if is mergeable