com.mbap.util.freemarker

Enum FreeMarkerUtilFactory

java.lang.Object

java.lang.Enum<FreeMarkerUtilFactory>

com.mbap.util.freemarker.FreeMarkerUtilFactory

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<FreeMarkerUtilFactory>

public enum FreeMarkerUtilFactory
extends java.lang.Enum<FreeMarkerUtilFactory>

FreeMarker工具类工厂

Author:

BW.Panda Dec 8, 2016

Enum Constant Summary

Enum Constants

Enum Constant and Description
INSTANCE

Method Summary

Modifier and Type	Method and Description
FreeMarkerUtil	getUtil4Class(java.lang.Class<?> resourceLoaderClass, java.lang.String basePackagePath) 创建一个模板加载器，将使用指定的 Class.getResource(String) 方法类加载资源，以及指定的基础包路径（绝对或相对）。
FreeMarkerUtil	getUtil4File(java.lang.String baseDir) 创建将使用指定的目录作为基本目录的新文件模板加载器加载模板。 基本目录之外的模板不进行加载
static FreeMarkerUtilFactory	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static FreeMarkerUtilFactory[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

INSTANCE

public static final FreeMarkerUtilFactory INSTANCE

Method Detail

values

public static FreeMarkerUtilFactory[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (FreeMarkerUtilFactory c : FreeMarkerUtilFactory.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static FreeMarkerUtilFactory valueOf(java.lang.String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

java.lang.IllegalArgumentException - if this enum type has no constant with the specified name

java.lang.NullPointerException - if the argument is null

getUtil4File

public FreeMarkerUtil getUtil4File(java.lang.String baseDir)
                            throws java.io.IOException

创建将使用指定的目录作为基本目录的新文件模板加载器加载模板。 基本目录之外的模板不进行加载

Parameters:

baseDir - 用于加载模板的基本目录 如： c:/templates

Returns:

FreeMarkerUtilImpl

Throws:

java.io.IOException

getUtil4Class

public FreeMarkerUtil getUtil4Class(java.lang.Class<?> resourceLoaderClass,
                                    java.lang.String basePackagePath)

创建一个模板加载器，将使用指定的 Class.getResource(String) 方法类加载资源，以及指定的基础包路径（绝对或相对）。

例子：

• 相对基本路径（将从 com.example.myapplication.templates 软件包加载）： getUtil4Class(com.example.myapplication.SomeClass.class, "templates")
• 绝对基本路径 getUtil4Class(somepackage.SomeClass.class, "/com/example/myapplication/templates")

Parameters:

resourceLoaderClass - 将使用Class.getResource(String)方法加载模板的类。 请确定基于当前类可以找到模板。 此参数不能为 null。

basePackagePath - 包含模板的包所在路径， （/ - 分隔）格式。 如果它不是以/开头 它相对于路径（包） resourceLoaderClass类。 如果它以/ 然后它相对于包层次结构的根。 注意 路径组件应该用正斜线分隔。 此参数不能为 null。

Returns:

FreeMarkerUtilImpl

Throws:

java.io.IOException