org.rhq.enterprise.communications.util.prefs

Interface SetupValidityChecker

All Known Implementing Classes:

BooleanSetupValidityChecker, FloatSetupValidityChecker, InetAddressSetupValidityChecker, IntegerSetupValidityChecker, LongSetupValidityChecker, RegexSetupValidityChecker, RemotingLocatorUriParamsValidityChecker, RemotingLocatorUriValidityChecker, UrlSetupValidityChecker

public interface SetupValidityChecker

This interface defines an object that will check the validity of a preference value. These are used during the construction of SetupInstruction objects.

Author:

John Mazzitelli

Method Summary

Methods

Modifier and Type	Method and Description
boolean	checkValidity(String pref_name, String value_to_check, Preferences preferences, PrintWriter out) This will check the validity of the given value.

Method Detail

checkValidity

boolean checkValidity(String pref_name,
                    String value_to_check,
                    Preferences preferences,
                    PrintWriter out)

This will check the validity of the given value. The name of the preference to be checked is also provided, though implementations probably will not need that in most cases. In addition, the full set of preferences currently set are also passed in, in case the validity checker needs to examine other preference values to determine the validity of this value to check.

Parameters:

pref_name - the name of the preference being checked

value_to_check - the value to check

preferences - the full set of preferences

out - an output stream this instruction can use to print out any error messages that it deems appropriate

Returns:

true if value_to_check is valid; false otherwise