Return-Path: X-Original-To: apmail-commons-commits-archive@minotaur.apache.org Delivered-To: apmail-commons-commits-archive@minotaur.apache.org Received: from mail.apache.org (hermes.apache.org [140.211.11.3]) by minotaur.apache.org (Postfix) with SMTP id 8FFA310C38 for ; Thu, 19 Sep 2013 20:18:20 +0000 (UTC) Received: (qmail 3170 invoked by uid 500); 19 Sep 2013 20:18:19 -0000 Delivered-To: apmail-commons-commits-archive@commons.apache.org Received: (qmail 3104 invoked by uid 500); 19 Sep 2013 20:18:18 -0000 Mailing-List: contact commits-help@commons.apache.org; run by ezmlm Precedence: bulk List-Help: List-Unsubscribe: List-Post: List-Id: Reply-To: dev@commons.apache.org Delivered-To: mailing list commits@commons.apache.org Received: (qmail 3086 invoked by uid 99); 19 Sep 2013 20:18:17 -0000 Received: from nike.apache.org (HELO nike.apache.org) (192.87.106.230) by apache.org (qpsmtpd/0.29) with ESMTP; Thu, 19 Sep 2013 20:18:17 +0000 X-ASF-Spam-Status: No, hits=-2000.0 required=5.0 tests=ALL_TRUSTED X-Spam-Check-By: apache.org Received: from [140.211.11.4] (HELO eris.apache.org) (140.211.11.4) by apache.org (qpsmtpd/0.29) with ESMTP; Thu, 19 Sep 2013 20:18:11 +0000 Received: from eris.apache.org (localhost [127.0.0.1]) by eris.apache.org (Postfix) with ESMTP id DF08123888CD; Thu, 19 Sep 2013 20:17:48 +0000 (UTC) Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit Subject: svn commit: r1524821 - in /commons/proper/configuration/trunk/src: main/java/org/apache/commons/configuration/io/ test/java/org/apache/commons/configuration/io/ Date: Thu, 19 Sep 2013 20:17:48 -0000 To: commits@commons.apache.org From: oheger@apache.org X-Mailer: svnmailer-1.0.9 Message-Id: <20130919201748.DF08123888CD@eris.apache.org> X-Virus-Checked: Checked by ClamAV on apache.org Author: oheger Date: Thu Sep 19 20:17:48 2013 New Revision: 1524821 URL: http://svn.apache.org/r1524821 Log: Moved FileLocatorImpl to a top-level class. We are going to use this class directly later on. Added: commons/proper/configuration/trunk/src/main/java/org/apache/commons/configuration/io/FileLocatorImpl.java commons/proper/configuration/trunk/src/test/java/org/apache/commons/configuration/io/TestFileLocator.java Modified: commons/proper/configuration/trunk/src/main/java/org/apache/commons/configuration/io/FileHandler.java commons/proper/configuration/trunk/src/main/java/org/apache/commons/configuration/io/FileLocatorUtils.java commons/proper/configuration/trunk/src/test/java/org/apache/commons/configuration/io/TestFileLocatorUtils.java Modified: commons/proper/configuration/trunk/src/main/java/org/apache/commons/configuration/io/FileHandler.java URL: http://svn.apache.org/viewvc/commons/proper/configuration/trunk/src/main/java/org/apache/commons/configuration/io/FileHandler.java?rev=1524821&r1=1524820&r2=1524821&view=diff ============================================================================== --- commons/proper/configuration/trunk/src/main/java/org/apache/commons/configuration/io/FileHandler.java (original) +++ commons/proper/configuration/trunk/src/main/java/org/apache/commons/configuration/io/FileHandler.java Thu Sep 19 20:17:48 2013 @@ -33,7 +33,7 @@ import java.util.concurrent.CopyOnWriteA import java.util.concurrent.atomic.AtomicReference; import org.apache.commons.configuration.ConfigurationException; -import org.apache.commons.configuration.io.FileLocatorUtils.FileLocatorBuilder; +import org.apache.commons.configuration.io.FileLocatorImpl.FileLocatorBuilder; import org.apache.commons.configuration.sync.LockMode; import org.apache.commons.configuration.sync.NoOpSynchronizer; import org.apache.commons.configuration.sync.Synchronizer; @@ -1446,7 +1446,7 @@ public class FileHandler do { FileLocator oldLocator = fileLocator.get(); - FileLocatorUtils.FileLocatorBuilder builder = + FileLocatorBuilder builder = FileLocatorUtils.fileLocator(oldLocator); updateBuilder(builder); done = fileLocator.compareAndSet(oldLocator, builder.create()); @@ -1462,7 +1462,6 @@ public class FileHandler * @param builder the builder for creating an updated * {@code FileLocator} */ - protected abstract void updateBuilder( - FileLocatorUtils.FileLocatorBuilder builder); + protected abstract void updateBuilder(FileLocatorBuilder builder); } } Added: commons/proper/configuration/trunk/src/main/java/org/apache/commons/configuration/io/FileLocatorImpl.java URL: http://svn.apache.org/viewvc/commons/proper/configuration/trunk/src/main/java/org/apache/commons/configuration/io/FileLocatorImpl.java?rev=1524821&view=auto ============================================================================== --- commons/proper/configuration/trunk/src/main/java/org/apache/commons/configuration/io/FileLocatorImpl.java (added) +++ commons/proper/configuration/trunk/src/main/java/org/apache/commons/configuration/io/FileLocatorImpl.java Thu Sep 19 20:17:48 2013 @@ -0,0 +1,336 @@ +/* + * 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.io; + +import java.net.URL; + +import org.apache.commons.lang3.StringUtils; +import org.apache.commons.lang3.builder.EqualsBuilder; +import org.apache.commons.lang3.builder.HashCodeBuilder; +import org.apache.commons.lang3.builder.ToStringBuilder; + +/** + *

