Author: oheger
Date: Mon Jan 6 14:54:04 2014
New Revision: 1555834
URL: http://svn.apache.org/r1555834
Log:
[CONFIGURATION-563] Added a new DefaultExpressionEngineSymbols class.
This is an immutable class which just holds the special symbols used by a
DefaultExpressionEngine object.
Added:
commons/proper/configuration/trunk/src/main/java/org/apache/commons/configuration/tree/DefaultExpressionEngineSymbols.java
commons/proper/configuration/trunk/src/test/java/org/apache/commons/configuration/tree/TestDefaultExpressionEngineSymbols.java
Added:
commons/proper/configuration/trunk/src/main/java/org/apache/commons/configuration/tree/DefaultExpressionEngineSymbols.java
URL:
http://svn.apache.org/viewvc/commons/proper/configuration/trunk/src/main/java/org/apache/commons/configuration/tree/DefaultExpressionEngineSymbols.java?rev=1555834&view=auto
==============================================================================
---
commons/proper/configuration/trunk/src/main/java/org/apache/commons/configuration/tree/DefaultExpressionEngineSymbols.java
(added)
+++
commons/proper/configuration/trunk/src/main/java/org/apache/commons/configuration/tree/DefaultExpressionEngineSymbols.java
Mon Jan 6 14:54:04 2014
@@ -0,0 +1,388 @@
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one or more
+ * contributor license agreements. See the NOTICE file distributed with
+ * this work for additional information regarding copyright ownership.
+ * The ASF licenses this file to You under the Apache License, Version 2.0
+ * (the "License"); you may not use this file except in compliance with
+ * the License. You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+package org.apache.commons.configuration.tree;
+
+import org.apache.commons.lang3.builder.EqualsBuilder;
+import org.apache.commons.lang3.builder.HashCodeBuilder;
+import org.apache.commons.lang3.builder.ToStringBuilder;
+
+/**
+ * <p>
+ * A class representing the various symbols that are supported in keys
+ * recognized by {@link DefaultExpressionEngine}.
+ * </p>
+ * <p>
+ * An instance of this class is associated with each instance of
+ * {@code DefaultExpressionEngine}. It determines which concrete symbols are
+ * used to define elements like separators, attributes, etc. within a
+ * configuration key.
+ * </p>
+ * <p>
+ * Instances are created using the nested {@code Builder} class. They are
+ * immutable and can be shared between arbitrary components.
+ * </p>
+ *
+ * @version $Id: $
+ * @since 2.0
+ */
+public final class DefaultExpressionEngineSymbols
+{
+ /** Constant for the default property delimiter. */
+ public static final String DEFAULT_PROPERTY_DELIMITER = ".";
+
+ /** Constant for the default escaped property delimiter. */
+ public static final String DEFAULT_ESCAPED_DELIMITER =
DEFAULT_PROPERTY_DELIMITER
+ + DEFAULT_PROPERTY_DELIMITER;
+
+ /** Constant for the default attribute start marker. */
+ public static final String DEFAULT_ATTRIBUTE_START = "[@";
+
+ /** Constant for the default attribute end marker. */
+ public static final String DEFAULT_ATTRIBUTE_END = "]";
+
+ /** Constant for the default index start marker. */
+ public static final String DEFAULT_INDEX_START = "(";
+
+ /** Constant for the default index end marker. */
+ public static final String DEFAULT_INDEX_END = ")";
+
+ /**
+ * An instance with default symbols. This instance is used by the default
+ * instance of {@code DefaultExpressionEngine}.
+ */
+ public static final DefaultExpressionEngineSymbols DEFAULT_SYMBOLS =
+ createDefaultSmybols();
+
+ /** Stores the property delimiter. */
+ private final String propertyDelimiter;
+
+ /** Stores the escaped property delimiter. */
+ private final String escapedDelimiter;
+
+ /** Stores the attribute start marker. */
+ private final String attributeStart;
+
+ /** Stores the attribute end marker. */
+ private final String attributeEnd;
+
+ /** Stores the index start marker. */
+ private final String indexStart;
+
+ /** stores the index end marker. */
+ private final String indexEnd;
+
+ /**
+ * Creates a new instance of {@code DefaultExpressionEngineSymbols}.
+ *
+ * @param b the builder for defining the properties of this instance
+ */
+ private DefaultExpressionEngineSymbols(Builder b)
+ {
+ propertyDelimiter = b.propertyDelimiter;
+ escapedDelimiter = b.escapedDelimiter;
+ indexStart = b.indexStart;
+ indexEnd = b.indexEnd;
+ attributeStart = b.attributeStart;
+ attributeEnd = b.attributeEnd;
+ }
+
+ /**
+ * Returns the string used as delimiter in property keys.
+ *
+ * @return the property delimiter
+ */
+ public String getPropertyDelimiter()
+ {
+ return propertyDelimiter;
+ }
+
+ /**
+ * Returns the string representing an escaped property delimiter.
+ *
+ * @return the escaped property delimiter
+ */
+ public String getEscapedDelimiter()
+ {
+ return escapedDelimiter;
+ }
+
+ /**
+ * Returns the string representing an attribute start marker.
+ *
+ * @return the attribute start marker
+ */
+ public String getAttributeStart()
+ {
+ return attributeStart;
+ }
+
+ /**
+ * Returns the string representing an attribute end marker.
+ *
+ * @return the attribute end marker
+ */
+ public String getAttributeEnd()
+ {
+ return attributeEnd;
+ }
+
+ /**
+ * Returns the string representing the start of an index in a property key.
+ *
+ * @return the index start marker
+ */
+ public String getIndexStart()
+ {
+ return indexStart;
+ }
+
+ /**
+ * Returns the string representing the end of an index in a property key.
+ *
+ * @return the index end marker
+ */
+ public String getIndexEnd()
+ {
+ return indexEnd;
+ }
+
+ /**
+ * Returns a hash code for this object.
+ *
+ * @return a hash code
+ */
+ @Override
+ public int hashCode()
+ {
+ return new HashCodeBuilder().append(getPropertyDelimiter())
+ .append(getEscapedDelimiter()).append(getIndexStart())
+ .append(getIndexEnd()).append(getAttributeStart())
+ .append(getAttributeEnd()).toHashCode();
+ }
+
+ /**
+ * Compares this object with another one. Two instances of
+ * {@code DefaultExpressionEngineSymbols} are considered equal if all of
+ * their properties are equal.
+ *
+ * @param obj the object to compare to
+ * @return a flag whether these objects are equal
+ */
+ @Override
+ public boolean equals(Object obj)
+ {
+ if (this == obj)
+ {
+ return true;
+ }
+ if (!(obj instanceof DefaultExpressionEngineSymbols))
+ {
+ return false;
+ }
+
+ DefaultExpressionEngineSymbols c = (DefaultExpressionEngineSymbols)
obj;
+ return new EqualsBuilder()
+ .append(getPropertyDelimiter(), c.getPropertyDelimiter())
+ .append(getEscapedDelimiter(), c.getEscapedDelimiter())
+ .append(getIndexStart(), c.getIndexStart())
+ .append(getIndexEnd(), c.getIndexEnd())
+ .append(getAttributeStart(), c.getAttributeStart())
+ .append(getAttributeEnd(), c.getAttributeEnd()).isEquals();
+ }
+
+ /**
+ * Returns a string representation for this object. This string contains
the
+ * values of all properties.
+ *
+ * @return a string for this object
+ */
+ @Override
+ public String toString()
+ {
+ return new ToStringBuilder(this)
+ .append("propertyDelimiter", getPropertyDelimiter())
+ .append("escapedDelimiter", getEscapedDelimiter())
+ .append("indexStart", getIndexStart())
+ .append("indexEnd", getIndexEnd())
+ .append("attributeStart", getAttributeStart())
+ .append("attributeEnd", getAttributeEnd()).toString();
+ }
+
+ /**
+ * Creates the {@code DefaultExpressionEngineSymbols} object with default
+ * symbols.
+ *
+ * @return the default symbols instance
+ */
+ private static DefaultExpressionEngineSymbols createDefaultSmybols()
+ {
+ return new Builder().setPropertyDelimiter(DEFAULT_PROPERTY_DELIMITER)
+ .setEscapedDelimiter(DEFAULT_ESCAPED_DELIMITER)
+ .setIndexStart(DEFAULT_INDEX_START)
+ .setIndexEnd(DEFAULT_INDEX_END)
+ .setAttributeStart(DEFAULT_ATTRIBUTE_START)
+ .setAttributeEnd(DEFAULT_ATTRIBUTE_END).create();
+ }
+
+ /**
+ * A builder class for creating instances of
+ * {@code DefaultExpressionEngineSymbols}.
+ */
+ public static class Builder
+ {
+ /** Stores the property delimiter. */
+ private String propertyDelimiter;
+
+ /** Stores the escaped property delimiter. */
+ private String escapedDelimiter;
+
+ /** Stores the attribute start marker. */
+ private String attributeStart;
+
+ /** Stores the attribute end marker. */
+ private String attributeEnd;
+
+ /** Stores the index start marker. */
+ private String indexStart;
+
+ /** stores the index end marker. */
+ private String indexEnd;
+
+ /**
+ * Creates a new, uninitialized instance of {@code Builder}. All
symbols
+ * are undefined.
+ */
+ public Builder()
+ {
+ }
+
+ /**
+ * Creates a new instance of {@code Builder} whose properties are
+ * initialized from the passed in {@code
DefaultExpressionEngineSymbols}
+ * object. This is useful if symbols are to be created which are
similar
+ * to the passed in instance.
+ *
+ * @param c the {@code DefaultExpressionEngineSymbols} object serving
as
+ * starting point for this builder
+ */
+ public Builder(DefaultExpressionEngineSymbols c)
+ {
+ propertyDelimiter = c.getPropertyDelimiter();
+ escapedDelimiter = c.getEscapedDelimiter();
+ indexStart = c.getIndexStart();
+ indexEnd = c.getIndexEnd();
+ attributeStart = c.getAttributeStart();
+ attributeEnd = c.getAttributeEnd();
+ }
+
+ /**
+ * Sets the string representing a delimiter for properties.
+ *
+ * @param d the property delimiter
+ * @return a reference to this object for method chaining
+ */
+ public Builder setPropertyDelimiter(String d)
+ {
+ propertyDelimiter = d;
+ return this;
+ }
+
+ /**
+ * Sets the string representing an escaped property delimiter. With
this
+ * string a delimiter that belongs to the key of a property can be
+ * escaped. If for instance "." is used as property
delimiter,
+ * you can set the escaped delimiter to "\." and can then
+ * escape the delimiter with a back slash.
+ *
+ * @param ed the escaped property delimiter
+ * @return a reference to this object for method chaining
+ */
+ public Builder setEscapedDelimiter(String ed)
+ {
+ escapedDelimiter = ed;
+ return this;
+ }
+
+ /**
+ * Sets the string representing the start of an index in a property
key.
+ * Index start and end marker are used together to detect indices in a
+ * property key.
+ *
+ * @param is the index start
+ * @return a reference to this object for method chaining
+ */
+ public Builder setIndexStart(String is)
+ {
+ indexStart = is;
+ return this;
+ }
+
+ /**
+ * Sets the string representing the end of an index in a property key.
+ *
+ * @param ie the index end
+ * @return a reference to this object for method chaining
+ */
+ public Builder setIndexEnd(String ie)
+ {
+ indexEnd = ie;
+ return this;
+ }
+
+ /**
+ * Sets the string representing the start marker of an attribute in a
+ * property key. Attribute start and end marker are used together to
+ * detect attributes in a property key.
+ *
+ * @param as the attribute start marker
+ * @return a reference to this object for method chaining
+ */
+ public Builder setAttributeStart(String as)
+ {
+ attributeStart = as;
+ return this;
+ }
+
+ /**
+ * Sets the string representing the end marker of an attribute in a
+ * property key.
+ *
+ * @param ae the attribute end marker
+ * @return a reference to this object for method chaining
+ */
+ public Builder setAttributeEnd(String ae)
+ {
+ attributeEnd = ae;
+ return this;
+ }
+
+ /**
+ * Creates the {@code DefaultExpressionEngineSymbols} instance based on
+ * the properties set for this builder object. This method does not
+ * change the state of this builder. So it is possible to change
+ * properties and create another {@code DefaultExpressionEngineSymbols}
+ * instance.
+ *
+ * @return the newly created {@code DefaultExpressionEngineSymbols}
+ * instance
+ */
+ public DefaultExpressionEngineSymbols create()
+ {
+ return new DefaultExpressionEngineSymbols(this);
+ }
+ }
+}
Added:
commons/proper/configuration/trunk/src/test/java/org/apache/commons/configuration/tree/TestDefaultExpressionEngineSymbols.java
URL:
http://svn.apache.org/viewvc/commons/proper/configuration/trunk/src/test/java/org/apache/commons/configuration/tree/TestDefaultExpressionEngineSymbols.java?rev=1555834&view=auto
==============================================================================
---
commons/proper/configuration/trunk/src/test/java/org/apache/commons/configuration/tree/TestDefaultExpressionEngineSymbols.java
(added)
+++
commons/proper/configuration/trunk/src/test/java/org/apache/commons/configuration/tree/TestDefaultExpressionEngineSymbols.java
Mon Jan 6 14:54:04 2014
@@ -0,0 +1,177 @@
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one or more
+ * contributor license agreements. See the NOTICE file distributed with
+ * this work for additional information regarding copyright ownership.
+ * The ASF licenses this file to You under the Apache License, Version 2.0
+ * (the "License"); you may not use this file except in compliance with
+ * the License. You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+package org.apache.commons.configuration.tree;
+
+import static org.hamcrest.CoreMatchers.containsString;
+import static org.junit.Assert.assertEquals;
+import static org.junit.Assert.assertFalse;
+import static org.junit.Assert.assertThat;
+import static org.junit.Assert.assertTrue;
+
+import org.junit.Test;
+
+/**
+ * Test class for {@code DefaultExpressionEngineSymbols}.
+ *
+ * @version $Id: $
+ */
+public class TestDefaultExpressionEngineSymbols
+{
+ /**
+ * Tests the instance with default symbols.
+ */
+ @Test
+ public void testDefaultSymbols()
+ {
+ assertEquals("Wrong delimiter", ".",
+ DefaultExpressionEngineSymbols.DEFAULT_SYMBOLS
+ .getPropertyDelimiter());
+ assertEquals("Wrong escaped delimiter", "..",
+ DefaultExpressionEngineSymbols.DEFAULT_SYMBOLS
+ .getEscapedDelimiter());
+ assertEquals("Wrong index start", "(",
+
DefaultExpressionEngineSymbols.DEFAULT_SYMBOLS.getIndexStart());
+ assertEquals("Wrong index end", ")",
+ DefaultExpressionEngineSymbols.DEFAULT_SYMBOLS.getIndexEnd());
+ assertEquals("Wrong attribute start", "[@",
+ DefaultExpressionEngineSymbols.DEFAULT_SYMBOLS
+ .getAttributeStart());
+ assertEquals("Wrong attribute end", "]",
+ DefaultExpressionEngineSymbols.DEFAULT_SYMBOLS
+ .getAttributeEnd());
+ }
+
+ /**
+ * Helper method for checking whether two objects are equal.
+ *
+ * @param o1 object 1
+ * @param o2 object 2
+ */
+ private static void expEqual(Object o1, Object o2)
+ {
+ assertTrue("Not equal", o1.equals(o2));
+ assertTrue("Not symmetric", o2.equals(o1));
+ assertEquals("Different hash codes", o1.hashCode(), o2.hashCode());
+ }
+
+ /**
+ * Helper method for testing that two objects are not equal.
+ *
+ * @param o1 object 1
+ * @param o2 object 2
+ */
+ private static void expNE(Object o1, Object o2)
+ {
+ assertFalse("Equal", o1.equals(o2));
+ if (o2 != null)
+ {
+ assertFalse("Not symmetric", o2.equals(o1));
+ }
+ }
+
+ /**
+ * Tests equals() if the expected result is true.
+ */
+ @Test
+ public void testEqualsTrue()
+ {
+ expEqual(DefaultExpressionEngineSymbols.DEFAULT_SYMBOLS,
+ DefaultExpressionEngineSymbols.DEFAULT_SYMBOLS);
+ DefaultExpressionEngineSymbols s2 =
+ new DefaultExpressionEngineSymbols.Builder(
+ DefaultExpressionEngineSymbols.DEFAULT_SYMBOLS)
+ .create();
+ expEqual(DefaultExpressionEngineSymbols.DEFAULT_SYMBOLS, s2);
+ }
+
+ /**
+ * Helper method for creating a builder object which is initialized with
the
+ * default symbols.
+ *
+ * @return the initialized builder
+ */
+ private static DefaultExpressionEngineSymbols.Builder builder()
+ {
+ return new DefaultExpressionEngineSymbols.Builder(
+ DefaultExpressionEngineSymbols.DEFAULT_SYMBOLS);
+ }
+
+ /**
+ * Tests equals() if the expected result is false.
+ */
+ @Test
+ public void testEqualsFalse()
+ {
+ DefaultExpressionEngineSymbols s1 =
+ DefaultExpressionEngineSymbols.DEFAULT_SYMBOLS;
+ DefaultExpressionEngineSymbols s2 =
+ builder().setPropertyDelimiter("/").create();
+ expNE(s1, s2);
+ s2 = builder().setEscapedDelimiter("\\.").create();
+ expNE(s1, s2);
+ s2 = builder().setIndexStart("[").create();
+ expNE(s1, s2);
+ s2 = builder().setIndexEnd("]").create();
+ expNE(s1, s2);
+ s2 = builder().setAttributeStart("#").create();
+ expNE(s1, s2);
+ s2 = builder().setAttributeEnd("~").create();
+ expNE(s1, s2);
+ }
+
+ /**
+ * Tests equals for null input.
+ */
+ @Test
+ public void testEqualsNull()
+ {
+ expNE(builder().create(), null);
+ }
+
+ /**
+ * Tests equals with an object of another class.
+ */
+ @Test
+ public void testEqualsOtherClass()
+ {
+ expNE(builder().create(), this);
+ }
+
+ /**
+ * Tests the string representation.
+ */
+ @Test
+ public void testToString()
+ {
+ DefaultExpressionEngineSymbols symbols = builder().create();
+ String s = symbols.toString();
+ assertThat(
+ s,
+ containsString("propertyDelimiter="
+ + symbols.getPropertyDelimiter()));
+ assertThat(
+ s,
+ containsString("escapedDelimiter="
+ + symbols.getEscapedDelimiter()));
+ assertThat(s, containsString("indexStart=" + symbols.getIndexStart()));
+ assertThat(s, containsString("indexEnd=" + symbols.getIndexEnd()));
+ assertThat(s,
+ containsString("attributeStart=" +
symbols.getAttributeStart()));
+ assertThat(s,
+ containsString("attributeEnd=" + symbols.getAttributeEnd()));
+ }
+}
