com.supermap.data
类 LogFile

java.lang.Object
  com.supermap.data.LogFile

public class LogFile
extends java.lang.Object

日志文件管理类。

用于对日志文件的管理，包括定义日志的记录级别，日志文件存储的目录，日志文件存储的最大值，以及日志分文件存储的时间间隔。对于日志的记录级别有两种，不同的记录级别所记录的日志内容不同，级别越高记录的信息越多。

日志文件如何分文件存储取决于日志文件存储的最大值和日志分文件存储的时间间隔，即：在达到了时间间隔限制时，系统会生成一个新的日志文件记录日志，如果文件未达到时间间隔限制,但是已经达到了日志文件大小的限制,此时也会生成一个新的日志文件。

方法摘要

void	close() 已过时。 调用该方法关闭日志文件。
java.lang.String	getFolder() 已过时。 返回日志文件的存储目录。默认目录为应用程序下的 Log 目录。时间间隔为非 None 时，日志文件名按照："Log"+"_进程id"+"_起始时间点"的方式命名；时间间隔为 None 时，日志文件名按照："Log"+"_进程id"的方式命名。如果达到文件规定的最大值，则+"#1/2/3"。
LogLevel	getLevel() 返回日志记录级别。
int	getMaxSize() 返回日志文件大小的最大值。
LogTimeInterval	getTimeInterval() 已过时。 返回日志分文件存储间隔。有五种存储方法：不分文件存储；每小时一个日志文件进行存储；每天一个日志文件进行存储；每星期一个日志文件进行存储；每月一个日志文件进行存储。
static boolean	isFilter() 返回日志是否自动过滤重复内容。
boolean	open() 已过时。 调用该方法打开日志文件。 注意：调用 open 方法时会清空之前的设置，所以利用该方法打开日志文件时，应该先调用 open 方法，然后再设置相关参数。
static void	setFilter(boolean isFilter) 设置日志是否自动过滤重复内容，true，表示过滤重复内容，即连续出现相同的日志内容会被过滤掉；false表示不过滤。
void	setFolder(java.lang.String value) 已过时。 设置日志文件的存储目录。默认目录为应用程序下的 Log 目录。时间间隔为非 None 时，日志文件名按照："Log"+"_进程id"+"_起始时间点"的方式命名；时间间隔为 None 时，日志文件名按照："Log"+"_进程id"的方式命名。如果达到文件规定的最大值，则+"#1/2/3"。
void	setLevel(LogLevel value) 设置日志记录级别。
void	setMaxSize(int value) 设置日志文件大小的最大值。
void	setTimeInterval(LogTimeInterval value) 已过时。 设置日志分文件存储间隔。有五种存储方法：不分文件存储；每小时一个日志文件进行存储；每天一个日志文件进行存储；每星期一个日志文件进行存储；每月一个日志文件进行存储。

从类 java.lang.Object 继承的方法

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

方法详细信息

getLevel

public LogLevel getLevel()

返回日志记录级别。

日志记录级别从低到高依次为 ERROR、DEBUG 两个级别。记录级别高的日志包含低级别日志的信息，例如级别为 DEBUG 时，将同时记录 ERROR 所包含的信息。系统默认日志记录级别为 DEBUG。日志记录级别详细信息，请参考 LogLevel 类。

返回：

日志记录级别。

另请参见：

LogLevel

默认值:

默认日志级别为 DEBUG。

setLevel

public void setLevel(LogLevel value)

设置日志记录级别。

日志记录级别从低到高依次为 ERROR、DEBUG 两个级别。记录级别高的日志包含低级别日志的信息，例如级别为 DEBUG 时，将同时记录 ERROR 所包含的信息。系统默认日志记录级别为 DEBUG。日志记录级别详细信息，请参考 LogLevel 类。

参数：

value - 日志记录级别。

另请参见：

LogLevel

示例:

请参见 LogFile.open() 方法的示例。

getFolder

public java.lang.String getFolder()

已过时。 返回日志文件的存储目录。默认目录为应用程序下的 Log 目录。时间间隔为非 None 时，日志文件名按照："Log"+"_进程id"+"_起始时间点"的方式命名；时间间隔为 None 时，日志文件名按照："Log"+"_进程id"的方式命名。如果达到文件规定的最大值，则+"#1/2/3"。

返回：

日志文件的存储目录。

默认值:

默认值为一个空字符串。

setFolder

public void setFolder(java.lang.String value)

已过时。 设置日志文件的存储目录。默认目录为应用程序下的 Log 目录。时间间隔为非 None 时，日志文件名按照："Log"+"_进程id"+"_起始时间点"的方式命名；时间间隔为 None 时，日志文件名按照："Log"+"_进程id"的方式命名。如果达到文件规定的最大值，则+"#1/2/3"。

参数：

value - 日志文件的存储目录。

示例:

请参见 LogFile.open() 方法的示例。

getMaxSize

public int getMaxSize()

返回日志文件大小的最大值。如果达到这个值，将新生成一个日志文件进行存储。单位：字节。系统默认值为-1，即对日志文件大小不设限制。

返回：

日志文件大小的最大值。

默认值:

默认值为 -1。

setMaxSize

public void setMaxSize(int value)

设置日志文件大小的最大值。如果达到这个值，将新生成一个日志文件进行存储。单位：字节。系统默认值为-1，即对日志文件大小不设限制。

参数：

value - 日志文件大小的最大值。

示例:

请参见 LogFile.open() 方法的示例。

getTimeInterval

public LogTimeInterval getTimeInterval()

已过时。 返回日志分文件存储间隔。有五种存储方法：不分文件存储；每小时一个日志文件进行存储；每天一个日志文件进行存储；每星期一个日志文件进行存储；每月一个日志文件进行存储。

返回：

日志分文件存储间隔。

默认值:

默认值为 NONE。

setTimeInterval

public void setTimeInterval(LogTimeInterval value)

已过时。 设置日志分文件存储间隔。有五种存储方法：不分文件存储；每小时一个日志文件进行存储；每天一个日志文件进行存储；每星期一个日志文件进行存储；每月一个日志文件进行存储。

参数：

value - 日志分文件存储间隔。

示例:

请参见 LogFile.open() 方法的示例。

open

public boolean open()

已过时。 调用该方法打开日志文件。

注意：调用 open 方法时会清空之前的设置，所以利用该方法打开日志文件时，应该先调用 open 方法，然后再设置相关参数。

返回：

成功打开返回 true；否则返回 false。

示例:

以下代码示范对日志文件的设置。

 public void openTest(){
        // 打开日志文件，设置日志文件的存储目录，日志文件级别等一系列参数
        LogFile.open();
        LogFile.setFolder("G:\\Log");
        LogFile.setLevel(LogLevel.ERROR);
        LogFile.setMaxSize(1024);
        LogFile.setTimeInterval(LogTimeInterval.HOUR);

        // 关闭日志文件
        LogFile.close();
    }
 

close

public void close()

已过时。 调用该方法关闭日志文件。

另请参见：

open()

示例:

请参见 LogFile.open() 方法的示例。

isFilter

public static boolean isFilter()

返回日志是否自动过滤重复内容。默认为false，表示不过滤；true，表示过滤重复内容，即连续出现相同的日志内容会被过滤掉。

返回：

返回日志是否自动过滤重复内容。默认为false，表示不过滤。

setFilter

public static void setFilter(boolean isFilter)

设置日志是否自动过滤重复内容，true，表示过滤重复内容，即连续出现相同的日志内容会被过滤掉；false表示不过滤。

参数：

isFilter - 一个布尔值，指示是否自动过滤重复内容，true，表示过滤重复内容；false表示不过滤。