Top Description Fields Constructors Methods
org.hsqldb.cmdline.libclone

public Class ValidatingResourceBundle

extends Object
Class Inheritance
Imports
java.util.Enumeration, .HashSet, .Set

Purpose of this class is to wrap a RefCapablePropertyResourceBundle to reliably detect any possible use of a missing property key as soon as this class is clinitted. The reason for this is to allow us developers to detect all such errors before end-users ever use this class. See SqltoolRB for an example implementation of this abstract class.

Field Summary

Modifier and TypeField and Description
public static final int
protected Class<? extends Enum<?>>
private int
private int
public static final int
public static final int
protected boolean
protected RefCapablePropertyResourceBundle

Constructor Summary

AccessConstructor and Description
public
ValidatingResourceBundle(String baseName, Class<? extends Enum<?>> enumType)

Method Summary

Modifier and TypeMethod and Description
public String
getExpandedString(Enum<?>
Enum
key
)

Returns: String

public String
getExpandedString(Enum<?>
Enum
key
,
String...
String[]
strings
)

Returns: String

public int
public int
public String
getString(Enum<?>
Enum
key
)

Returns: String

public String
getString(Enum<?>
Enum
key
,
String...
String[]
strings
)

Returns: String

public String
getString(Enum<?> key, int i1)

public String
getString(Enum<?> key, int i1, int i2)

public String
getString(Enum<?> key, int i1, int i2, int i3)

public String
getString(Enum<?> key, int i1, String s2)

public String
getString(Enum<?> key, String s1, int i2)

public String
getString(Enum<?> key, int i1, int i2, String s3)

public String
getString(Enum<?> key, int i1, String s2, int i3)

public String
getString(Enum<?> key, String s1, int i2, int i3)

public String
getString(Enum<?> key, int i1, String s2, String s3)

public String
getString(Enum<?> key, String s1, String s2, int i3)

public String
getString(Enum<?> key, String s1, int i2, String s3)

public static String
resourceKeyFor(Enum<?> enumKey)

public void
setMissingPosValueBehavior(int
int
missingPosValueBehavior
)

Set behavior for get*String(String, String[]) method when a positional index (like %{4}) is used but no subs value was given for that index.

public void
setMissingPropertyBehavior(int
int
missingPropertyBehavior
)

Set behavior for get*String*() method when a referred-to System Property is not set.

public void
Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAlltoStringwaitwaitwait

Field Detail

EMPTYSTRING_BEHAVIORback to summary
public static final int EMPTYSTRING_BEHAVIOR
enumTypeback to summary
protected Class<? extends Enum<?>> enumType
missingPosValueBehaviorback to summary
private int missingPosValueBehavior
missingPropertyBehaviorback to summary
private int missingPropertyBehavior
NOOP_BEHAVIORback to summary
public static final int NOOP_BEHAVIOR
THROW_BEHAVIORback to summary
public static final int THROW_BEHAVIOR
validatedback to summary
protected boolean validated
wrappedRCPRBback to summary
protected RefCapablePropertyResourceBundle wrappedRCPRB

Constructor Detail

ValidatingResourceBundleback to summary
public ValidatingResourceBundle(String baseName, Class<? extends Enum<?>> enumType)

Method Detail

getExpandedStringback to summary
public String getExpandedString(Enum<?> key)
Parameters
key:Enum<?>

Enum

Returns:String

String

See Also
RefCapablePropertyResourceBundle#getExpandedString(String, int)
getExpandedStringback to summary
public String getExpandedString(Enum<?> key, String... strings)
Parameters
key:Enum<?>

Enum

strings:String[]

String[]

Returns:String

String

See Also
RefCapablePropertyResourceBundle#getExpandedString(String, String[], int, int)
getMissingPosValueBehaviorback to summary
public int getMissingPosValueBehavior()
getMissingPropertyBehaviorback to summary
public int getMissingPropertyBehavior()
getStringback to summary
public String getString(Enum<?> key)
Parameters
key:Enum<?>

Enum

Returns:String

String

See Also
RefCapablePropertyResourceBundle#getString(String)
getStringback to summary
public String getString(Enum<?> key, String... strings)
Parameters
key:Enum<?>

Enum

strings:String[]

String[]

Returns:String

String

See Also
RefCapablePropertyResourceBundle#getString(String, String[], int)
getStringback to summary
public String getString(Enum<?> key, int i1)
getStringback to summary
public String getString(Enum<?> key, int i1, int i2)
getStringback to summary
public String getString(Enum<?> key, int i1, int i2, int i3)
getStringback to summary
public String getString(Enum<?> key, int i1, String s2)
getStringback to summary
public String getString(Enum<?> key, String s1, int i2)
getStringback to summary
public String getString(Enum<?> key, int i1, int i2, String s3)
getStringback to summary
public String getString(Enum<?> key, int i1, String s2, int i3)
getStringback to summary
public String getString(Enum<?> key, String s1, int i2, int i3)
getStringback to summary
public String getString(Enum<?> key, int i1, String s2, String s3)
getStringback to summary
public String getString(Enum<?> key, String s1, String s2, int i3)
getStringback to summary
public String getString(Enum<?> key, String s1, int i2, String s3)
resourceKeyForback to summary
public static String resourceKeyFor(Enum<?> enumKey)
setMissingPosValueBehaviorback to summary
public void setMissingPosValueBehavior(int missingPosValueBehavior)

Set behavior for get*String(String, String[]) method when a positional index (like %{4}) is used but no subs value was given for that index. Set to one of

  • RefCapablePropertyResourceBundle.THROW_BEHAVIOR
  • RefCapablePropertyResourceBundle.EMPTYSTRING_BEHAVIOR
  • RefCapablePropertyResourceBundle.NOOP_BEHAVIOR
The first value is the default.
Parameters
missingPosValueBehavior:int

int

setMissingPropertyBehaviorback to summary
public void setMissingPropertyBehavior(int missingPropertyBehavior)

Set behavior for get*String*() method when a referred-to System Property is not set. Set to one of

  • RefCapablePropertyResourceBundle.THROW_BEHAVIOR
  • RefCapablePropertyResourceBundle.EMPTYSTRING_BEHAVIOR
  • RefCapablePropertyResourceBundle.NOOP_BEHAVIOR
The first value is the default.
Parameters
missingPropertyBehavior:int

int

validateback to summary
public void validate()