You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@sling.apache.org by cz...@apache.org on 2017/06/08 13:53:39 UTC
svn commit: r1798061 - in /sling/whiteboard/cziegeler:
feature-support/src/main/java/org/apache/sling/feature/support/
feature/src/main/java/org/apache/sling/feature/
feature/src/main/java/org/apache/sling/feature/json/
Author: cziegeler
Date: Thu Jun 8 13:53:38 2017
New Revision: 1798061
URL: http://svn.apache.org/viewvc?rev=1798061&view=rev
Log:
Fix javadocs
Modified:
sling/whiteboard/cziegeler/feature-support/src/main/java/org/apache/sling/feature/support/ArtifactManagerConfig.java
sling/whiteboard/cziegeler/feature-support/src/main/java/org/apache/sling/feature/support/ConfigurationUtil.java
sling/whiteboard/cziegeler/feature-support/src/main/java/org/apache/sling/feature/support/FeatureUtil.java
sling/whiteboard/cziegeler/feature/src/main/java/org/apache/sling/feature/ArtifactId.java
sling/whiteboard/cziegeler/feature/src/main/java/org/apache/sling/feature/Configuration.java
sling/whiteboard/cziegeler/feature/src/main/java/org/apache/sling/feature/json/ApplicationJSONWriter.java
sling/whiteboard/cziegeler/feature/src/main/java/org/apache/sling/feature/json/ConfigurationJSONReader.java
sling/whiteboard/cziegeler/feature/src/main/java/org/apache/sling/feature/json/ConfigurationJSONWriter.java
sling/whiteboard/cziegeler/feature/src/main/java/org/apache/sling/feature/json/FeatureJSONWriter.java
sling/whiteboard/cziegeler/feature/src/main/java/org/apache/sling/feature/json/JSONReaderBase.java
sling/whiteboard/cziegeler/feature/src/main/java/org/apache/sling/feature/json/JSONWriterBase.java
Modified: sling/whiteboard/cziegeler/feature-support/src/main/java/org/apache/sling/feature/support/ArtifactManagerConfig.java
URL: http://svn.apache.org/viewvc/sling/whiteboard/cziegeler/feature-support/src/main/java/org/apache/sling/feature/support/ArtifactManagerConfig.java?rev=1798061&r1=1798060&r2=1798061&view=diff
==============================================================================
--- sling/whiteboard/cziegeler/feature-support/src/main/java/org/apache/sling/feature/support/ArtifactManagerConfig.java (original)
+++ sling/whiteboard/cziegeler/feature-support/src/main/java/org/apache/sling/feature/support/ArtifactManagerConfig.java Thu Jun 8 13:53:38 2017
@@ -58,7 +58,7 @@ public class ArtifactManagerConfig imple
/**
* Set the repository urls
- * @param repositoryUrl The repository urls
+ * @param urls The repository urls
*/
public void setRepositoryUrls(final String[] urls) {
if ( urls == null || urls.length == 0 ) {
Modified: sling/whiteboard/cziegeler/feature-support/src/main/java/org/apache/sling/feature/support/ConfigurationUtil.java
URL: http://svn.apache.org/viewvc/sling/whiteboard/cziegeler/feature-support/src/main/java/org/apache/sling/feature/support/ConfigurationUtil.java?rev=1798061&r1=1798060&r2=1798061&view=diff
==============================================================================
--- sling/whiteboard/cziegeler/feature-support/src/main/java/org/apache/sling/feature/support/ConfigurationUtil.java (original)
+++ sling/whiteboard/cziegeler/feature-support/src/main/java/org/apache/sling/feature/support/ConfigurationUtil.java Thu Jun 8 13:53:38 2017
@@ -20,13 +20,12 @@ import java.io.IOException;
import java.io.OutputStream;
import java.io.OutputStreamWriter;
import java.io.Writer;
-import java.util.List;
import java.util.Map;
import java.util.jar.JarOutputStream;
import java.util.jar.Manifest;
import java.util.zip.ZipEntry;
-import org.apache.sling.feature.Configuration;
+import org.apache.sling.feature.Configurations;
import org.apache.sling.feature.json.ConfigurationJSONWriter;
import org.osgi.framework.Constants;
@@ -51,7 +50,7 @@ public class ConfigurationUtil {
* @throws IOException If something goes wrong
*/
public static void createConfiguratorBundle(final OutputStream os,
- final List<Configuration> configurations,
+ final Configurations configurations,
final String symbolicName,
final String version,
final Map<String, String> additionalAttributes)
Modified: sling/whiteboard/cziegeler/feature-support/src/main/java/org/apache/sling/feature/support/FeatureUtil.java
URL: http://svn.apache.org/viewvc/sling/whiteboard/cziegeler/feature-support/src/main/java/org/apache/sling/feature/support/FeatureUtil.java?rev=1798061&r1=1798060&r2=1798061&view=diff
==============================================================================
--- sling/whiteboard/cziegeler/feature-support/src/main/java/org/apache/sling/feature/support/FeatureUtil.java (original)
+++ sling/whiteboard/cziegeler/feature-support/src/main/java/org/apache/sling/feature/support/FeatureUtil.java Thu Jun 8 13:53:38 2017
@@ -201,6 +201,7 @@ public class FeatureUtil {
* Read the features and assemble the application
* @param featureFiles The feature files.
* @param artifactManager The artifact manager
+ * @return The assembled application
* @throws IOException If a feature can't be read or no feature is found.
* @see #getFeatureFiles(File, String...)
*/
Modified: sling/whiteboard/cziegeler/feature/src/main/java/org/apache/sling/feature/ArtifactId.java
URL: http://svn.apache.org/viewvc/sling/whiteboard/cziegeler/feature/src/main/java/org/apache/sling/feature/ArtifactId.java?rev=1798061&r1=1798060&r2=1798061&view=diff
==============================================================================
--- sling/whiteboard/cziegeler/feature/src/main/java/org/apache/sling/feature/ArtifactId.java (original)
+++ sling/whiteboard/cziegeler/feature/src/main/java/org/apache/sling/feature/ArtifactId.java Thu Jun 8 13:53:38 2017
@@ -91,7 +91,7 @@ public class ArtifactId implements Compa
/**
* Create a new artifact from a maven id,
* group-id '/' artifact-id [ '/' [version] [ '/' [type] [ '/' classifier ] ] ] ]
- * @param content The id
+ * @param coordinates The id
* @return A new artifact
* @throws IllegalArgumentException If the id is not valid
*/
Modified: sling/whiteboard/cziegeler/feature/src/main/java/org/apache/sling/feature/Configuration.java
URL: http://svn.apache.org/viewvc/sling/whiteboard/cziegeler/feature/src/main/java/org/apache/sling/feature/Configuration.java?rev=1798061&r1=1798060&r2=1798061&view=diff
==============================================================================
--- sling/whiteboard/cziegeler/feature/src/main/java/org/apache/sling/feature/Configuration.java (original)
+++ sling/whiteboard/cziegeler/feature/src/main/java/org/apache/sling/feature/Configuration.java Thu Jun 8 13:53:38 2017
@@ -25,7 +25,7 @@ import java.util.Hashtable;
* <ul>
* <li>a pid
* <li>or a factory pid and a name
- * <ul>
+ * </ul>
* and properties.
*/
public class Configuration
Modified: sling/whiteboard/cziegeler/feature/src/main/java/org/apache/sling/feature/json/ApplicationJSONWriter.java
URL: http://svn.apache.org/viewvc/sling/whiteboard/cziegeler/feature/src/main/java/org/apache/sling/feature/json/ApplicationJSONWriter.java?rev=1798061&r1=1798060&r2=1798061&view=diff
==============================================================================
--- sling/whiteboard/cziegeler/feature/src/main/java/org/apache/sling/feature/json/ApplicationJSONWriter.java (original)
+++ sling/whiteboard/cziegeler/feature/src/main/java/org/apache/sling/feature/json/ApplicationJSONWriter.java Thu Jun 8 13:53:38 2017
@@ -18,8 +18,6 @@ package org.apache.sling.feature.json;
import java.io.IOException;
import java.io.Writer;
-import java.util.ArrayList;
-import java.util.List;
import javax.json.Json;
import javax.json.stream.JsonGenerator;
@@ -27,6 +25,7 @@ import javax.json.stream.JsonGenerator;
import org.apache.sling.feature.Application;
import org.apache.sling.feature.ArtifactId;
import org.apache.sling.feature.Configuration;
+import org.apache.sling.feature.Configurations;
/**
@@ -39,7 +38,7 @@ public class ApplicationJSONWriter exten
* The writer is not closed.
* @param writer Writer
* @param app The application
- * @throws IOException
+ * @throws IOException If writing fails
*/
public static void write(final Writer writer, final Application app)
throws IOException {
@@ -70,7 +69,7 @@ public class ApplicationJSONWriter exten
writeBundles(w, app.getBundles(), app.getConfigurations());
// configurations
- final List<Configuration> cfgs = new ArrayList<>();
+ final Configurations cfgs = new Configurations();
for(final Configuration cfg : app.getConfigurations()) {
final String artifactProp = (String)cfg.getProperties().get(Configuration.PROP_ARTIFACT);
if ( artifactProp == null ) {
Modified: sling/whiteboard/cziegeler/feature/src/main/java/org/apache/sling/feature/json/ConfigurationJSONReader.java
URL: http://svn.apache.org/viewvc/sling/whiteboard/cziegeler/feature/src/main/java/org/apache/sling/feature/json/ConfigurationJSONReader.java?rev=1798061&r1=1798060&r2=1798061&view=diff
==============================================================================
--- sling/whiteboard/cziegeler/feature/src/main/java/org/apache/sling/feature/json/ConfigurationJSONReader.java (original)
+++ sling/whiteboard/cziegeler/feature/src/main/java/org/apache/sling/feature/json/ConfigurationJSONReader.java Thu Jun 8 13:53:38 2017
@@ -19,16 +19,14 @@ package org.apache.sling.feature.json;
import java.io.IOException;
import java.io.Reader;
import java.io.StringReader;
-import java.util.ArrayList;
import java.util.Collections;
-import java.util.List;
import java.util.Map;
import javax.json.Json;
import javax.json.JsonObject;
import org.apache.felix.configurator.impl.json.JSONUtil;
-import org.apache.sling.feature.Configuration;
+import org.apache.sling.feature.Configurations;
/**
* JSON Reader for configurations.
@@ -44,7 +42,7 @@ public class ConfigurationJSONReader ext
* @return The read configurations
* @throws IOException If an IO errors occurs or the JSON is invalid.
*/
- public static List<Configuration> read(final Reader reader, final String location)
+ public static Configurations read(final Reader reader, final String location)
throws IOException {
try {
final ConfigurationJSONReader mr = new ConfigurationJSONReader(location);
@@ -62,8 +60,8 @@ public class ConfigurationJSONReader ext
super(location);
}
- List<Configuration> readConfigurations(final Reader reader) throws IOException {
- final List<Configuration> result = new ArrayList<>();
+ Configurations readConfigurations(final Reader reader) throws IOException {
+ final Configurations result = new Configurations();
final JsonObject json = Json.createReader(new StringReader(minify(reader))).readObject();
Modified: sling/whiteboard/cziegeler/feature/src/main/java/org/apache/sling/feature/json/ConfigurationJSONWriter.java
URL: http://svn.apache.org/viewvc/sling/whiteboard/cziegeler/feature/src/main/java/org/apache/sling/feature/json/ConfigurationJSONWriter.java?rev=1798061&r1=1798060&r2=1798061&view=diff
==============================================================================
--- sling/whiteboard/cziegeler/feature/src/main/java/org/apache/sling/feature/json/ConfigurationJSONWriter.java (original)
+++ sling/whiteboard/cziegeler/feature/src/main/java/org/apache/sling/feature/json/ConfigurationJSONWriter.java Thu Jun 8 13:53:38 2017
@@ -18,12 +18,11 @@ package org.apache.sling.feature.json;
import java.io.IOException;
import java.io.Writer;
-import java.util.List;
import javax.json.Json;
import javax.json.stream.JsonGenerator;
-import org.apache.sling.feature.Configuration;
+import org.apache.sling.feature.Configurations;
/**
@@ -36,15 +35,15 @@ public class ConfigurationJSONWriter ext
* The writer is not closed.
* @param writer Writer
* @param configs List of configurations
- * @throws IOException
+ * @throws IOException If writing fails
*/
- public static void write(final Writer writer, final List<Configuration> configs)
+ public static void write(final Writer writer, final Configurations configs)
throws IOException {
final ConfigurationJSONWriter w = new ConfigurationJSONWriter();
w.writeConfigurations(writer, configs);
}
- private void writeConfigurations(final Writer writer, final List<Configuration> configs)
+ private void writeConfigurations(final Writer writer, final Configurations configs)
throws IOException {
final JsonGenerator w = Json.createGenerator(writer);
w.writeStartObject();
Modified: sling/whiteboard/cziegeler/feature/src/main/java/org/apache/sling/feature/json/FeatureJSONWriter.java
URL: http://svn.apache.org/viewvc/sling/whiteboard/cziegeler/feature/src/main/java/org/apache/sling/feature/json/FeatureJSONWriter.java?rev=1798061&r1=1798060&r2=1798061&view=diff
==============================================================================
--- sling/whiteboard/cziegeler/feature/src/main/java/org/apache/sling/feature/json/FeatureJSONWriter.java (original)
+++ sling/whiteboard/cziegeler/feature/src/main/java/org/apache/sling/feature/json/FeatureJSONWriter.java Thu Jun 8 13:53:38 2017
@@ -18,7 +18,6 @@ package org.apache.sling.feature.json;
import java.io.IOException;
import java.io.Writer;
-import java.util.ArrayList;
import java.util.List;
import java.util.Map;
@@ -28,6 +27,7 @@ import javax.json.stream.JsonGenerator;
import org.apache.sling.feature.ArtifactId;
import org.apache.sling.feature.Capability;
import org.apache.sling.feature.Configuration;
+import org.apache.sling.feature.Configurations;
import org.apache.sling.feature.Feature;
import org.apache.sling.feature.Include;
import org.apache.sling.feature.Requirement;
@@ -43,7 +43,7 @@ public class FeatureJSONWriter extends J
* The writer is not closed.
* @param writer Writer
* @param feature Feature
- * @throws IOException
+ * @throws IOException If writing fails
*/
public static void write(final Writer writer, final Feature feature)
throws IOException {
@@ -173,7 +173,7 @@ public class FeatureJSONWriter extends J
writeBundles(w, feature.getBundles(), feature.getConfigurations());
// configurations
- final List<Configuration> cfgs = new ArrayList<>();
+ final Configurations cfgs = new Configurations();
for(final Configuration cfg : feature.getConfigurations()) {
final String artifactProp = (String)cfg.getProperties().get(Configuration.PROP_ARTIFACT);
if ( artifactProp == null ) {
Modified: sling/whiteboard/cziegeler/feature/src/main/java/org/apache/sling/feature/json/JSONReaderBase.java
URL: http://svn.apache.org/viewvc/sling/whiteboard/cziegeler/feature/src/main/java/org/apache/sling/feature/json/JSONReaderBase.java?rev=1798061&r1=1798060&r2=1798061&view=diff
==============================================================================
--- sling/whiteboard/cziegeler/feature/src/main/java/org/apache/sling/feature/json/JSONReaderBase.java (original)
+++ sling/whiteboard/cziegeler/feature/src/main/java/org/apache/sling/feature/json/JSONReaderBase.java Thu Jun 8 13:53:38 2017
@@ -42,6 +42,7 @@ import org.apache.sling.feature.Artifact
import org.apache.sling.feature.ArtifactId;
import org.apache.sling.feature.Bundles;
import org.apache.sling.feature.Configuration;
+import org.apache.sling.feature.Configurations;
import org.apache.sling.feature.Extension;
import org.apache.sling.feature.ExtensionType;
import org.apache.sling.feature.Extensions;
@@ -85,12 +86,14 @@ abstract class JSONReaderBase {
/**
* Read the bundles / start levels section
* @param map The map describing the feature
+ * @param container The bundles container
+ * @param configContainer The configurations container
* @throws IOException If the json is invalid.
*/
protected void readBundles(
final Map<String, Object> map,
final Bundles container,
- final List<Configuration> configContainer) throws IOException {
+ final Configurations configContainer) throws IOException {
if ( map.containsKey(JSONConstants.FEATURE_BUNDLES)) {
final Object bundlesObj = map.get(JSONConstants.FEATURE_BUNDLES);
checkType(JSONConstants.FEATURE_BUNDLES, bundlesObj, Map.class);
@@ -120,7 +123,7 @@ abstract class JSONReaderBase {
final String artifactType,
final List<Artifact> artifacts,
final Object listObj,
- final List<Configuration> container)
+ final Configurations container)
throws IOException {
checkType(section, listObj, List.class);
@SuppressWarnings("unchecked")
@@ -159,7 +162,7 @@ abstract class JSONReaderBase {
protected void addConfigurations(final Map<String, Object> map,
final Artifact artifact,
- final List<Configuration> container) throws IOException {
+ final Configurations container) throws IOException {
final JSONUtil.Report report = new JSONUtil.Report();
@SuppressWarnings("unchecked")
final List<Config> configs = JSONUtil.readConfigurationsJSON(new TypeConverter(null),
@@ -215,7 +218,7 @@ abstract class JSONReaderBase {
protected void readConfigurations(final Map<String, Object> map,
- final List<Configuration> container) throws IOException {
+ final Configurations container) throws IOException {
if ( map.containsKey(JSONConstants.FEATURE_CONFIGURATIONS) ) {
checkType(JSONConstants.FEATURE_CONFIGURATIONS, map.get(JSONConstants.FEATURE_CONFIGURATIONS), Map.class);
addConfigurations(map, null, container);
@@ -244,7 +247,7 @@ abstract class JSONReaderBase {
protected void readExtensions(final Map<String, Object> map,
final List<String> keywords,
final Extensions container,
- final List<Configuration> configContainer) throws IOException {
+ final Configurations configContainer) throws IOException {
final Set<String> keySet = new HashSet<>(map.keySet());
keySet.removeAll(keywords);
// the remaining keys are considered extensions!
Modified: sling/whiteboard/cziegeler/feature/src/main/java/org/apache/sling/feature/json/JSONWriterBase.java
URL: http://svn.apache.org/viewvc/sling/whiteboard/cziegeler/feature/src/main/java/org/apache/sling/feature/json/JSONWriterBase.java?rev=1798061&r1=1798060&r2=1798061&view=diff
==============================================================================
--- sling/whiteboard/cziegeler/feature/src/main/java/org/apache/sling/feature/json/JSONWriterBase.java (original)
+++ sling/whiteboard/cziegeler/feature/src/main/java/org/apache/sling/feature/json/JSONWriterBase.java Thu Jun 8 13:53:38 2017
@@ -18,7 +18,6 @@ package org.apache.sling.feature.json;
import java.io.StringReader;
import java.lang.reflect.Array;
-import java.util.ArrayList;
import java.util.Enumeration;
import java.util.List;
import java.util.Map;
@@ -30,6 +29,7 @@ import javax.json.stream.JsonGenerator;
import org.apache.sling.feature.Artifact;
import org.apache.sling.feature.Bundles;
import org.apache.sling.feature.Configuration;
+import org.apache.sling.feature.Configurations;
import org.apache.sling.feature.Extension;
import org.apache.sling.feature.ExtensionType;
import org.apache.sling.feature.KeyValueMap;
@@ -43,7 +43,7 @@ abstract class JSONWriterBase {
protected void writeBundles(final JsonGenerator w,
final Bundles bundles,
- final List<Configuration> allConfigs) {
+ final Configurations allConfigs) {
// bundles
if ( !bundles.getBundlesByStartLevel().isEmpty() ) {
w.writeStartObject(JSONConstants.FEATURE_BUNDLES);
@@ -51,7 +51,7 @@ abstract class JSONWriterBase {
w.writeStartArray(String.valueOf(entry.getKey()));
for(final Artifact artifact : entry.getValue()) {
- final List<Configuration> cfgs = new ArrayList<>();
+ final Configurations cfgs = new Configurations();
for(final Configuration cfg : allConfigs) {
final String artifactProp = (String)cfg.getProperties().get(Configuration.PROP_ARTIFACT);
if ( artifact.getId().toMvnId().equals(artifactProp) ) {
@@ -84,7 +84,7 @@ abstract class JSONWriterBase {
* @param w The json generator
* @param cfgs The list of configurations
*/
- protected void writeConfigurations(final JsonGenerator w, final List<Configuration> cfgs) {
+ protected void writeConfigurations(final JsonGenerator w, final Configurations cfgs) {
if ( !cfgs.isEmpty() ) {
w.writeStartObject(JSONConstants.FEATURE_CONFIGURATIONS);
@@ -99,7 +99,7 @@ abstract class JSONWriterBase {
* @param w The json generator
* @param cfgs The list of configurations
*/
- protected void writeConfigurationsMap(final JsonGenerator w, final List<Configuration> cfgs) {
+ protected void writeConfigurationsMap(final JsonGenerator w, final Configurations cfgs) {
for(final Configuration cfg : cfgs) {
final String key;
if ( cfg.isFactoryConfiguration() ) {
@@ -194,7 +194,7 @@ abstract class JSONWriterBase {
protected void writeExtensions(final JsonGenerator w,
final List<Extension> extensions,
- final List<Configuration> allConfigs) {
+ final Configurations allConfigs) {
for(final Extension ext : extensions) {
final String key = ext.getName() + ":" + ext.getType().name() + "|" + ext.isOptional();
if ( ext.getType() == ExtensionType.JSON ) {
@@ -208,7 +208,7 @@ abstract class JSONWriterBase {
} else {
w.writeStartArray(key);
for(final Artifact artifact : ext.getArtifacts()) {
- final List<Configuration> artifactCfgs = new ArrayList<>();
+ final Configurations artifactCfgs = new Configurations();
for(final Configuration cfg : allConfigs) {
final String artifactProp = (String)cfg.getProperties().get(Configuration.PROP_ARTIFACT);
if ( artifact.getId().toMvnId().equals(artifactProp) ) {