Examples of org.apache.commons.configuration2.PropertiesConfigurationLayout

Package org.apache.commons.configuration2

Examples of org.apache.commons.configuration2.PropertiesConfigurationLayout

org.apache.commons.configuration2.sync.Synchronizer
A helper class used by {@link PropertiesConfiguration} to keepthe layout of a properties file.

Instances of this class are associated with a {@code PropertiesConfiguration} object. They are responsible foranalyzing properties files and for extracting as much information about the file layout (e.g. empty lines, comments) as possible. When the properties file is written back again it should be close to the original.

The {@code PropertiesConfigurationLayout} object associated with a{@code PropertiesConfiguration} object can be obtained using the{@code getLayout()} method of the configuration. Then the methodsprovided by this class can be used to alter the properties file's layout.

Implementation note: This is a very simple implementation, which is far away from being perfect, i.e. the original layout of a properties file won't be reproduced in all cases. One limitation is that comments for multi-valued property keys are concatenated. Maybe this implementation can later be improved.

To get an impression how this class works consider the following properties file:
```
 # A demo configuration file # for Demo App 1.42 # Application name AppName=Demo App # Application vendor AppVendor=DemoSoft # GUI properties # Window Color windowColors=0xFFFFFF,0x000000 # Include some setting include=settings.properties # Another vendor AppVendor=TestSoft 
```
For this example the following points are relevant:
- The first two lines are set as header comment. The header comment is determined by the last blanc line before the first property definition.
- For the property {@code AppName} one comment line and oneleading blanc line is stored.
- For the property {@code windowColors} two comment lines and twoleading blanc lines are stored.
- Include files is something this class cannot deal with well. When saving the properties configuration back, the included properties are simply contained in the original file. The comment before the include property is skipped.
- For all properties except for {@code AppVendor} the "singleline" flag is set. This is relevant only for {@code windowColors}, which has multiple values defined in one line using the separator character.
- The {@code AppVendor} property appears twice. The comment linesare concatenated, so that {@code layout.getComment("AppVendor");} willresult in Application vendor<CR>Another vendor, with <CR> meaning the line separator. In addition the "single line" flag is set to false for this property. When the file is saved, two property definitions will be written (in series).
@version $Id: PropertiesConfigurationLayout.java 1624601 2014-09-12 18:04:36Z oheger $ @since 1.3

    @Before
    public void setUp() throws Exception
    {
        XMLConfiguration c = new XMLConfiguration();
        testFile = ConfigurationAssert.getTestFile("test.xml");
        new FileHandler(c).load(testFile);
        sync = new SynchronizerTestImpl();
        c.setSynchronizer(sync);
        config = c;
    }

View Full Code Here

        {
            throw new ConfigurationException("Cannot resolve include file "
                    + fileName);
        }


        FileHandler fh = new FileHandler(this);
        fh.load(url);
    }

View Full Code Here


    @Test
    public void testEquals() throws Exception
    {
        PropertiesConfiguration conf = new PropertiesConfiguration();
        FileHandler handler = new FileHandler(conf);
        handler.setFileName(testProperties);
        handler.load();


        String equals = conf.getString("test.equals");
        assertEquals("value=one", equals);
    }

View Full Code Here

    public void testSetSystemPropertiesFromPropertiesFile()
            throws ConfigurationException, IOException
    {
        File file = folder.newFile("sys.properties");
        PropertiesConfiguration pconfig = new PropertiesConfiguration();
        FileHandler handler = new FileHandler(pconfig);
        pconfig.addProperty("fromFile", Boolean.TRUE);
        handler.setFile(file);
        handler.save();
        SystemConfiguration.setSystemProperties(handler.getBasePath(),
                handler.getFileName());
        SystemConfiguration sconf = new SystemConfiguration();
        assertTrue("Property from file not found", sconf.getBoolean("fromFile"));
    }

View Full Code Here

        XMLConfiguration x3 = new XMLConfiguration(config);
        assertEquals("Wrong element value", "value2.2", x3.getString("key2"));
        assertEquals("Wrong attribute value", "USER2",
                x3.getString("key2[@override]"));
        StringWriter w = new StringWriter();
        new FileHandler(x3).save(w);
        String s = w.toString();
        x3 = new XMLConfiguration();
        new FileHandler(x3).load(new StringReader(s));
        assertEquals("Wrong element value after load", "value2.2",
                x3.getString("key2"));
        assertEquals("Wrong attribute value after load", "USER2",
                x3.getString("key2[@override]"));
    }

View Full Code Here

            InterruptedException
    {
        // populate the test combined configuration
        setUpSourceTest();
        XMLConfiguration xmlConf = new XMLConfiguration();
        new FileHandler(xmlConf).load(ConfigurationAssert
                .getTestFile("test.xml"));
        config.addConfiguration(xmlConf);
        PropertiesConfiguration propConf = new PropertiesConfiguration();
        new FileHandler(propConf).load(ConfigurationAssert
                .getTestFile("test.properties"));
        for (int i = 0; i < 8; i++)
        {
            config.addConfiguration(new BaseHierarchicalConfiguration());
        }

View Full Code Here

     * @return the URL of the include file or <b>null</b> if it cannot be
     *         resolved
     */
    private URL locateIncludeFile(String basePath, String fileName)
    {
        FileLocator includeLocator =
                FileLocatorUtils.fileLocator(locator).sourceURL(null)
                        .basePath(basePath).fileName(fileName).create();
        return FileLocatorUtils.locate(includeLocator);
    }

View Full Code Here

            config.addConfiguration(new BaseHierarchicalConfiguration());
        }
        config.getConfiguration(0).addProperty(KEY_CONCURRENT, TEST_NAME);


        // Set a single synchronizer for all involved configurations
        Synchronizer sync = new ReadWriteSynchronizer();
        config.setSynchronizer(sync);
        for (Configuration c : config.getConfigurations())
        {
            c.setSynchronizer(sync);
        }

View Full Code Here

     * @since 2.0
     */
    @Override
    public final Synchronizer getSynchronizer()
    {
        Synchronizer sync = synchronizer;
        return (sync != null) ? sync : NoOpSynchronizer.INSTANCE;
    }

View Full Code Here

            config.addConfiguration(new BaseHierarchicalConfiguration());
        }
        config.getConfiguration(0).addProperty(KEY_CONCURRENT, TEST_NAME);


        // Set a single synchronizer for all involved configurations
        Synchronizer sync = new ReadWriteSynchronizer();
        config.setSynchronizer(sync);
        for (Configuration c : config.getConfigurations())
        {
            c.setSynchronizer(sync);
        }

View Full Code Here

0 1 2 3 4 5 6 7 8 9

TOP

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

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.