Examples of org.apache.commons.configuration2.AbstractHierarchicalConfiguration

Package org.apache.commons.configuration2

Examples of org.apache.commons.configuration2.AbstractHierarchicalConfiguration

org.apache.commons.configuration2.ex.ConversionException
A specialized configuration class that extends its base class by the ability of keeping more structure in the stored properties.

There are some sources of configuration data that cannot be stored very well in a {@code BaseConfiguration} object because then their structure is lost.This is for instance true for XML documents. This class can deal with such structured configuration sources by storing the properties in a tree-like organization. The exact storage structure of the underlying data does not matter for the configuration instance; it uses a {@link NodeModel} object foraccessing it.

The hierarchical organization allows for a more sophisticated access to single properties. As an example consider the following XML document:
```
 <database> <tables> <table> <name>users</name> <fields> <field> <name>lid</name> <type>long</name> </field> <field> <name>usrName</name> <type>java.lang.String</type> </field> ... </fields> </table> <table> <name>documents</name> <fields> <field> <name>docid</name> <type>long</type> </field> ... </fields> </table> ... </tables> </database> 
```
If this document is parsed and stored in a hierarchical configuration object (which can be done by one of the sub classes), there are enhanced possibilities of accessing properties. Per default, the keys for querying information can contain indices that select a specific element if there are multiple hits.

For instance the key {@code tables.table(0).name} can be used to find out thename of the first table. In opposite {@code tables.table.name} would return acollection with the names of all available tables. Similarly the key {@code tables.table(1).fields.field.name} returns a collection with the namesof all fields of the second table. If another index is added after the {@code field} element, a single field can be accessed:{@code tables.table(1).fields.field(0).name}.

There is a {@code getMaxIndex()} method that returns the maximum allowedindex that can be added to a given property key. This method can be used to iterate over all values defined for a certain property.

Since the 1.3 release of Commons Configuration hierarchical configurations support an expression engine. This expression engine is responsible for evaluating the passed in configuration keys and map them to the stored properties. The examples above are valid for the default expression engine, which is used when a new {@code AbstractHierarchicalConfiguration} instance is created. With the{@code setExpressionEngine()} method a different expression engine can beset. For instance with {@link org.apache.commons.configuration2.tree.xpath.XPathExpressionEngine}there is an expression engine available that supports configuration keys in XPATH syntax.

In addition to the events common for all configuration classes, hierarchical configurations support some more events that correspond to some specific methods and features. For those events specific event type constants in {@code ConfigurationEvent} exist:

ADD_NODES

The {@code addNodes()} method was called; the event object contains thekey, to which the nodes were added, and a collection with the new nodes as value.

CLEAR_TREE

The {@code clearTree()} method was called; the event object stores thekey of the removed sub tree.

SUBNODE_CHANGED

A {@code SubnodeConfiguration} that was created from this configurationhas been changed. The value property of the event object contains the original event object as it was sent by the subnode configuration.

Whether an {@code AbstractHierarchicalConfiguration} object is thread-safe ornot depends on the underlying {@code NodeModel} and the {@link Synchronizer}it is associated with. Some {@code NodeModel} implementations are inherentlythread-safe; they do not require a special {@code Synchronizer}. (Per default, a dummy {@code Synchronizer} is used which is not thread-safe!) Themethods for querying or updating configuration data invoke this {@code Synchronizer} accordingly. When accessing the configuration's rootnode directly, the client application is responsible for proper synchronization. This is achieved by calling the methods {@link #lock(LockMode)}, and {@link #unlock(LockMode)} with a proper{@link LockMode} argument. In any case, it is recommended to not access theroot node directly, but to use corresponding methods for querying or updating configuration data instead. Direct manipulations of a configuration's node structure circumvent many internal mechanisms and thus can cause undesired effects. For concrete subclasses dealing with specific node structures, this situation may be different.
@version $Id: AbstractHierarchicalConfiguration.java 1624601 2014-09-12 18:04:36Z oheger $ @since 2.0 @param < T> the type of the nodes managed by this hierarchical configuration

        {
            return Collections.singletonList((Object) value.toString());
        }
        else
        {
            throw new ConversionException('\'' + key + "' doesn't map to a List object: " + value + ", a "
                    + value.getClass().getName());
        }
        return list;
    }

View Full Code Here

                    defaultValue);
        }
        catch (ConversionException cex)
        {
            // improve error message
            throw new ConversionException(
                    String.format(
                            "Key '%s' cannot be converted to class %s. Value is: '%s'.",
                            key, cls.getName(), String.valueOf(value)));
        }
    }

View Full Code Here

        else if (InetAddress.class.isAssignableFrom(cls))
        {
            return toInetAddress(value);
        }


        throw new ConversionException("The value '" + value + "' (" + value.getClass() + ")"
                + " can't be converted to a " + cls.getName() + " object");
    }

