org.clapper.util.text
Interface VariableNameChecker

All Known Implementing Classes:

AbstractVariableSubstituter, Configuration, UnixShellVariableSubstituter, WindowsCmdVariableSubstituter

public interface VariableNameChecker

This interface defines the methods for a class that checks characters to determine whether they're legal for a variable name that's to be substituted by a VariableSubstituter object. It has a single method, legalVariableCharacter(char), which determines whether a specified character is a legal part of a variable name or not. This capability provides additional flexibility by allowing callers to define precisely what characters constitute legal variable names.

Version:

$Revision: 6735 $

Author:

Copyright © 2004-2007 Brian M. Clapper

See Also:

VariableSubstituter, VariableDereferencer

Method Summary

boolean

legalVariableCharacter(char c) Determine whether a character may legally be used in a variable name or not.

Method Detail

legalVariableCharacter

boolean legalVariableCharacter(char c)

Determine whether a character may legally be used in a variable name or not.

Parameters:

c - The character to test

Returns:

true if the character may be part of a variable name, false otherwise

See Also:

VariableSubstituter.substitute(java.lang.String, org.clapper.util.text.VariableDereferencer, java.lang.Object)