Author: oheger
Date: Sun Sep 22 17:48:59 2013
New Revision: 1525398
URL: http://svn.apache.org/r1525398
Log:
Added AbsoluteNameLocationStrategy.
This FileLocationStrategy implementation checks whether the provided file name
is an absolute file name and whether this file exists.
Added:
commons/proper/configuration/trunk/src/main/java/org/apache/commons/configuration/io/AbsoluteNameLocationStrategy.java
commons/proper/configuration/trunk/src/test/java/org/apache/commons/configuration/io/TestAbsoluteNameLocationStrategy.java
Added:
commons/proper/configuration/trunk/src/main/java/org/apache/commons/configuration/io/AbsoluteNameLocationStrategy.java
URL:
http://svn.apache.org/viewvc/commons/proper/configuration/trunk/src/main/java/org/apache/commons/configuration/io/AbsoluteNameLocationStrategy.java?rev=1525398&view=auto
==============================================================================
---
commons/proper/configuration/trunk/src/main/java/org/apache/commons/configuration/io/AbsoluteNameLocationStrategy.java
(added)
+++
commons/proper/configuration/trunk/src/main/java/org/apache/commons/configuration/io/AbsoluteNameLocationStrategy.java
Sun Sep 22 17:48:59 2013
@@ -0,0 +1,58 @@
+/*
+ * 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.io.File;
+import java.net.URL;
+
+import org.apache.commons.lang3.StringUtils;
+
+/**
+ * <p>
+ * A specialized implementation of {@code FileLocationStrategy} which checks
+ * whether the provided file name is already an absolute file name.
+ * </p>
+ * <p>
+ * This strategy ignores the URL and the base path stored in the passed in
+ * {@link FileLocator}. It is only triggered by absolute names in the locator's
+ * {@code fileName} component.
+ * </p>
+ *
+ * @version $Id: $
+ * @since 2.0
+ */
+public class AbsoluteNameLocationStrategy implements FileLocationStrategy
+{
+ /**
+ * {@inheritDoc} This implementation constructs a {@code File} object from
+ * the locator's file name (if defined). If this results in an absolute
file
+ * name pointing to an existing file, the corresponding URL is returned.
+ */
+ public URL locate(FileSystem fileSystem, FileLocator locator)
+ {
+ if (StringUtils.isNotEmpty(locator.getFileName()))
+ {
+ File file = new File(locator.getFileName());
+ if (file.isAbsolute() && file.exists())
+ {
+ return FileLocatorUtils.convertFileToURL(file);
+ }
+ }
+
+ return null;
+ }
+}
Added:
commons/proper/configuration/trunk/src/test/java/org/apache/commons/configuration/io/TestAbsoluteNameLocationStrategy.java
URL:
http://svn.apache.org/viewvc/commons/proper/configuration/trunk/src/test/java/org/apache/commons/configuration/io/TestAbsoluteNameLocationStrategy.java?rev=1525398&view=auto
==============================================================================
---
commons/proper/configuration/trunk/src/test/java/org/apache/commons/configuration/io/TestAbsoluteNameLocationStrategy.java
(added)
+++
commons/proper/configuration/trunk/src/test/java/org/apache/commons/configuration/io/TestAbsoluteNameLocationStrategy.java
Sun Sep 22 17:48:59 2013
@@ -0,0 +1,100 @@
+/*
+ * 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.junit.Assert.assertEquals;
+import static org.junit.Assert.assertNull;
+
+import java.io.File;
+import java.net.URL;
+
+import org.apache.commons.configuration.ConfigurationAssert;
+import org.easymock.EasyMock;
+import org.junit.Before;
+import org.junit.Test;
+
+/**
+ * Test class for {@code AbsoluteNameLocationStrategy}.
+ *
+ * @version $Id: $
+ */
+public class TestAbsoluteNameLocationStrategy
+{
+ /** A mock for the file system. */
+ private FileSystem fileSystem;
+
+ /** The strategy to be tested. */
+ private AbsoluteNameLocationStrategy strategy;
+
+ @Before
+ public void setUp() throws Exception
+ {
+ fileSystem = EasyMock.createMock(FileSystem.class);
+ EasyMock.replay(fileSystem);
+ strategy = new AbsoluteNameLocationStrategy();
+ }
+
+ /**
+ * Tests a locate() operation if no file name is provided.
+ */
+ @Test
+ public void testNoFileName()
+ {
+ FileLocator locator = FileLocatorUtils.fileLocator().create();
+ assertNull("Got a URL", strategy.locate(fileSystem, locator));
+ }
+
+ /**
+ * Tests a locate() operation if no absolute file name is provided.
+ */
+ @Test
+ public void testNoAbsoluteFileName()
+ {
+ FileLocator locator =
+ FileLocatorUtils.fileLocator().fileName("test.xml").create();
+ assertNull("Got a URL", strategy.locate(fileSystem, locator));
+ }
+
+ /**
+ * Tests a locate() operation if an absolute file name is provided, but
this
+ * file does not exist.
+ */
+ @Test
+ public void testNonExistingAbsoluteFile()
+ {
+ File file = ConfigurationAssert.getOutFile("NotExistingFile.tst");
+ FileLocator locator =
+ FileLocatorUtils.fileLocator().fileName(file.getAbsolutePath())
+ .create();
+ assertNull("Got a URL", strategy.locate(fileSystem, locator));
+ }
+
+ /**
+ * Tests a successful locate() operation.
+ */
+ @Test
+ public void testExistingAbsoluteFile()
+ {
+ File file = ConfigurationAssert.getTestFile("test.xml");
+ FileLocator locator =
+ FileLocatorUtils.fileLocator().fileName(file.getAbsolutePath())
+ .create();
+ URL url = strategy.locate(fileSystem, locator);
+ assertEquals("Wrong URL", file.getAbsoluteFile(), FileLocatorUtils
+ .fileFromURL(url).getAbsoluteFile());
+ }
+}