View Full Code Here

        else if (value instanceof String)
        {
            Boolean b = BooleanUtils.toBooleanObject((String) value);
            if (b == null)
            {
                throw new ConversionException("The value " + value + " can't be converted to a Boolean object");
            }
            return b;
        }
        else
        {
            throw new ConversionException("The value " + value + " can't be converted to a Boolean object");
        }
    }

View Full Code Here

        {
            return Character.valueOf(strValue.charAt(0));
        }
        else
        {
            throw new ConversionException(
                    String.format(
                            "The value '%s' cannot be converted to a Character object!",
                            strValue));
        }
    }

View Full Code Here

                {
                    return new BigInteger(str.substring(HEX_PREFIX.length()), HEX_RADIX);
                }
                catch (NumberFormatException nex)
                {
                    throw new ConversionException("Could not convert " + str
                            + " to " + targetClass.getName()
                            + "! Invalid hex number.", nex);
                }
            }


            if (str.startsWith(BIN_PREFIX))
            {
                try
                {
                    return new BigInteger(str.substring(BIN_PREFIX.length()), BIN_RADIX);
                }
                catch (NumberFormatException nex)
                {
                    throw new ConversionException("Could not convert " + str
                            + " to " + targetClass.getName()
                            + "! Invalid binary number.", nex);
                }
            }


            try
            {
                Constructor<?> constr = targetClass.getConstructor(CONSTR_ARGS);
                return (Number) constr.newInstance(new Object[]{str});
            }
            catch (InvocationTargetException itex)
            {
                throw new ConversionException("Could not convert " + str
                        + " to " + targetClass.getName(), itex
                        .getTargetException());
            }
            catch (Exception ex)
            {
                // Treat all possible exceptions the same way
                throw new ConversionException(
                        "Conversion error when trying to convert " + str
                                + " to " + targetClass.getName(), ex);
            }
        }
    }

View Full Code Here

            {
                return new URL((String) value);
            }
            catch (MalformedURLException e)
            {
                throw new ConversionException("The value " + value + " can't be converted to an URL", e);
            }
        }
        else
        {
            throw new ConversionException("The value " + value + " can't be converted to an URL");
        }
    }

View Full Code Here


                return new Locale(language, country, variant);
            }
            else
            {
                throw new ConversionException("The value " + value + " can't be converted to a Locale");
            }
        }
        else
        {
            throw new ConversionException("The value " + value + " can't be converted to a Locale");
        }
    }

View Full Code Here


            // check the size of the string
            int minlength = components.length * 2;
            if (color.length() < minlength)
            {
                throw new ConversionException("The value " + value + " can't be converted to a Color");
            }


            // remove the leading #
            if (color.startsWith("#"))
            {
                color = color.substring(1);
            }


            try
            {
                // parse the components
                for (int i = 0; i < components.length; i++)
                {
                    components[i] = Integer.parseInt(color.substring(2 * i, 2 * i + 2), HEX_RADIX);
                }


                // parse the transparency
                int alpha;
                if (color.length() >= minlength + 2)
                {
                    alpha = Integer.parseInt(color.substring(minlength, minlength + 2), HEX_RADIX);
                }
                else
                {
                    alpha = Color.black.getAlpha();
                }


                return new Color(components[0], components[1], components[2], alpha);
            }
            catch (Exception e)
            {
                throw new ConversionException("The value " + value + " can't be converted to a Color", e);
            }
        }
        else
        {
            throw new ConversionException("The value " + value + " can't be converted to a Color");
        }
    }

View Full Code Here

            {
                return InetAddress.getByName((String) value);
            }
            catch (UnknownHostException e)
            {
                throw new ConversionException("The value " + value + " can't be converted to a InetAddress", e);
            }
        }
        else
        {
            throw new ConversionException("The value " + value + " can't be converted to a InetAddress");
        }
    }

View Full Code Here

0 1 2 3 4 5 6 7 8 9

TOP

Related Classes of org.apache.commons.configuration2.AbstractHierarchicalConfiguration

com.mockobjects.servlet.MockHttpServletRequest

com.mockobjects.servlet.MockServletConfig

org.apache.commons.beanutils.DynaProperty

org.apache.commons.configuration2.AbstractConfiguration

org.apache.commons.configuration2.BaseConfiguration

org.apache.commons.configuration2.BaseHierarchicalConfiguration

org.apache.commons.configuration2.BaseHierarchicalConfiguration$BuilderVisitor

org.apache.commons.configuration2.beanutils.BeanHelper

org.apache.commons.configuration2.beanutils.ConfigurationDynaBean

org.apache.commons.configuration2.beanutils.XMLBeanDeclaration

All source code are property of their respective owners. Java is a trademark of Sun Microsystems, Inc and owned by ORACLE Inc. Contact coftware#gmail.com.