Also see:

getLocale

 public static String get(String name) throws IllegalArgumentException 
{
        return getInstance().getImpl(name);
}

Provides a setting value as a String.

The method will throw an IllegalArgumentException if an error occurs while retrieveing the property or if the property doesn't exist.

 public String getImpl(String name) throws IllegalArgumentException 
{
        return null;
}

Implements the #get(String) method.

 public static Settings getInstance() 
{
        return (settingsImpl == null) ? getDefaultInstance() : settingsImpl;
}

Provides the Settings object.

This method will substitute the default instance if another instance is not registered.

 public static Locale getLocale() 
{
        if (locale == null) {
            try {
                StringTokenizer localeTokens = new StringTokenizer(get(StrutsConstants.STRUTS_LOCALE), "_");
                String lang = null;
                String country = null;
                if (localeTokens.hasMoreTokens()) {
                    lang = localeTokens.nextToken();
                }
                if (localeTokens.hasMoreTokens()) {
                    country = localeTokens.nextToken();
                }
                locale = new Locale(lang, country);
            } catch (Throwable t) {
                // Default
                LOG.warn("Settings: Could not parse struts.locale setting, substituting default VM locale");
                locale = Locale.getDefault();
            }
        }
        return locale;
}

Provides the Struts default locale.

This method utilizes the struts.locale setting, which should be given as the Java toString() representation of a Locale object ("en", "de_DE", "_GB", "en_US_WIN", "de__POSIX", "fr_MAC", and so forth).

If a struts.locale setting is not registered, then the default virtual machine locale is substituted and cached.

 public static Location getLocation(String name) throws IllegalArgumentException 
{
        return getInstance().getLocationImpl(name);
}

Provides the Location of a setting.

The Location is utilized as part of precise error reporting.

This method will throw an IllegalArgumentException if an error occurs while retrieving the value or if the setting doesn't exist.

 public Location getLocationImpl(String name) throws IllegalArgumentException 
{
        return null;
}

Implements the #getLocation(String) method.

 public static boolean isSet(String name) 
{
        return getInstance().isSetImpl(name);
}

Determines whether or not a setting has a registered value.

This method is useful for testing for the existance of setting without throwing an IllegalArgumentException.

 public boolean isSetImpl(String name) 
{
        // this is dumb.. maybe it should just throw an unsupported op like the rest of the *Impl
        // methods in this class.
        return false;
}

Implements the #isSet(String) method.

 public static Iterator list() 
{
        return getInstance().listImpl();
}

Provides an Iterator of all properties names.

 public Iterator listImpl() 
{
        throw new UnsupportedOperationException("Settings: This implementation does not support listing the registered settings");
}

Implements the #list() method.

 public static  void reset() 
{
        defaultImpl = null;
        settingsImpl = null;
}

Resets the default and any plugin Setting instance to null.

 public static  void set(String name,
    String value) throws IllegalArgumentException, UnsupportedOperationException 
{
        getInstance().setImpl(name, value);
}

Registers a value for a setting.

This method raises an exception if an error occurs when setting the value or if the settings implementation does not support setting values.

 public  void setImpl(String name,
    String value) throws IllegalArgumentException, UnsupportedOperationException 
{
        throw new UnsupportedOperationException("Settings: This implementation does not support setting a value.");
}

Implements the #set(String, String) method.

 public static  void setInstance(Settings config) throws IllegalStateException 
{
                                            
        settingsImpl = config;
        locale = null;
}

Registers a custom Settings implementation (plugin), and resets the cached locale.

This method can only be called once.