xbn.config
Interface CRFilter

public interface CRFilter

A class implementing CRFilter declares that only certain variables will be accepted by ConfigReader. See ConfigReader.getVWObject.

Source code: CRFilter.java.

Example implementation parts

//Required by xbn.config.CRFilter...START
/**
@return ???
**/
public String getAcceptableVarName(String s_nameFromSourceText) {
return ???
}
/**
@return ???
**/
public boolean wereAllVarsFound() {
return ???
}
/**
@return ???
**/
public boolean doCrashIfUnacceptable() {
return ???
}
//Required by xbn.config.CRFilter...END

Method Summary

boolean	doCrashIfUnacceptable() If an unacceptable variable exists in the source text, should a crash occur?
String	getAcceptableVarName(String s_nameFromSourceText) If the provided variable name is acceptable, what should the new name be?
boolean	wereAllVarsFound() Have all variables been found?

Method Detail

getAcceptableVarName

public String getAcceptableVarName(String s_nameFromSourceText)

If the provided variable name is acceptable, what should the new name be?

Parameters:

s_nameFromSourceText - The name of the variable as it actually exists in the source text. May not be null.

Returns:

null If the variable name should not be accepted.
A StringBuffer If this variable is acceptable, this is the new name to assign to the variable.

wereAllVarsFound

public boolean wereAllVarsFound()

Have all variables been found?

Returns:

true If all variables have been found.
false If some variables have yet to be found, or this filter can potentially/theoritically accept an infinite number of variables.

doCrashIfUnacceptable

public boolean doCrashIfUnacceptable()

If an unacceptable variable exists in the source text, should a crash occur?

Returns:

true If, when an unacceptable variable is found, an AssertException should be thrown.
false If the unacceptable variable should be ignored. No error occurs.