/*
XBN Java: Generically useful, non-GUI Java code.
http://sourceforge.net/projects/xbnjava
Copyright (C) 1997-2003, Jeff Epstein
All rights reserved.
Modifications: No
Redistribution in binary form, with or without modifications, are permitted provided that the following conditions are met:
* Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.
* If modifications are made to source code then this license should indicate that fact in the "Modifications" section above.
* Neither the author, nor the contributors may be used to endorse or promote products derived from this software without specific prior written permission.
THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
[NOTE: This license contains NO advertising clause.]
*/
package xbn.config;
/**
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
@version 0.9b
@author Jeff Epstein, http://sourceforge.net/projects/xbnjava.
**/
public interface CRFilter {
/**
If the provided variable name is acceptable, what should the new name be?
@param s_nameFromSourceText The name of the variable as it actually exists in the source text. May not be null.
@return 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.
**/
String getAcceptableVarName(String s_nameFromSourceText);
/**
Have all variables been found?
@return 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.
**/
boolean wereAllVarsFound();
/**
If an unacceptable variable exists in the source text, should a crash occur?
@return true If, when an unacceptable variable is found, an AssertException should be thrown.
false If the unacceptable variable should be ignored. No error occurs.
**/
boolean doCrashIfUnacceptable();
}