Clean up preferences module: remove duplicate resources, fix import/exports and correct javadocs.
git-svn-id: https://svn.apache.org/repos/asf/felix/trunk@607263 13f79535-47bb-0310-9956-ffa450edef68
diff --git a/prefs/pom.xml b/prefs/pom.xml
index a15f659..08d60ce 100644
--- a/prefs/pom.xml
+++ b/prefs/pom.xml
@@ -74,8 +74,8 @@
org.osgi.service.prefs;version=1.1
</Export-Package>
<Private-Package>
- org.apache.felix.prefs.*,
- org.apache.commons.codec.binary.*
+ org.apache.felix.prefs.impl,
+ org.apache.commons.codec.binary
</Private-Package>
<Bundle-Activator>
org.apache.felix.prefs.impl.PreferencesManager
diff --git a/prefs/src/main/java/org/apache/felix/prefs/ChangeSet.java b/prefs/src/main/java/org/apache/felix/prefs/ChangeSet.java
index 5101271..6dde7a7 100644
--- a/prefs/src/main/java/org/apache/felix/prefs/ChangeSet.java
+++ b/prefs/src/main/java/org/apache/felix/prefs/ChangeSet.java
@@ -18,10 +18,7 @@
*/
package org.apache.felix.prefs;
-import java.util.Collection;
-import java.util.Collections;
-import java.util.HashSet;
-import java.util.Set;
+import java.util.*;
/**
* This class keeps track of the changes to a preferences node.
@@ -45,7 +42,7 @@
/**
* Do we have changes?
- * @return
+ * @return True if there are any changes.
*/
public boolean hasChanges() {
return this.hasChanges;
diff --git a/prefs/src/main/java/org/apache/felix/prefs/PreferencesImpl.java b/prefs/src/main/java/org/apache/felix/prefs/PreferencesImpl.java
index 1f0bb15..ac19aa6 100644
--- a/prefs/src/main/java/org/apache/felix/prefs/PreferencesImpl.java
+++ b/prefs/src/main/java/org/apache/felix/prefs/PreferencesImpl.java
@@ -19,12 +19,7 @@
package org.apache.felix.prefs;
import java.io.UnsupportedEncodingException;
-import java.util.ArrayList;
-import java.util.Collection;
-import java.util.HashMap;
-import java.util.Iterator;
-import java.util.Map;
-import java.util.Set;
+import java.util.*;
import org.apache.commons.codec.binary.Base64;
import org.osgi.service.prefs.BackingStoreException;
@@ -99,7 +94,7 @@
/**
* Return the preferences description.
- * @return
+ * @return The preferences description.
*/
public PreferencesDescription getDescription() {
return this.description;
@@ -118,7 +113,7 @@
/**
* Return all children or an empty collection.
- * @return
+ * @return A collection containing the children.
*/
public Collection getChildren() {
return this.children.values();
@@ -416,7 +411,7 @@
* If the node already exists, it's just returned. If not
* it is created.
* @param pathName
- * @return
+ * @return The preferences impl for the path.
*/
public PreferencesImpl getOrCreateNode(String pathName) {
if ( pathName == null ) {
@@ -564,13 +559,12 @@
public String absolutePath() {
if (this.parent == null) {
return "/";
- } else {
- final String parentPath = this.parent.absolutePath();
- if ( parentPath.length() == 1 ) {
- return parentPath + this.name;
- }
- return parentPath + '/' + this.name;
}
+ final String parentPath = this.parent.absolutePath();
+ if ( parentPath.length() == 1 ) {
+ return parentPath + this.name;
+ }
+ return parentPath + '/' + this.name;
}
/**
diff --git a/prefs/src/main/java/org/apache/felix/prefs/impl/DataFileBackingStoreImpl.java b/prefs/src/main/java/org/apache/felix/prefs/impl/DataFileBackingStoreImpl.java
index c56162c..1e611de 100644
--- a/prefs/src/main/java/org/apache/felix/prefs/impl/DataFileBackingStoreImpl.java
+++ b/prefs/src/main/java/org/apache/felix/prefs/impl/DataFileBackingStoreImpl.java
@@ -18,19 +18,10 @@
*/
package org.apache.felix.prefs.impl;
-import java.io.File;
-import java.io.FileInputStream;
-import java.io.FileOutputStream;
-import java.io.IOException;
-import java.io.OutputStream;
-import java.util.ArrayList;
-import java.util.HashSet;
-import java.util.List;
-import java.util.Set;
+import java.io.*;
+import java.util.*;
-import org.apache.felix.prefs.BackingStoreManager;
-import org.apache.felix.prefs.PreferencesDescription;
-import org.apache.felix.prefs.PreferencesImpl;
+import org.apache.felix.prefs.*;
import org.osgi.framework.BundleContext;
import org.osgi.service.prefs.BackingStoreException;
@@ -66,7 +57,7 @@
}
/**
- * @see org.apache.felix.sandbox.preferences.BackingStore#availableBundles()
+ * @see org.apache.felix.prefs.BackingStore#availableBundles()
*/
public Long[] availableBundles() {
// If the root directory is not available, then we do nothing!
@@ -110,7 +101,7 @@
}
/**
- * @see org.apache.felix.sandbox.preferences.BackingStore#remove(java.lang.Long)
+ * @see org.apache.felix.prefs.BackingStore#remove(java.lang.Long)
*/
public void remove(Long bundleId) throws BackingStoreException {
this.checkAccess();
@@ -128,7 +119,7 @@
}
/**
- * @see org.apache.felix.sandbox.preferences.BackingStore#loadAll(org.apache.felix.sandbox.preferences.BackingStoreManager, java.lang.Long)
+ * @see org.apache.felix.prefs.BackingStore#loadAll(org.apache.felix.prefs.BackingStoreManager, java.lang.Long)
*/
public PreferencesImpl[] loadAll(BackingStoreManager manager, Long bundleId) throws BackingStoreException {
this.checkAccess();
@@ -156,7 +147,7 @@
}
/**
- * @see org.apache.felix.sandbox.preferences.BackingStore#load(org.apache.felix.sandbox.preferences.BackingStoreManager, org.apache.felix.sandbox.preferences.PreferencesDescription)
+ * @see org.apache.felix.prefs.BackingStore#load(org.apache.felix.prefs.BackingStoreManager, org.apache.felix.prefs.PreferencesDescription)
*/
public PreferencesImpl load(BackingStoreManager manager, PreferencesDescription desc) throws BackingStoreException {
this.checkAccess();
diff --git a/prefs/src/main/java/org/apache/felix/prefs/impl/PreferencesManager.java b/prefs/src/main/java/org/apache/felix/prefs/impl/PreferencesManager.java
index fcc56a4..9976b5a 100644
--- a/prefs/src/main/java/org/apache/felix/prefs/impl/PreferencesManager.java
+++ b/prefs/src/main/java/org/apache/felix/prefs/impl/PreferencesManager.java
@@ -18,20 +18,10 @@
*/
package org.apache.felix.prefs.impl;
-import java.util.HashMap;
-import java.util.Iterator;
-import java.util.Map;
+import java.util.*;
-import org.apache.felix.prefs.BackingStore;
-import org.apache.felix.prefs.BackingStoreManager;
-import org.apache.felix.prefs.PreferencesImpl;
-import org.osgi.framework.Bundle;
-import org.osgi.framework.BundleActivator;
-import org.osgi.framework.BundleContext;
-import org.osgi.framework.BundleEvent;
-import org.osgi.framework.BundleListener;
-import org.osgi.framework.ServiceFactory;
-import org.osgi.framework.ServiceRegistration;
+import org.apache.felix.prefs.*;
+import org.osgi.framework.*;
import org.osgi.service.log.LogService;
import org.osgi.service.prefs.BackingStoreException;
import org.osgi.service.prefs.PreferencesService;
@@ -194,7 +184,7 @@
}
/**
- * @see org.apache.felix.sandbox.preferences.BackingStoreManager#getStore()
+ * @see org.apache.felix.prefs.BackingStoreManager#getStore()
*/
public BackingStore getStore() {
// has the service changed?
diff --git a/prefs/src/main/java/org/apache/felix/prefs/impl/StreamBackingStoreImpl.java b/prefs/src/main/java/org/apache/felix/prefs/impl/StreamBackingStoreImpl.java
index b784ce9..7dcf9e7 100644
--- a/prefs/src/main/java/org/apache/felix/prefs/impl/StreamBackingStoreImpl.java
+++ b/prefs/src/main/java/org/apache/felix/prefs/impl/StreamBackingStoreImpl.java
@@ -18,18 +18,10 @@
*/
package org.apache.felix.prefs.impl;
-import java.io.IOException;
-import java.io.InputStream;
-import java.io.ObjectInputStream;
-import java.io.ObjectOutputStream;
-import java.io.OutputStream;
-import java.util.Collection;
-import java.util.Iterator;
-import java.util.Map;
+import java.io.*;
+import java.util.*;
-import org.apache.felix.prefs.BackingStore;
-import org.apache.felix.prefs.PreferencesDescription;
-import org.apache.felix.prefs.PreferencesImpl;
+import org.apache.felix.prefs.*;
import org.osgi.framework.BundleContext;
import org.osgi.service.prefs.BackingStoreException;
@@ -60,7 +52,7 @@
throws IOException;
/**
- * @see org.apache.felix.sandbox.preferences.BackingStore#store(org.apache.felix.sandbox.preferences.PreferencesImpl)
+ * @see org.apache.felix.prefs.BackingStore#store(org.apache.felix.prefs.PreferencesImpl)
*/
public void store(PreferencesImpl prefs) throws BackingStoreException {
// do we need to store at all?
@@ -104,7 +96,7 @@
}
/**
- * @see org.apache.felix.sandbox.preferences.BackingStore#update(org.apache.felix.sandbox.preferences.PreferencesImpl)
+ * @see org.apache.felix.prefs.BackingStore#update(org.apache.felix.prefs.PreferencesImpl)
*/
public void update(PreferencesImpl prefs) throws BackingStoreException {
final PreferencesImpl root = this.load(prefs.getBackingStoreManager(), prefs.getDescription());
diff --git a/prefs/src/main/resources/META-INF/LICENSE b/prefs/src/main/resources/META-INF/LICENSE
deleted file mode 100644
index d645695..0000000
--- a/prefs/src/main/resources/META-INF/LICENSE
+++ /dev/null
@@ -1,202 +0,0 @@
-
- Apache License
- Version 2.0, January 2004
- http://www.apache.org/licenses/
-
- TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
-
- 1. Definitions.
-
- "License" shall mean the terms and conditions for use, reproduction,
- and distribution as defined by Sections 1 through 9 of this document.
-
- "Licensor" shall mean the copyright owner or entity authorized by
- the copyright owner that is granting the License.
-
- "Legal Entity" shall mean the union of the acting entity and all
- other entities that control, are controlled by, or are under common
- control with that entity. For the purposes of this definition,
- "control" means (i) the power, direct or indirect, to cause the
- direction or management of such entity, whether by contract or
- otherwise, or (ii) ownership of fifty percent (50%) or more of the
- outstanding shares, or (iii) beneficial ownership of such entity.
-
- "You" (or "Your") shall mean an individual or Legal Entity
- exercising permissions granted by this License.
-
- "Source" form shall mean the preferred form for making modifications,
- including but not limited to software source code, documentation
- source, and configuration files.
-
- "Object" form shall mean any form resulting from mechanical
- transformation or translation of a Source form, including but
- not limited to compiled object code, generated documentation,
- and conversions to other media types.
-
- "Work" shall mean the work of authorship, whether in Source or
- Object form, made available under the License, as indicated by a
- copyright notice that is included in or attached to the work
- (an example is provided in the Appendix below).
-
- "Derivative Works" shall mean any work, whether in Source or Object
- form, that is based on (or derived from) the Work and for which the
- editorial revisions, annotations, elaborations, or other modifications
- represent, as a whole, an original work of authorship. For the purposes
- of this License, Derivative Works shall not include works that remain
- separable from, or merely link (or bind by name) to the interfaces of,
- the Work and Derivative Works thereof.
-
- "Contribution" shall mean any work of authorship, including
- the original version of the Work and any modifications or additions
- to that Work or Derivative Works thereof, that is intentionally
- submitted to Licensor for inclusion in the Work by the copyright owner
- or by an individual or Legal Entity authorized to submit on behalf of
- the copyright owner. For the purposes of this definition, "submitted"
- means any form of electronic, verbal, or written communication sent
- to the Licensor or its representatives, including but not limited to
- communication on electronic mailing lists, source code control systems,
- and issue tracking systems that are managed by, or on behalf of, the
- Licensor for the purpose of discussing and improving the Work, but
- excluding communication that is conspicuously marked or otherwise
- designated in writing by the copyright owner as "Not a Contribution."
-
- "Contributor" shall mean Licensor and any individual or Legal Entity
- on behalf of whom a Contribution has been received by Licensor and
- subsequently incorporated within the Work.
-
- 2. Grant of Copyright License. Subject to the terms and conditions of
- this License, each Contributor hereby grants to You a perpetual,
- worldwide, non-exclusive, no-charge, royalty-free, irrevocable
- copyright license to reproduce, prepare Derivative Works of,
- publicly display, publicly perform, sublicense, and distribute the
- Work and such Derivative Works in Source or Object form.
-
- 3. Grant of Patent License. Subject to the terms and conditions of
- this License, each Contributor hereby grants to You a perpetual,
- worldwide, non-exclusive, no-charge, royalty-free, irrevocable
- (except as stated in this section) patent license to make, have made,
- use, offer to sell, sell, import, and otherwise transfer the Work,
- where such license applies only to those patent claims licensable
- by such Contributor that are necessarily infringed by their
- Contribution(s) alone or by combination of their Contribution(s)
- with the Work to which such Contribution(s) was submitted. If You
- institute patent litigation against any entity (including a
- cross-claim or counterclaim in a lawsuit) alleging that the Work
- or a Contribution incorporated within the Work constitutes direct
- or contributory patent infringement, then any patent licenses
- granted to You under this License for that Work shall terminate
- as of the date such litigation is filed.
-
- 4. Redistribution. You may reproduce and distribute copies of the
- Work or Derivative Works thereof in any medium, with or without
- modifications, and in Source or Object form, provided that You
- meet the following conditions:
-
- (a) You must give any other recipients of the Work or
- Derivative Works a copy of this License; and
-
- (b) You must cause any modified files to carry prominent notices
- stating that You changed the files; and
-
- (c) You must retain, in the Source form of any Derivative Works
- that You distribute, all copyright, patent, trademark, and
- attribution notices from the Source form of the Work,
- excluding those notices that do not pertain to any part of
- the Derivative Works; and
-
- (d) If the Work includes a "NOTICE" text file as part of its
- distribution, then any Derivative Works that You distribute must
- include a readable copy of the attribution notices contained
- within such NOTICE file, excluding those notices that do not
- pertain to any part of the Derivative Works, in at least one
- of the following places: within a NOTICE text file distributed
- as part of the Derivative Works; within the Source form or
- documentation, if provided along with the Derivative Works; or,
- within a display generated by the Derivative Works, if and
- wherever such third-party notices normally appear. The contents
- of the NOTICE file are for informational purposes only and
- do not modify the License. You may add Your own attribution
- notices within Derivative Works that You distribute, alongside
- or as an addendum to the NOTICE text from the Work, provided
- that such additional attribution notices cannot be construed
- as modifying the License.
-
- You may add Your own copyright statement to Your modifications and
- may provide additional or different license terms and conditions
- for use, reproduction, or distribution of Your modifications, or
- for any such Derivative Works as a whole, provided Your use,
- reproduction, and distribution of the Work otherwise complies with
- the conditions stated in this License.
-
- 5. Submission of Contributions. Unless You explicitly state otherwise,
- any Contribution intentionally submitted for inclusion in the Work
- by You to the Licensor shall be under the terms and conditions of
- this License, without any additional terms or conditions.
- Notwithstanding the above, nothing herein shall supersede or modify
- the terms of any separate license agreement you may have executed
- with Licensor regarding such Contributions.
-
- 6. Trademarks. This License does not grant permission to use the trade
- names, trademarks, service marks, or product names of the Licensor,
- except as required for reasonable and customary use in describing the
- origin of the Work and reproducing the content of the NOTICE file.
-
- 7. Disclaimer of Warranty. Unless required by applicable law or
- agreed to in writing, Licensor provides the Work (and each
- Contributor provides its Contributions) on an "AS IS" BASIS,
- WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
- implied, including, without limitation, any warranties or conditions
- of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
- PARTICULAR PURPOSE. You are solely responsible for determining the
- appropriateness of using or redistributing the Work and assume any
- risks associated with Your exercise of permissions under this License.
-
- 8. Limitation of Liability. In no event and under no legal theory,
- whether in tort (including negligence), contract, or otherwise,
- unless required by applicable law (such as deliberate and grossly
- negligent acts) or agreed to in writing, shall any Contributor be
- liable to You for damages, including any direct, indirect, special,
- incidental, or consequential damages of any character arising as a
- result of this License or out of the use or inability to use the
- Work (including but not limited to damages for loss of goodwill,
- work stoppage, computer failure or malfunction, or any and all
- other commercial damages or losses), even if such Contributor
- has been advised of the possibility of such damages.
-
- 9. Accepting Warranty or Additional Liability. While redistributing
- the Work or Derivative Works thereof, You may choose to offer,
- and charge a fee for, acceptance of support, warranty, indemnity,
- or other liability obligations and/or rights consistent with this
- License. However, in accepting such obligations, You may act only
- on Your own behalf and on Your sole responsibility, not on behalf
- of any other Contributor, and only if You agree to indemnify,
- defend, and hold each Contributor harmless for any liability
- incurred by, or claims asserted against, such Contributor by reason
- of your accepting any such warranty or additional liability.
-
- END OF TERMS AND CONDITIONS
-
- APPENDIX: How to apply the Apache License to your work.
-
- To apply the Apache License to your work, attach the following
- boilerplate notice, with the fields enclosed by brackets "[]"
- replaced with your own identifying information. (Don't include
- the brackets!) The text should be enclosed in the appropriate
- comment syntax for the file format. We also recommend that a
- file or class name and description of purpose be included on the
- same "printed page" as the copyright notice for easier
- identification within third-party archives.
-
- Copyright [yyyy] [name of copyright owner]
-
- Licensed 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.
diff --git a/prefs/src/main/resources/META-INF/NOTICE b/prefs/src/main/resources/META-INF/NOTICE
deleted file mode 100644
index a88ae90..0000000
--- a/prefs/src/main/resources/META-INF/NOTICE
+++ /dev/null
@@ -1,5 +0,0 @@
-Apache Felix Preferences Service
-Copyright 2007 The Apache Software Foundation
-
-This product includes software developed at
-The Apache Software Foundation (http://www.apache.org/).