com.fr.stable.script

类 FunctionDef

java.lang.Object

com.fr.stable.script.FunctionDef

所有已实现的接口:

FCloneable, FunctionDefineProvider, Level, XMLable, XMLReadable, XMLWriter, java.io.Serializable, java.lang.Cloneable

public class FunctionDef
extends java.lang.Object
implements FunctionDefineProvider, XMLable

函数定义的细节，包含了函数名和对于该函数使用的描述

另请参阅:

序列化表格

字段概要

字段

限定符和类型	字段和说明
static int	CURRENT_LEVEL
static java.lang.String	XML_TAG

从接口继承的字段 com.fr.stable.fun.FunctionDefineProvider

MARK_STRING

构造器概要

构造器

构造器和说明
FunctionDef() 默认的构造函数
FunctionDef(java.lang.String name, java.lang.String className)
FunctionDef(java.lang.String name, java.lang.String description, java.lang.String className)

方法概要

方法

限定符和类型	方法和说明
java.lang.Object	clone()
int	currentAPILevel() 当前接口的API等级,用于判断是否需要升级插件
boolean	equals(java.lang.Object obj)
java.lang.String	getClassName()
java.lang.String	getDescription()
java.lang.String	getName()
int	hashCode()
void	readXML(XMLableReader reader) 读取子节点，应该会被XMLableReader.readXMLObject()调用多次
void	setClassName(java.lang.String className) 设置函数的类名
void	setDescription(java.lang.String description) 设置对函数功能的描述
void	setName(java.lang.String name) 设置函数的名字
void	writeXML(XMLPrintWriter writer) Write XML.

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

finalize, getClass, notify, notifyAll, toString, wait, wait, wait

字段详细资料

XML_TAG

public static final java.lang.String XML_TAG

CURRENT_LEVEL

public static final int CURRENT_LEVEL

另请参阅:

常量字段值

构造器详细资料

FunctionDef

public FunctionDef()

默认的构造函数

FunctionDef

public FunctionDef(java.lang.String name,
           java.lang.String className)

参数:

name - 函数的名字

className - 函数的类名

FunctionDef

public FunctionDef(java.lang.String name,
           java.lang.String description,
           java.lang.String className)

参数:

name - 函数的名字

description - 函数的功能的描述

className - 函数的类名

方法详细资料

currentAPILevel

public int currentAPILevel()

从接口复制的说明: Level

当前接口的API等级,用于判断是否需要升级插件

指定者:

currentAPILevel 在接口中 Level

返回:

API等级

getName

public java.lang.String getName()

返回:

函数的名字

setName

public void setName(java.lang.String name)

设置函数的名字

getDescription

public java.lang.String getDescription()

返回:

函数功能的描述

setDescription

public void setDescription(java.lang.String description)

设置对函数功能的描述

getClassName

public java.lang.String getClassName()

返回:

函数的类名

setClassName

public void setClassName(java.lang.String className)

设置函数的类名

readXML

public void readXML(XMLableReader reader)

从接口复制的说明: XMLReadable

读取子节点，应该会被XMLableReader.readXMLObject()调用多次

指定者:

readXML 在接口中 XMLReadable

参数:

reader - XML读取对象

另请参阅:

XMLableReader

writeXML

public void writeXML(XMLPrintWriter writer)

从接口复制的说明: XMLWriter

Write XML.
The method will be invoked when save data to XML file.
May override the method to save your own data. 从性能上面考虑，大家用writer.print(), 而不是writer.println()

指定者:

writeXML 在接口中 XMLWriter

参数:

writer - XML写入对象

equals

public boolean equals(java.lang.Object obj)

覆盖:

equals 在类中 java.lang.Object

hashCode

public int hashCode()

覆盖:

hashCode 在类中 java.lang.Object

clone

public java.lang.Object clone()
                       throws java.lang.CloneNotSupportedException

指定者:

clone 在接口中 FCloneable

覆盖:

clone 在类中 java.lang.Object

返回:

克隆后的对象

抛出:

java.lang.CloneNotSupportedException - 如果克隆失败则抛出此异常