+ * A class describing the location of a file. + *

+ *

+ * An instance of this class provides information for locating and accessing a + * file. The file location can be defined + *

    + *
  • as a URL; this identifies a file in a unique way
    • + *
  • as a combination of base path and file name; if this variant is used, + * there may be an additional location step required in order to identify the + * referenced file (for instance, the file name may be interpreted as the name + * of a resource to be loaded from class path).
    • + *
+ * In addition, other properties are available which are also needed for loading + * or saving a file, like the encoding or the underlying {@link FileSystem}. + *

+ *

+ * Instances of this class are immutable and thus can be safely shared between + * arbitrary components. {@link FileHandler} also uses an instance to reference + * the associated file. Instances are created using a builder. + * {@link FileLocatorUtils} offers convenience methods for obtaining such a + * builder. + *

+ * + * @version $Id$ + * @since 2.0 + */ +public final class FileLocatorImpl implements FileLocator +{ + /** The file name. */ + private final String fileName; + + /** The base path. */ + private final String basePath; + + /** The source URL. */ + private final URL sourceURL; + + /** The encoding. */ + private final String encoding; + + /** The file system. */ + private final FileSystem fileSystem; + + /** + * Creates a new instance of {@code FileLocatorImpl} and initializes it from + * the given builder instance + * + * @param builder the builder + */ + public FileLocatorImpl(FileLocatorBuilder builder) + { + fileName = builder.fileName; + basePath = builder.basePath; + sourceURL = builder.sourceURL; + encoding = builder.encoding; + fileSystem = builder.fileSystem; + } + + /** + * Returns the file name stored in this locator or null if it is + * undefined. + * + * @return the file name + */ + public String getFileName() + { + return fileName; + } + + /** + * Returns the base path stored in this locator or null if it is + * undefined. + * + * @return the base path + */ + public String getBasePath() + { + return basePath; + } + + /** + * Returns the URL pointing to the referenced source file or null if + * it is undefined. + * + * @return the source URL + */ + public URL getSourceURL() + { + return sourceURL; + } + + /** + * Returns the encoding stored in this locator or null if it is + * undefined. + * + * @return the encoding + */ + public String getEncoding() + { + return encoding; + } + + /** + * Returns the {@code FileSystem} to be used for accessing the file + * referenced by this locator or null if it is undefined. + * + * @return the {@code FileSystem} + */ + public FileSystem getFileSystem() + { + return fileSystem; + } + + /** + * Returns a hash code for this object. + * + * @return a hash code for this object + */ + @Override + public int hashCode() + { + return new HashCodeBuilder().append(getFileName()) + .append(getBasePath()).append(sourceURLAsString()) + .append(getEncoding()).append(getFileSystem()).toHashCode(); + } + + /** + * Compares this object with another one. Two instances of + * {@code FileLocatorImpl} 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 FileLocatorImpl)) + { + return false; + } + + FileLocatorImpl c = (FileLocatorImpl) obj; + return new EqualsBuilder().append(getFileName(), c.getFileName()) + .append(getBasePath(), c.getBasePath()) + .append(sourceURLAsString(), c.sourceURLAsString()) + .append(getEncoding(), c.getEncoding()) + .append(getFileSystem(), c.getFileSystem()).isEquals(); + } + + /** + * Returns a string representation of 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("fileName", getFileName()) + .append("basePath", getBasePath()) + .append("sourceURL", sourceURLAsString()) + .append("encoding", getEncoding()) + .append("fileSystem", getFileSystem()).toString(); + } + + /** + * Returns the source URL as a string. Result is never null. Comparisons are + * done on this string to avoid blocking network calls. + * + * @return the source URL as a string (not null) + */ + private String sourceURLAsString() + { + return (sourceURL != null) ? sourceURL.toExternalForm() + : StringUtils.EMPTY; + } + + /** + * A typical builder implementation for creating + * {@code FileLocator} objects. An instance of this class is returned by the + * {@code fileLocator()} method of {link FileLocatorUtils}. It can be used + * to define the various components of the {@code FileLocator} object. By + * calling {@code create()} the new immutable {@code FileLocator} instance + * is created. + */ + public static final class FileLocatorBuilder + { + /** The file name. */ + private String fileName; + + /** The base path. */ + private String basePath; + + /** The source URL. */ + private URL sourceURL; + + /** The encoding. */ + private String encoding; + + /** The file system. */ + private FileSystem fileSystem; + + /** + * Creates a new instance of {@code FileLocatorBuilder} and initializes + * the builder's properties from the passed in {@code FileLocator} + * object. + * + * @param src the source {@code FileLocator} (may be null) + */ + FileLocatorBuilder(FileLocator src) + { + if (src != null) + { + initBuilder(src); + } + } + + /** + * Specifies the encoding of the new {@code FileLocator}. + * + * @param enc the encoding + * @return a reference to this builder for method chaining + */ + public FileLocatorBuilder encoding(String enc) + { + encoding = enc; + return this; + } + + /** + * Specifies the {@code FileSystem} of the new {@code FileLocator}. + * + * @param fs the {@code FileSystem} + * @return a reference to this builder for method chaining + */ + public FileLocatorBuilder fileSystem(FileSystem fs) + { + fileSystem = fs; + return this; + } + + /** + * Specifies the base path of the new {@code FileLocator}. + * + * @param path the base path + * @return a reference to this builder for method chaining + */ + public FileLocatorBuilder basePath(String path) + { + basePath = path; + return this; + } + + /** + * Specifies the file name of the new {@code FileLocator}. + * + * @param name the file name + * @return a reference to this builder for method chaining + */ + public FileLocatorBuilder fileName(String name) + { + fileName = name; + return this; + } + + /** + * Specifies the source URL of the new {@code FileLocator}. + * + * @param url the source URL + * @return a reference to this builder for method chaining + */ + public FileLocatorBuilder sourceURL(URL url) + { + sourceURL = url; + return this; + } + + /** + * Creates a new immutable {@code FileLocatorImpl} object based on the + * properties set so far for this builder. + * + * @return the newly created {@code FileLocator} object + */ + public FileLocatorImpl create() + { + return new FileLocatorImpl(this); + } + + /** + * Initializes the properties of this builder from the passed in locator + * object. + * + * @param src the source {@code FileLocator} + */ + private void initBuilder(FileLocator src) + { + basePath = src.getBasePath(); + fileName = src.getFileName(); + sourceURL = src.getSourceURL(); + encoding = src.getEncoding(); + fileSystem = src.getFileSystem(); + } + } +} Modified: commons/proper/configuration/trunk/src/main/java/org/apache/commons/configuration/io/FileLocatorUtils.java URL: http://svn.apache.org/viewvc/commons/proper/configuration/trunk/src/main/java/org/apache/commons/configuration/io/FileLocatorUtils.java?rev=1524821&r1=1524820&r2=1524821&view=diff ============================================================================== --- commons/proper/configuration/trunk/src/main/java/org/apache/commons/configuration/io/FileLocatorUtils.java (original) +++ commons/proper/configuration/trunk/src/main/java/org/apache/commons/configuration/io/FileLocatorUtils.java Thu Sep 19 20:17:48 2013 @@ -23,9 +23,6 @@ import java.net.URL; import org.apache.commons.configuration.ConfigurationUtils; import org.apache.commons.lang3.ObjectUtils; import org.apache.commons.lang3.StringUtils; -import org.apache.commons.lang3.builder.EqualsBuilder; -import org.apache.commons.lang3.builder.HashCodeBuilder; -import org.apache.commons.lang3.builder.ToStringBuilder; import org.apache.commons.logging.Log; import org.apache.commons.logging.LogFactory; @@ -92,7 +89,7 @@ public final class FileLocatorUtils * * @return a builder object for defining a {@code FileLocator} */ - public static FileLocatorBuilder fileLocator() + public static FileLocatorImpl.FileLocatorBuilder fileLocator() { return fileLocator(null); } @@ -112,9 +109,9 @@ public final class FileLocatorUtils * @param src the source {@code FileLocator} (may be null) * @return an initialized builder object for defining a {@code FileLocator} */ - public static FileLocatorBuilder fileLocator(FileLocator src) + public static FileLocatorImpl.FileLocatorBuilder fileLocator(FileLocator src) { - return new FileLocatorBuilder(src); + return new FileLocatorImpl.FileLocatorBuilder(src); } /** @@ -588,261 +585,4 @@ public final class FileLocatorUtils return fileLocator(src).sourceURL(url).fileName(getFileName(url)) .basePath(getBasePath(url)).create(); } - - /** - * A typical builder implementation for creating - * {@code FileLocator} objects. An instance of this class is returned by the - * {@code fileLocator()} method of {@code FileLocatorUtils}. It can be used - * to define the various components of the {@code FileLocator} object. By - * calling {@code create()} the new immutable {@code FileLocator} instance - * is created. - */ - public static final class FileLocatorBuilder - { - /** The file name. */ - private String fileName; - - /** The base path. */ - private String basePath; - - /** The source URL. */ - private URL sourceURL; - - /** The encoding. */ - private String encoding; - - /** The file system. */ - private FileSystem fileSystem; - - /** - * Creates a new instance of {@code FileLocatorBuilder} and initializes - * the builder's properties from the passed in {@code FileLocator} - * object. - * - * @param src the source {@code FileLocator} (may be null) - */ - private FileLocatorBuilder(FileLocator src) - { - if (src != null) - { - initBuilder(src); - } - } - - /** - * Specifies the encoding of the new {@code FileLocator}. - * - * @param enc the encoding - * @return a reference to this builder for method chaining - */ - public FileLocatorBuilder encoding(String enc) - { - encoding = enc; - return this; - } - - /** - * Specifies the {@code FileSystem} of the new {@code FileLocator}. - * - * @param fs the {@code FileSystem} - * @return a reference to this builder for method chaining - */ - public FileLocatorBuilder fileSystem(FileSystem fs) - { - fileSystem = fs; - return this; - } - - /** - * Specifies the base path of the new {@code FileLocator}. - * - * @param path the base path - * @return a reference to this builder for method chaining - */ - public FileLocatorBuilder basePath(String path) - { - basePath = path; - return this; - } - - /** - * Specifies the file name of the new {@code FileLocator}. - * - * @param name the file name - * @return a reference to this builder for method chaining - */ - public FileLocatorBuilder fileName(String name) - { - fileName = name; - return this; - } - - /** - * Specifies the source URL of the new {@code FileLocator}. - * - * @param url the source URL - * @return a reference to this builder for method chaining - */ - public FileLocatorBuilder sourceURL(URL url) - { - sourceURL = url; - return this; - } - - /** - * Creates a new immutable {@code FileLocator} object based on the - * properties set so far for this builder. - * - * @return the newly created {@code FileLocator} object - */ - public FileLocator create() - { - return new FileLocatorImpl(this); - } - - /** - * Initializes the properties of this builder from the passed in locator - * object. - * - * @param src the source {@code FileLocator} - */ - private void initBuilder(FileLocator src) - { - basePath = src.getBasePath(); - fileName = src.getFileName(); - sourceURL = src.getSourceURL(); - encoding = src.getEncoding(); - fileSystem = src.getFileSystem(); - } - } - - /** - * A straight-forward immutable implementation of {@code FileLocator}. - */ - private static class FileLocatorImpl implements FileLocator - { - /** The file name. */ - private final String fileName; - - /** The base path. */ - private final String basePath; - - /** The source URL. */ - private final URL sourceURL; - - /** The encoding. */ - private final String encoding; - - /** The file system. */ - private final FileSystem fileSystem; - - /** - * Creates a new instance of {@code FileLocatorImpl} and initializes it - * from the given builder instance - * - * @param builder the builder - */ - public FileLocatorImpl(FileLocatorBuilder builder) - { - fileName = builder.fileName; - basePath = builder.basePath; - sourceURL = builder.sourceURL; - encoding = builder.encoding; - fileSystem = builder.fileSystem; - } - - public String getFileName() - { - return fileName; - } - - public String getBasePath() - { - return basePath; - } - - public URL getSourceURL() - { - return sourceURL; - } - - public String getEncoding() - { - return encoding; - } - - public FileSystem getFileSystem() - { - return fileSystem; - } - - /** - * Returns a hash code for this object. - * - * @return a hash code for this object - */ - @Override - public int hashCode() - { - return new HashCodeBuilder().append(getFileName()) - .append(getBasePath()).append(sourceURLAsString()) - .append(getEncoding()).append(getFileSystem()).toHashCode(); - } - - /** - * Compares this object with another one. Two instances of - * {@code FileLocatorImpl} 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 FileLocatorImpl)) - { - return false; - } - - FileLocatorImpl c = (FileLocatorImpl) obj; - return new EqualsBuilder().append(getFileName(), c.getFileName()) - .append(getBasePath(), c.getBasePath()) - .append(sourceURLAsString(), c.sourceURLAsString()) - .append(getEncoding(), c.getEncoding()) - .append(getFileSystem(), c.getFileSystem()).isEquals(); - } - - /** - * Returns a string representation of 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("fileName", getFileName()) - .append("basePath", getBasePath()) - .append("sourceURL", sourceURLAsString()) - .append("encoding", getEncoding()) - .append("fileSystem", getFileSystem()).toString(); - } - - /** - * Returns the source URL as a string. Result is never null. Comparisons - * are done on this string to avoid blocking network calls. - * - * @return the source URL as a string (not null) - */ - private String sourceURLAsString() - { - return (sourceURL != null) ? sourceURL.toExternalForm() - : StringUtils.EMPTY; - } - } } Added: commons/proper/configuration/trunk/src/test/java/org/apache/commons/configuration/io/TestFileLocator.java URL: http://svn.apache.org/viewvc/commons/proper/configuration/trunk/src/test/java/org/apache/commons/configuration/io/TestFileLocator.java?rev=1524821&view=auto ============================================================================== --- commons/proper/configuration/trunk/src/test/java/org/apache/commons/configuration/io/TestFileLocator.java (added) +++ commons/proper/configuration/trunk/src/test/java/org/apache/commons/configuration/io/TestFileLocator.java Thu Sep 19 20:17:48 2013 @@ -0,0 +1,220 @@ +/* + * 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.io; + +import static org.hamcrest.CoreMatchers.containsString; +import static org.junit.Assert.assertEquals; +import static org.junit.Assert.assertFalse; +import static org.junit.Assert.assertNull; +import static org.junit.Assert.assertSame; +import static org.junit.Assert.assertThat; + +import java.net.URL; + +import org.apache.commons.configuration.ConfigurationAssert; +import org.easymock.EasyMock; +import org.junit.BeforeClass; +import org.junit.Test; + +/** + * Test class for {@code FileLocatorImpl}. + * + * @version $Id: $ + */ +public class TestFileLocator +{ + /** Constant for a file name. */ + private static final String FILE_NAME = "test.xml"; + + /** Constant for a base path. */ + private static final String BASE_PATH = "/etc/test/path/"; + + /** Constant for a test encoding. */ + private static final String ENCODING = "utf-8"; + + /** A test URL. */ + private static URL sourceURL; + + /** A test file system. */ + private static FileSystem fileSystem; + + @BeforeClass + public static void setUpOnce() throws Exception + { + sourceURL = ConfigurationAssert.getTestURL(FILE_NAME); + fileSystem = EasyMock.createMock(FileSystem.class); + EasyMock.replay(fileSystem); + } + + /** + * Tests whether an undefined file locator can be created. + */ + @Test + public void testCreateFileLocatorUndefined() + { + FileLocatorImpl locator = FileLocatorUtils.fileLocator().create(); + assertNull("Got a base path", locator.getBasePath()); + assertNull("Got a file name", locator.getFileName()); + assertNull("Got a URL", locator.getSourceURL()); + assertNull("Got an encoding", locator.getEncoding()); + assertNull("Got a file system", locator.getFileSystem()); + } + + /** + * Tests whether a locator has the expected properties. + * + * @param locator the locator to check + */ + private static void checkLocator(FileLocatorImpl locator) + { + assertEquals("Wrong base path", BASE_PATH, locator.getBasePath()); + assertEquals("Wrong file name", FILE_NAME, locator.getFileName()); + assertEquals("Wrong encoding", ENCODING, locator.getEncoding()); + assertEquals("Wrong URL", sourceURL.toExternalForm(), locator + .getSourceURL().toExternalForm()); + assertSame("Wrong file system", fileSystem, locator.getFileSystem()); + } + + /** + * Tests the creation of a file locator. + */ + @Test + public void testCreateFileLocator() + { + FileLocatorImpl locator = + FileLocatorUtils.fileLocator().basePath(BASE_PATH) + .fileName(FILE_NAME).encoding(ENCODING) + .fileSystem(fileSystem).sourceURL(sourceURL).create(); + checkLocator(locator); + } + + /** + * Tests whether a file locator can be created from a source locator. + */ + @Test + public void testCreateFileLocatorFromSource() + { + FileLocatorImpl locatorSrc = + FileLocatorUtils.fileLocator().basePath(BASE_PATH) + .fileName("someFile").encoding(ENCODING) + .fileSystem(fileSystem).sourceURL(sourceURL).create(); + FileLocatorImpl locator = + FileLocatorUtils.fileLocator(locatorSrc).fileName(FILE_NAME) + .create(); + checkLocator(locator); + } + + /** + * Tests the equals() implementation of FileLocator if the expected result + * is true. + */ + @Test + public void testFileLocatorEqualsTrue() + { + FileLocatorImpl loc1 = FileLocatorUtils.fileLocator().create(); + ConfigurationAssert.checkEquals(loc1, loc1, true); + FileLocatorImpl loc2 = FileLocatorUtils.fileLocator().create(); + ConfigurationAssert.checkEquals(loc1, loc2, true); + loc1 = + FileLocatorUtils.fileLocator().basePath(BASE_PATH) + .fileName(FILE_NAME).encoding(ENCODING) + .fileSystem(fileSystem).sourceURL(sourceURL).create(); + loc2 = + FileLocatorUtils.fileLocator().basePath(BASE_PATH) + .fileName(FILE_NAME).encoding(ENCODING) + .fileSystem(fileSystem).sourceURL(sourceURL).create(); + ConfigurationAssert.checkEquals(loc1, loc2, true); + } + + /** + * Tests the equals() implementation of FileLocator if the expected result + * is false. + */ + @Test + public void testFileLocatorEqualsFalse() + { + FileLocatorImpl loc1 = + FileLocatorUtils.fileLocator().basePath(BASE_PATH) + .fileName(FILE_NAME).encoding(ENCODING) + .fileSystem(fileSystem).sourceURL(sourceURL).create(); + FileLocatorImpl loc2 = + FileLocatorUtils.fileLocator(loc1) + .basePath(BASE_PATH + "_other").create(); + ConfigurationAssert.checkEquals(loc1, loc2, false); + loc2 = + FileLocatorUtils.fileLocator(loc1) + .fileName(FILE_NAME + "_other").create(); + ConfigurationAssert.checkEquals(loc1, loc2, false); + loc2 = + FileLocatorUtils.fileLocator(loc1) + .encoding(ENCODING + "_other").create(); + ConfigurationAssert.checkEquals(loc1, loc2, false); + loc2 = + FileLocatorUtils.fileLocator(loc1) + .fileSystem(EasyMock.createMock(FileSystem.class)) + .create(); + ConfigurationAssert.checkEquals(loc1, loc2, false); + loc2 = + FileLocatorUtils + .fileLocator(loc1) + .sourceURL( + ConfigurationAssert + .getTestURL("test.properties")) + .create(); + ConfigurationAssert.checkEquals(loc1, loc2, false); + } + + /** + * Tests equals() with a null object. + */ + @Test + public void testFileLocatorEqualsNull() + { + FileLocatorImpl loc = + FileLocatorUtils.fileLocator().fileName(FILE_NAME).create(); + assertFalse("Wrong result", loc.equals(null)); + } + + /** + * Tests equals() with an object from another class. + */ + @Test + public void testFileLocatorEqualsOtherClass() + { + FileLocatorImpl loc = + FileLocatorUtils.fileLocator().fileName(FILE_NAME).create(); + assertFalse("Wrong result", loc.equals(this)); + } + + /** + * Tests the string representation of a locator. + */ + @Test + public void testFileLocatorToString() + { + FileLocatorImpl loc = + FileLocatorUtils.fileLocator().basePath(BASE_PATH) + .fileName(FILE_NAME).encoding(ENCODING) + .fileSystem(fileSystem).sourceURL(sourceURL).create(); + String s = loc.toString(); + assertThat(s, containsString("fileName=" + FILE_NAME)); + assertThat(s, containsString("basePath=" + BASE_PATH)); + assertThat(s, containsString("sourceURL=" + sourceURL)); + assertThat(s, containsString("encoding=" + ENCODING)); + assertThat(s, containsString("fileSystem=" + fileSystem)); + } +} Modified: commons/proper/configuration/trunk/src/test/java/org/apache/commons/configuration/io/TestFileLocatorUtils.java URL: http://svn.apache.org/viewvc/commons/proper/configuration/trunk/src/test/java/org/apache/commons/configuration/io/TestFileLocatorUtils.java?rev=1524821&r1=1524820&r2=1524821&view=diff ============================================================================== --- commons/proper/configuration/trunk/src/test/java/org/apache/commons/configuration/io/TestFileLocatorUtils.java (original) +++ commons/proper/configuration/trunk/src/test/java/org/apache/commons/configuration/io/TestFileLocatorUtils.java Thu Sep 19 20:17:48 2013 @@ -16,13 +16,11 @@ */ package org.apache.commons.configuration.io; -import static org.hamcrest.CoreMatchers.containsString; import static org.junit.Assert.assertEquals; import static org.junit.Assert.assertFalse; import static org.junit.Assert.assertNotNull; import static org.junit.Assert.assertNull; import static org.junit.Assert.assertSame; -import static org.junit.Assert.assertThat; import static org.junit.Assert.assertTrue; import java.io.File; @@ -168,164 +166,6 @@ public class TestFileLocatorUtils } /** - * Tests whether an undefined file locator can be created. - */ - @Test - public void testCreateFileLocatorUndefined() - { - FileLocator locator = FileLocatorUtils.fileLocator().create(); - assertNull("Got a base path", locator.getBasePath()); - assertNull("Got a file name", locator.getFileName()); - assertNull("Got a URL", locator.getSourceURL()); - assertNull("Got an encoding", locator.getEncoding()); - assertNull("Got a file system", locator.getFileSystem()); - } - - /** - * Tests whether a locator has the expected properties. - * - * @param locator the locator to check - */ - private static void checkLocator(FileLocator locator) - { - assertEquals("Wrong base path", BASE_PATH, locator.getBasePath()); - assertEquals("Wrong file name", FILE_NAME, locator.getFileName()); - assertEquals("Wrong encoding", ENCODING, locator.getEncoding()); - assertEquals("Wrong URL", sourceURL.toExternalForm(), locator - .getSourceURL().toExternalForm()); - assertSame("Wrong file system", fileSystem, locator.getFileSystem()); - } - - /** - * Tests the creation of a file locator. - */ - @Test - public void testCreateFileLocator() - { - FileLocator locator = - FileLocatorUtils.fileLocator().basePath(BASE_PATH) - .fileName(FILE_NAME).encoding(ENCODING) - .fileSystem(fileSystem).sourceURL(sourceURL).create(); - checkLocator(locator); - } - - /** - * Tests whether a file locator can be created from a source locator. - */ - @Test - public void testCreateFileLocatorFromSource() - { - FileLocator locatorSrc = - FileLocatorUtils.fileLocator().basePath(BASE_PATH) - .fileName("someFile").encoding(ENCODING) - .fileSystem(fileSystem).sourceURL(sourceURL).create(); - FileLocator locator = - FileLocatorUtils.fileLocator(locatorSrc).fileName(FILE_NAME) - .create(); - checkLocator(locator); - } - - /** - * Tests the equals() implementation of FileLocator if the expected result - * is true. - */ - @Test - public void testFileLocatorEqualsTrue() - { - FileLocator loc1 = FileLocatorUtils.fileLocator().create(); - ConfigurationAssert.checkEquals(loc1, loc1, true); - FileLocator loc2 = FileLocatorUtils.fileLocator().create(); - ConfigurationAssert.checkEquals(loc1, loc2, true); - loc1 = - FileLocatorUtils.fileLocator().basePath(BASE_PATH) - .fileName(FILE_NAME).encoding(ENCODING) - .fileSystem(fileSystem).sourceURL(sourceURL).create(); - loc2 = - FileLocatorUtils.fileLocator().basePath(BASE_PATH) - .fileName(FILE_NAME).encoding(ENCODING) - .fileSystem(fileSystem).sourceURL(sourceURL).create(); - ConfigurationAssert.checkEquals(loc1, loc2, true); - } - - /** - * Tests the equals() implementation of FileLocator if the expected result - * is false. - */ - @Test - public void testFileLocatorEqualsFalse() - { - FileLocator loc1 = - FileLocatorUtils.fileLocator().basePath(BASE_PATH) - .fileName(FILE_NAME).encoding(ENCODING) - .fileSystem(fileSystem).sourceURL(sourceURL).create(); - FileLocator loc2 = - FileLocatorUtils.fileLocator(loc1) - .basePath(BASE_PATH + "_other").create(); - ConfigurationAssert.checkEquals(loc1, loc2, false); - loc2 = - FileLocatorUtils.fileLocator(loc1) - .fileName(FILE_NAME + "_other").create(); - ConfigurationAssert.checkEquals(loc1, loc2, false); - loc2 = - FileLocatorUtils.fileLocator(loc1) - .encoding(ENCODING + "_other").create(); - ConfigurationAssert.checkEquals(loc1, loc2, false); - loc2 = - FileLocatorUtils.fileLocator(loc1) - .fileSystem(EasyMock.createMock(FileSystem.class)) - .create(); - ConfigurationAssert.checkEquals(loc1, loc2, false); - loc2 = - FileLocatorUtils - .fileLocator(loc1) - .sourceURL( - ConfigurationAssert - .getTestURL("test.properties")) - .create(); - ConfigurationAssert.checkEquals(loc1, loc2, false); - } - - /** - * Tests equals() with a null object. - */ - @Test - public void testFileLocatorEqualsNull() - { - FileLocator loc = - FileLocatorUtils.fileLocator().fileName(FILE_NAME).create(); - assertFalse("Wrong result", loc.equals(null)); - } - - /** - * Tests equals() with an object from another class. - */ - @Test - public void testFileLocatorEqualsOtherClass() - { - FileLocator loc = - FileLocatorUtils.fileLocator().fileName(FILE_NAME).create(); - assertFalse("Wrong result", loc.equals(this)); - } - - /** - * Tests the string representation of a locator. - */ - @Test - public void testFileLocatorToString() - { - FileLocator loc = - FileLocatorUtils.fileLocator().basePath(BASE_PATH) - .fileName(FILE_NAME).encoding(ENCODING) - .fileSystem(fileSystem).sourceURL(sourceURL).create(); - String s = loc.toString(); - assertThat(s, containsString("fileName=" + FILE_NAME)); - assertThat(s, containsString("basePath=" + BASE_PATH)); - assertThat(s, containsString("sourceURL=" + sourceURL)); - assertThat(s, containsString("encoding=" + ENCODING)); - assertThat(s, containsString("fileSystem=" + fileSystem)); - } - - /** * Tests whether obtainFileSystem() can handle a null locator. */ @Test