|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.ibm.are.xml.rules.Rule
com.ibm.are.xml.rules.fileattr.FileAttributeRule
com.ibm.are.xml.rules.fileattr.FileEmptyRule
public class FileEmptyRule
Rule class that verifies if a file is empty
Field Summary | |
---|---|
static int |
ATTRIBUTE_ALWAYS_EMPTY
Internal class use only |
static int |
ATTRIBUTE_IGNORE
Internal class use only |
static int |
ATTRIBUTE_NEVER_EMPTY
Internal class use only |
static int |
ATTRIBUTE_SOMETIMES_EMPTY
Internal class use only |
static java.lang.String |
COPYRIGHT
Copyright for class bytecode |
Fields inherited from class com.ibm.are.xml.rules.fileattr.FileAttributeRule |
---|
MAP_ITEM_NAME |
Fields inherited from class com.ibm.are.xml.rules.Rule |
---|
MAP_ITEM_CHECK_CLASS, MAP_ITEM_CHECK_OBJECT, MAP_ITEM_CHECK_TYPE, MAP_ITEM_ERROR_LEVEL, MAP_ITEM_EXPECTED_VALUE, MAP_ITEM_MATCH_CASE |
Constructor Summary | |
---|---|
FileEmptyRule(java.util.Map ruleInfo)
The API constructor for this class. |
|
FileEmptyRule(com.ibm.are.xml.rules.XmlNodeInfo nodeInfo,
java.lang.String theFile,
java.lang.String empty)
This constructor is for internal class use only. |
Method Summary | |
---|---|
boolean |
run(com.ibm.are.plugin.Plugin plugin)
Runs the rule, which performs the check/verification implemented by that rule. |
Methods inherited from class com.ibm.are.xml.rules.Rule |
---|
getNodeInfo, report, report |
Methods inherited from class java.lang.Object |
---|
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
public static final java.lang.String COPYRIGHT
public static final int ATTRIBUTE_IGNORE
public static final int ATTRIBUTE_NEVER_EMPTY
public static final int ATTRIBUTE_SOMETIMES_EMPTY
public static final int ATTRIBUTE_ALWAYS_EMPTY
Constructor Detail |
---|
public FileEmptyRule(java.util.Map ruleInfo)
ruleInfo
- Any object that implements the java.util.Map
interface.
This map contains a set of key/value pairs which specify all of the
information needed by this rule class to perform its check.
Rule Info Map Contents
The table below describes all items, both required and optional, that are allowed to be
in the ruleInfo
map passed to the API constructor.
Key | Description | Required | Valid Values | Default Value |
---|---|---|---|---|
name | The full path of the file to verify | Yes | Path must be fully qualified | N/A |
empty | Whether or not the file is expected to be empty | Yes |
|
N/A |
errorLevel | Specifies the severity level a problem is reported at for this check. If the comparison between the
expected and actual values is not successful, which means the comparison result was false ,
a problem is reported. The severity of the reported problem is determined by the error level. |
No |
|
error |
public FileEmptyRule(com.ibm.are.xml.rules.XmlNodeInfo nodeInfo, java.lang.String theFile, java.lang.String empty)
Method Detail |
---|
public boolean run(com.ibm.are.plugin.Plugin plugin)
run
in class Rule
plugin
- The plugin for which the rule is being run for.
true
if the verification was successful and no problems were found.
false
if the verification resulted in a problem being found and reported.
|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |