You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@karaf.apache.org by jb...@apache.org on 2016/03/15 00:20:10 UTC
[5/5] karaf git commit: KARAF-4392 - Upgrade to maven-javadoc-plugin
2.10.3 and clean javadoc comments
KARAF-4392 - Upgrade to maven-javadoc-plugin 2.10.3 and clean javadoc comments
Project: http://git-wip-us.apache.org/repos/asf/karaf/repo
Commit: http://git-wip-us.apache.org/repos/asf/karaf/commit/8a1e7574
Tree: http://git-wip-us.apache.org/repos/asf/karaf/tree/8a1e7574
Diff: http://git-wip-us.apache.org/repos/asf/karaf/diff/8a1e7574
Branch: refs/heads/master
Commit: 8a1e7574da6796f7e7b4f6b31542ae3bb2c1788a
Parents: 9d136eb
Author: Jean-Baptiste Onofré <jb...@apache.org>
Authored: Thu Mar 10 10:18:08 2016 +0100
Committer: Jean-Baptiste Onofré <jb...@apache.org>
Committed: Tue Mar 15 00:19:50 2016 +0100
----------------------------------------------------------------------
.../karaf/bundle/command/bundletree/Node.java | 33 ++--
.../karaf/bundle/command/bundletree/Tree.java | 27 +--
.../apache/karaf/bundle/core/BundleInfo.java | 5 +-
.../karaf/bundle/core/BundleStateService.java | 9 +-
.../apache/karaf/bundle/core/BundleWatcher.java | 14 +-
.../bundle/core/internal/BundleWatcherImpl.java | 12 +-
.../command/ConfigPropertyCommandSupport.java | 18 +-
.../karaf/config/command/PropListCommand.java | 8 +-
.../apache/karaf/config/core/ConfigMBean.java | 23 ++-
.../karaf/config/core/ConfigRepository.java | 13 +-
.../karaf/diagnostic/core/DumpDestination.java | 4 +-
.../karaf/diagnostic/core/DumpProvider.java | 5 +-
.../core/providers/EnvironmentDumpProvider.java | 10 +-
.../management/DiagnosticDumpMBean.java | 6 +-
.../internal/DiagnosticDumpMBeanImpl.java | 11 +-
.../internal/download/DownloadManagers.java | 3 -
.../internal/download/impl/DefaultFuture.java | 10 +-
.../download/impl/DownloadManagerHelper.java | 3 +
.../karaf/features/internal/model/Bundle.java | 33 ++--
.../features/internal/model/Capability.java | 26 ++-
.../karaf/features/internal/model/Config.java | 26 ++-
.../features/internal/model/ConfigFile.java | 26 ++-
.../karaf/features/internal/model/Content.java | 104 +++++------
.../features/internal/model/Dependency.java | 24 ++-
.../karaf/features/internal/model/Feature.java | 174 +++++++++++--------
.../karaf/features/internal/model/Features.java | 130 +++++++-------
.../features/internal/model/ObjectFactory.java | 38 ++--
.../features/internal/model/Requirement.java | 22 +--
.../internal/resolver/ResourceBuilder.java | 1 +
.../internal/service/BootFeaturesInstaller.java | 5 +-
.../features/internal/service/Deployer.java | 3 +-
.../service/FeatureConfigInstaller.java | 4 +-
.../internal/service/FeaturesServiceImpl.java | 6 +
.../features/internal/service/Overrides.java | 21 +--
.../internal/service/RequirementSort.java | 7 +-
.../features/internal/util/ChecksumUtils.java | 1 +
.../org/apache/karaf/http/core/HttpMBean.java | 4 +-
.../main/java/org/apache/karaf/jpm/Process.java | 2 +-
.../org/apache/karaf/jpm/ProcessBuilder.java | 25 +--
.../karaf/jaas/command/RoleAddCommand.java | 7 -
.../karaf/jaas/command/RoleDeleteCommand.java | 7 -
.../karaf/jaas/command/UserAddCommand.java | 7 -
.../karaf/jaas/command/UserDeleteCommand.java | 7 -
.../karaf/jaas/config/KeystoreManager.java | 89 +++++-----
.../config/impl/ResourceKeystoreInstance.java | 6 +-
.../karaf/jaas/modules/BackingEngine.java | 62 +++----
.../jaas/modules/BackingEngineFactory.java | 7 +-
.../karaf/jaas/modules/EncryptionService.java | 6 +-
.../modules/encryption/BasicEncryption.java | 3 +-
.../jaas/modules/jdbc/JDBCBackingEngine.java | 25 ++-
.../karaf/jaas/modules/jdbc/JDBCUtils.java | 12 +-
.../properties/PropertiesBackingEngine.java | 7 -
.../publickey/PublickeyBackingEngine.java | 13 --
.../PublickeyBackingEngineFactory.java | 12 +-
.../java/org/apache/karaf/jdbc/JdbcMBean.java | 48 ++---
.../java/org/apache/karaf/jdbc/JdbcService.java | 43 +++--
.../java/org/apache/karaf/jms/JmsMBean.java | 128 +++++++-------
.../java/org/apache/karaf/jms/JmsService.java | 134 +++++++-------
.../java/org/apache/karaf/jndi/JndiMBean.java | 48 ++---
.../java/org/apache/karaf/jndi/JndiService.java | 44 ++---
.../jpa/hibernate/impl/StatisticsPublisher.java | 2 +-
.../java/org/apache/karaf/kar/KarService.java | 9 +-
.../java/org/apache/karaf/kar/KarsMBean.java | 7 +-
.../core/internal/layout/PatternConverter.java | 144 +++++++--------
.../log/core/internal/layout/PatternParser.java | 10 +-
.../main/java/org/apache/karaf/main/Main.java | 8 +-
.../org/apache/karaf/main/ShutdownCallback.java | 9 +-
.../main/java/org/apache/karaf/main/Status.java | 4 +-
.../main/java/org/apache/karaf/main/Stop.java | 6 +-
.../apache/karaf/main/lock/GenericJDBCLock.java | 109 ++++++------
.../karaf/main/lock/GenericStatements.java | 94 ++++++----
.../java/org/apache/karaf/main/lock/Lock.java | 12 +-
.../karaf/main/util/SimpleMavenResolver.java | 2 +-
.../management/ConnectorServerFactory.java | 4 +-
.../karaf/management/JMXSecurityMBean.java | 36 ++--
.../karaf/management/KarafMBeanServerGuard.java | 90 +++++-----
.../management/internal/BulkRequestContext.java | 18 +-
.../karaf/packages/core/PackageService.java | 16 +-
pom.xml | 4 +-
.../karaf/profile/PlaceholderResolver.java | 15 +-
.../java/org/apache/karaf/profile/Profile.java | 35 +++-
.../apache/karaf/profile/ProfileBuilder.java | 6 +-
.../apache/karaf/profile/ProfileService.java | 54 ++++--
.../profile/impl/PlaceholderResolvers.java | 12 +-
.../apache/karaf/scheduler/ScheduleOptions.java | 6 +-
.../org/apache/karaf/scheduler/Scheduler.java | 32 ++--
.../GreeterServiceComponentFactoryImpl.java | 4 +-
.../service/impl/ManagedGreeterServiceImpl.java | 4 +
.../karaf/scr/management/ScrServiceMBean.java | 30 ++--
.../internal/ScrServiceMBeanImpl.java | 6 +-
.../guard/tools/ACLConfigurationParser.java | 11 +-
.../felix/eventadmin/impl/Configuration.java | 44 +++--
.../eventadmin/impl/handler/EventAdminImpl.java | 48 +++--
.../karaf/shell/commands/impl/LessAction.java | 4 +-
.../karaf/shell/commands/impl/MoreAction.java | 4 +-
.../karaf/shell/commands/impl/WcAction.java | 10 +-
.../org/apache/felix/gogo/commands/Command.java | 17 +-
.../apache/felix/gogo/commands/SubShell.java | 12 +-
.../gogo/commands/converter/ReifiedType.java | 8 +-
.../apache/karaf/shell/commands/Command.java | 16 +-
.../shell/commands/basic/ActionPreparator.java | 14 +-
.../shell/commands/converter/ReifiedType.java | 8 +-
.../karaf/shell/compat/ArgumentCompleter.java | 48 ++---
.../shell/compat/OldArgumentCompleter.java | 46 ++---
.../karaf/shell/console/AbstractAction.java | 4 +-
.../apache/karaf/shell/console/NameScoping.java | 22 ++-
.../apache/karaf/shell/console/SubShell.java | 12 +-
.../console/completer/ArgumentCompleter.java | 60 ++++---
.../shell/console/completer/FileCompleter.java | 12 +-
.../console/completer/OldArgumentCompleter.java | 61 ++++---
.../apache/karaf/shell/console/impl/Main.java | 38 ++--
.../shell/console/impl/jline/ConsoleImpl.java | 2 +-
.../org/apache/karaf/shell/util/ShellUtil.java | 8 +-
.../apache/karaf/shell/api/action/Action.java | 18 +-
.../apache/karaf/shell/api/action/Argument.java | 12 ++
.../apache/karaf/shell/api/action/Command.java | 16 +-
.../karaf/shell/api/action/Completion.java | 6 +
.../apache/karaf/shell/api/action/Option.java | 30 +++-
.../apache/karaf/shell/api/action/Parsing.java | 2 +
.../shell/api/action/lifecycle/Destroy.java | 2 +-
.../karaf/shell/api/action/lifecycle/Init.java | 2 +-
.../shell/api/action/lifecycle/Manager.java | 14 +-
.../shell/api/action/lifecycle/Reference.java | 2 +-
.../apache/karaf/shell/api/console/Command.java | 8 +-
.../karaf/shell/api/console/CommandLine.java | 12 ++
.../apache/karaf/shell/api/console/History.java | 7 +
.../karaf/shell/api/console/Registry.java | 30 +++-
.../apache/karaf/shell/api/console/Session.java | 28 ++-
.../karaf/shell/api/console/SessionFactory.java | 2 +
.../karaf/shell/api/console/SignalListener.java | 3 +-
.../karaf/shell/api/console/Terminal.java | 36 ++--
.../impl/action/command/ArgumentCompleter.java | 22 ++-
.../impl/action/osgi/MultiServiceTracker.java | 2 +-
.../impl/action/osgi/SingleServiceTracker.java | 2 +-
.../shell/impl/console/ConsoleSessionImpl.java | 2 +-
.../shell/impl/console/standalone/Main.java | 30 ++--
.../apache/karaf/shell/support/NameScoping.java | 22 ++-
.../apache/karaf/shell/support/ShellUtil.java | 8 +-
.../shell/support/completers/FileCompleter.java | 13 +-
.../shell/support/converter/ReifiedType.java | 8 +-
.../karaf/shell/support/table/HAlign.java | 6 +-
.../karaf/shell/support/table/ShellTable.java | 7 +-
.../shell/ssh/UserAuthFactoriesFactory.java | 7 +-
.../org/apache/karaf/shell/table/HAlign.java | 6 +-
.../apache/karaf/shell/table/ShellTable.java | 7 +-
.../org/apache/karaf/system/SystemService.java | 50 +++---
.../karaf/system/management/SystemMBean.java | 27 +--
.../org/apache/karaf/tooling/AssemblyMojo.java | 3 +-
.../tooling/commands/CommandHelpPrinter.java | 14 +-
.../tooling/features/AbstractFeatureMojo.java | 14 +-
.../karaf/tooling/utils/DependencyHelper.java | 18 +-
.../tooling/utils/DependencyHelperFactory.java | 12 +-
.../apache/karaf/tooling/utils/MavenUtil.java | 4 +-
.../apache/karaf/tooling/utils/MojoSupport.java | 20 ++-
.../apache/karaf/util/StringEscapeUtils.java | 3 +-
.../CopyOnWriteArrayIdentityList.java | 1 +
.../karaf/util/config/PropertiesLoader.java | 11 +-
.../org/apache/karaf/util/maven/Parser.java | 83 ++++-----
.../karaf/util/process/PumpStreamHandler.java | 44 +++--
.../apache/karaf/util/process/StreamPumper.java | 31 ++--
.../karaf/util/tracker/BaseActivator.java | 75 ++++++--
.../util/tracker/SingleServiceTracker.java | 2 -
.../apache/karaf/web/WebContainerService.java | 6 +-
.../apache/karaf/web/management/WebMBean.java | 10 +-
.../apache/karaf/wrapper/WrapperService.java | 8 +-
165 files changed, 2056 insertions(+), 1660 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/karaf/blob/8a1e7574/bundle/core/src/main/java/org/apache/karaf/bundle/command/bundletree/Node.java
----------------------------------------------------------------------
diff --git a/bundle/core/src/main/java/org/apache/karaf/bundle/command/bundletree/Node.java b/bundle/core/src/main/java/org/apache/karaf/bundle/command/bundletree/Node.java
index fe4dc2a..7d0e5ad 100644
--- a/bundle/core/src/main/java/org/apache/karaf/bundle/command/bundletree/Node.java
+++ b/bundle/core/src/main/java/org/apache/karaf/bundle/command/bundletree/Node.java
@@ -23,7 +23,7 @@ import java.util.List;
import java.util.Set;
/**
- * Represents a node in a {@link Tree}
+ * Represent a node in a {@link Tree}
*/
public class Node<T> {
@@ -32,7 +32,7 @@ public class Node<T> {
private List<Node<T>> children = new LinkedList<Node<T>>();
/**
- * Creates a new node. Only meant for wrapper use,
+ * Create a new node. Only meant for wrapper use,
* new nodes should be added using the {@link #addChild(Object)} method
*
* @param value the node value
@@ -43,10 +43,11 @@ public class Node<T> {
}
/**
- * Creates a new node. Only meant for wrapper use,
- * new nodes should be added using the {@link #addChild(Object)} method
+ * Create a new node. Only meant for wrapper use,
+ * new nodes should be added using the {@link #addChild(Object)} method.
*
- * @param value the node value
+ * @param value the node value.
+ * @param parent the parent node.
*/
protected Node(T value, Node<T> parent) {
this(value);
@@ -54,24 +55,28 @@ public class Node<T> {
}
/**
- * Access the node's value
+ * Access the node's value.
+ *
+ * @return T the node's value.
*/
public T getValue() {
return value;
}
/**
- * Access the node's child nodes
+ * Access the node's child nodes.
+ *
+ * @return the list of node children.
*/
public List<Node<T>> getChildren() {
return children;
}
/**
- * Adds a child to this node
+ * Add a child to this node.
*
- * @param value the child's value
- * @return the child node
+ * @param value the child's value.
+ * @return the child node.
*/
public Node<T> addChild(T value) {
Node<T> node = new Node<T>(value, this);
@@ -82,7 +87,7 @@ public class Node<T> {
/**
* Give a set of values in the tree.
*
- * @return
+ * @return the set of values.
*/
public Set<T> flatten() {
Set<T> result = new HashSet<T>();
@@ -94,10 +99,10 @@ public class Node<T> {
}
/**
- * Check if the node has an ancestor that represents the given value
+ * Check if the node has an ancestor that represents the given value.
*
- * @param value the node value
- * @return <code>true</code> it there's an ancestor that represents the value
+ * @param value the node value.
+ * @return <code>true</code> if there's an ancestor that represents the value.
*/
public boolean hasAncestor(T value) {
if (parent == null) {
http://git-wip-us.apache.org/repos/asf/karaf/blob/8a1e7574/bundle/core/src/main/java/org/apache/karaf/bundle/command/bundletree/Tree.java
----------------------------------------------------------------------
diff --git a/bundle/core/src/main/java/org/apache/karaf/bundle/command/bundletree/Tree.java b/bundle/core/src/main/java/org/apache/karaf/bundle/command/bundletree/Tree.java
index 7a7b64e..9bb6501 100644
--- a/bundle/core/src/main/java/org/apache/karaf/bundle/command/bundletree/Tree.java
+++ b/bundle/core/src/main/java/org/apache/karaf/bundle/command/bundletree/Tree.java
@@ -20,9 +20,10 @@ import java.io.PrintStream;
import java.io.PrintWriter;
/**
- * Represents a tree that can be written to the console.
+ * <p>Represent a tree that can be written to the console.</p>
*
* The output will look like this:
+ *
* <pre>
* root
* +- child1
@@ -33,7 +34,7 @@ import java.io.PrintWriter;
public class Tree<T> extends Node<T> {
/**
- * Creates a new tree with the given root node
+ * Create a new tree with the given root node.
*
* @param root the root node
*/
@@ -42,28 +43,28 @@ public class Tree<T> extends Node<T> {
}
/**
- * Write the tree to a PrintStream, using the default toString() method to output the node values
+ * Write the tree to a PrintStream, using the default toString() method to output the node values.
*
- * @param stream
+ * @param stream the stream where to write.
*/
public void write(PrintStream stream) {
write(new PrintWriter(stream));
}
/**
- * Write the tree to a PrintStream, using the provided converter to output the node values
+ * Write the tree to a PrintStream, using the provided converter to output the node values.
*
- * @param stream
- * @param converter
+ * @param stream the stream where to write.
+ * @param converter the converter to use.
*/
public void write(PrintStream stream, Converter<T> converter) {
write(new PrintWriter(stream), converter);
}
/**
- * Write the tree to a PrintWriter, using the default toString() method to output the node values
+ * Write the tree to a PrintWriter, using the default toString() method to output the node values.
*
- * @param writer
+ * @param writer the writer where to write.
*/
public void write(PrintWriter writer) {
write(writer, new Converter() {
@@ -74,10 +75,10 @@ public class Tree<T> extends Node<T> {
}
/**
- * Write the tree to a PrintWriter, using the provided converter to output the node values
+ * Write the tree to a PrintWriter, using the provided converter to output the node values.
*
- * @param writer
- * @param converter
+ * @param writer the writer where to write.
+ * @param converter the converter to use.
*/
public void write(PrintWriter writer, Converter<T> converter) {
writer.printf("%s%n", converter.toString(this));
@@ -88,7 +89,7 @@ public class Tree<T> extends Node<T> {
}
/**
- * Interface to convert node values to string
+ * Interface to convert node values to string.
*
* @param <T> the object type for the node value
*/
http://git-wip-us.apache.org/repos/asf/karaf/blob/8a1e7574/bundle/core/src/main/java/org/apache/karaf/bundle/core/BundleInfo.java
----------------------------------------------------------------------
diff --git a/bundle/core/src/main/java/org/apache/karaf/bundle/core/BundleInfo.java b/bundle/core/src/main/java/org/apache/karaf/bundle/core/BundleInfo.java
index 962e802..ccd3c46 100644
--- a/bundle/core/src/main/java/org/apache/karaf/bundle/core/BundleInfo.java
+++ b/bundle/core/src/main/java/org/apache/karaf/bundle/core/BundleInfo.java
@@ -21,6 +21,7 @@ import java.util.List;
import org.osgi.framework.Bundle;
public interface BundleInfo {
+
long getBundleId();
String getSymbolicName();
String getName();
@@ -30,7 +31,8 @@ public interface BundleInfo {
/**
* Combined bundle state from OSGi and all BundleStateServices
- * @return
+ *
+ * @return the current {@link BundleState}.
*/
BundleState getState();
@@ -40,4 +42,5 @@ public interface BundleInfo {
List<Bundle> getFragments();
List<Bundle> getFragmentHosts();
+
}
http://git-wip-us.apache.org/repos/asf/karaf/blob/8a1e7574/bundle/core/src/main/java/org/apache/karaf/bundle/core/BundleStateService.java
----------------------------------------------------------------------
diff --git a/bundle/core/src/main/java/org/apache/karaf/bundle/core/BundleStateService.java b/bundle/core/src/main/java/org/apache/karaf/bundle/core/BundleStateService.java
index 14d4907..f2c8158 100644
--- a/bundle/core/src/main/java/org/apache/karaf/bundle/core/BundleStateService.java
+++ b/bundle/core/src/main/java/org/apache/karaf/bundle/core/BundleStateService.java
@@ -23,6 +23,7 @@ import org.osgi.framework.Bundle;
* also reports on dependencies and status on the injection container level
*/
public interface BundleStateService {
+
public final static String NAME_BLUEPRINT = "Blueprint";
public final static String NAME_SPRING_DM = "Spring DM";
public final static String NAME_DS = "Declarative Services";
@@ -40,8 +41,8 @@ public interface BundleStateService {
* like missing namespace handlers or service dependencies.
* Should also give the details if there are config errors
*
- * @param bundle
- * @return diagnostic details
+ * @param bundle the bundle to get diag for.
+ * @return diagnostic details.
*/
String getDiag(Bundle bundle);
@@ -49,8 +50,8 @@ public interface BundleStateService {
* Report the bundle state from the framework point of view.
* If the framework is not active it should return Unknown.
*
- * @param bundle
- * @return status
+ * @param bundle the bundle to get state for.
+ * @return the current bundle state.
*/
BundleState getState(Bundle bundle);
http://git-wip-us.apache.org/repos/asf/karaf/blob/8a1e7574/bundle/core/src/main/java/org/apache/karaf/bundle/core/BundleWatcher.java
----------------------------------------------------------------------
diff --git a/bundle/core/src/main/java/org/apache/karaf/bundle/core/BundleWatcher.java b/bundle/core/src/main/java/org/apache/karaf/bundle/core/BundleWatcher.java
index 813fb21..1ecc9f4 100644
--- a/bundle/core/src/main/java/org/apache/karaf/bundle/core/BundleWatcher.java
+++ b/bundle/core/src/main/java/org/apache/karaf/bundle/core/BundleWatcher.java
@@ -23,24 +23,24 @@ public interface BundleWatcher {
void bundleChanged(BundleEvent event);
/**
- * Adds a Bundle URLs to the watch list.
+ * Add a Bundle URLs to the watch list.
*
- * @param url
+ * @param url the URL to watch.
*/
void add(String url);
/**
- * Removes a bundle URLs from the watch list.
+ * Remove a bundle URLs from the watch list.
*
- * @param url
+ * @param url the URL to stop to watch.
*/
void remove(String url);
/**
- * Returns the bundles that match
+ * Return the bundles that match
*
- * @param url
- * @return
+ * @param url the bundles URL.
+ * @return the list of bundles.
*/
List<Bundle> getBundlesByURL(String url);
http://git-wip-us.apache.org/repos/asf/karaf/blob/8a1e7574/bundle/core/src/main/java/org/apache/karaf/bundle/core/internal/BundleWatcherImpl.java
----------------------------------------------------------------------
diff --git a/bundle/core/src/main/java/org/apache/karaf/bundle/core/internal/BundleWatcherImpl.java b/bundle/core/src/main/java/org/apache/karaf/bundle/core/internal/BundleWatcherImpl.java
index e92c95f..104dcba 100644
--- a/bundle/core/src/main/java/org/apache/karaf/bundle/core/internal/BundleWatcherImpl.java
+++ b/bundle/core/src/main/java/org/apache/karaf/bundle/core/internal/BundleWatcherImpl.java
@@ -59,9 +59,6 @@ public class BundleWatcherImpl implements Runnable, BundleListener, BundleWatche
private List<String> watchURLs = new CopyOnWriteArrayList<String>();
private AtomicInteger counter = new AtomicInteger(0);
- /**
- * Constructor
- */
@SuppressWarnings("deprecation")
public BundleWatcherImpl(BundleContext bundleContext, MavenConfigService mavenConfigService, BundleService bundleService) {
this.bundleContext = bundleContext;
@@ -213,10 +210,11 @@ public class BundleWatcherImpl implements Runnable, BundleListener, BundleWatche
}
/**
- * Returns the location of the Bundle inside the local maven repository.
+ * Return the location of the Bundle inside the local maven repository.
*
- * @param bundle
- * @return
+ * @param localRepository the repository where to look for bundle update.
+ * @param bundle the bundle to check update.
+ * @return the updated file.
*/
private File getBundleExternalLocation(File localRepository, Bundle bundle) {
try {
@@ -240,7 +238,7 @@ public class BundleWatcherImpl implements Runnable, BundleListener, BundleWatche
}
/**
- * Stops the execution of the thread and releases the singleton instance
+ * Stop the execution of the thread and releases the singleton instance.
*/
public void stop() {
running.set(false);
http://git-wip-us.apache.org/repos/asf/karaf/blob/8a1e7574/config/src/main/java/org/apache/karaf/config/command/ConfigPropertyCommandSupport.java
----------------------------------------------------------------------
diff --git a/config/src/main/java/org/apache/karaf/config/command/ConfigPropertyCommandSupport.java b/config/src/main/java/org/apache/karaf/config/command/ConfigPropertyCommandSupport.java
index 619c224..2b17d48 100644
--- a/config/src/main/java/org/apache/karaf/config/command/ConfigPropertyCommandSupport.java
+++ b/config/src/main/java/org/apache/karaf/config/command/ConfigPropertyCommandSupport.java
@@ -51,16 +51,18 @@ public abstract class ConfigPropertyCommandSupport extends ConfigCommandSupport
/**
* Perform an action on the properties.
- * @param props
+ *
+ * @param props the dictionary where to apply the action.
*/
@SuppressWarnings("rawtypes")
protected abstract void propertyAction(Dictionary props);
/**
- * Checks if the configuration requires to be updated.
+ * Check if the configuration requires to be updated.
* The default behavior is to update if a valid pid has been passed to the method.
- * @param pid
- * @return
+ *
+ * @param pid the PID to check.
+ * @return <code>true</code> if the configuration requires an update, <code>false</code> else.
*/
protected boolean requiresUpdate(String pid) {
if (pid != null) {
@@ -70,11 +72,11 @@ public abstract class ConfigPropertyCommandSupport extends ConfigCommandSupport
}
}
-
/**
- * Retrieves confguration from the pid, if used or delegates to session from getting the configuration.
- * @return
- * @throws Exception
+ * Retrieve configuration from the pid, if used or delegates to session from getting the configuration.
+ *
+ * @return the edited dictionary.
+ * @throws Exception in case of configuration failure.
*/
@SuppressWarnings("rawtypes")
@Override
http://git-wip-us.apache.org/repos/asf/karaf/blob/8a1e7574/config/src/main/java/org/apache/karaf/config/command/PropListCommand.java
----------------------------------------------------------------------
diff --git a/config/src/main/java/org/apache/karaf/config/command/PropListCommand.java b/config/src/main/java/org/apache/karaf/config/command/PropListCommand.java
index a0d3a61..015e118 100644
--- a/config/src/main/java/org/apache/karaf/config/command/PropListCommand.java
+++ b/config/src/main/java/org/apache/karaf/config/command/PropListCommand.java
@@ -36,12 +36,14 @@ public class PropListCommand extends ConfigPropertyCommandSupport {
}
/**
- * List commands never requires an update, so it always returns false.
- * @param pid
- * @return
+ * Check if a configuration (identified by PID) requires an update or not.
+ *
+ * @param pid the configuration PID.
+ * @return true if the configuration requires an update, false else (always returns false).
*/
@Override
protected boolean requiresUpdate(String pid) {
return false;
}
+
}
http://git-wip-us.apache.org/repos/asf/karaf/blob/8a1e7574/config/src/main/java/org/apache/karaf/config/core/ConfigMBean.java
----------------------------------------------------------------------
diff --git a/config/src/main/java/org/apache/karaf/config/core/ConfigMBean.java b/config/src/main/java/org/apache/karaf/config/core/ConfigMBean.java
index 9cb9f7f..9c46677 100644
--- a/config/src/main/java/org/apache/karaf/config/core/ConfigMBean.java
+++ b/config/src/main/java/org/apache/karaf/config/core/ConfigMBean.java
@@ -26,7 +26,7 @@ public interface ConfigMBean {
* Get the list of all configuration PIDs.
*
* @return the list of all configuration PIDs.
- * @throws Exception
+ * @throws MBeanException in case of MBean failure.
*/
List<String> getConfigs() throws MBeanException;
@@ -34,7 +34,7 @@ public interface ConfigMBean {
* Create a new configuration for the given PID.
*
* @param pid the configuration PID.
- * @throws Exception
+ * @throws MBeanException in case of MBean failure.
*/
void create(String pid) throws MBeanException;
@@ -42,7 +42,7 @@ public interface ConfigMBean {
* Delete a configuration identified by the given PID.
*
* @param pid the configuration PID to delete.
- * @throws Exception
+ * @throws MBeanException in case of MBean failure.
*/
void delete(String pid) throws MBeanException;
@@ -51,7 +51,7 @@ public interface ConfigMBean {
*
* @param pid the configuration PID.
* @return the list of properties.
- * @throws Exception
+ * @throws MBeanException in case of MBean failure.
*/
Map<String, String> listProperties(String pid) throws MBeanException;
@@ -60,7 +60,7 @@ public interface ConfigMBean {
*
* @param pid the configuration PID.
* @param key the property key.
- * @throws Exception
+ * @throws MBeanException in case of MBean failure.
*/
void deleteProperty(String pid, String key) throws MBeanException;
@@ -70,7 +70,7 @@ public interface ConfigMBean {
* @param pid the configuration PID.
* @param key the property key.
* @param value the value to append to the current property value.
- * @throws Exception
+ * @throws MBeanException in case of MBean failure.
*/
void appendProperty(String pid, String key, String value) throws MBeanException;
@@ -80,7 +80,7 @@ public interface ConfigMBean {
* @param pid the configuration PID.
* @param key the property key.
* @param value the property value.
- * @throws Exception
+ * @throws MBeanException in case of MBean failure.
*/
void setProperty(String pid, String key, String value) throws MBeanException;
@@ -89,19 +89,18 @@ public interface ConfigMBean {
*
* @param pid the configuration PID.
* @param properties the new properties to set in the configuration.
- * @throws MBeanException
+ * @throws MBeanException in case of MBean failure.
*/
void update(String pid, Map<String, String> properties) throws MBeanException;
/**
* Create a factory based configuration.
*
- * @param factoryPid
+ * @param factoryPid the configuration factory PID.
* @param properties the new properties to set in the configuration.
- * @return created pid
- * @throws MBeanException
+ * @return the created PID.
+ * @throws MBeanException in case of MBean failure.
*/
String createFactoryConfiguration(String factoryPid, Map<String, String> properties) throws MBeanException;
-
}
http://git-wip-us.apache.org/repos/asf/karaf/blob/8a1e7574/config/src/main/java/org/apache/karaf/config/core/ConfigRepository.java
----------------------------------------------------------------------
diff --git a/config/src/main/java/org/apache/karaf/config/core/ConfigRepository.java b/config/src/main/java/org/apache/karaf/config/core/ConfigRepository.java
index 8121679..75a877b 100644
--- a/config/src/main/java/org/apache/karaf/config/core/ConfigRepository.java
+++ b/config/src/main/java/org/apache/karaf/config/core/ConfigRepository.java
@@ -25,10 +25,11 @@ import org.osgi.service.cm.ConfigurationAdmin;
public interface ConfigRepository {
/**
- * Saves config to storage or ConfigurationAdmin.
- * @param pid
- * @param props
- * @throws IOException
+ * Save config to storage or ConfigurationAdmin.
+ *
+ * @param pid the configuration PID.
+ * @param props the dictionary used to update the configuration.
+ * @throws IOException in case of update failure.
*/
@SuppressWarnings("rawtypes")
void update(String pid, Dictionary props) throws IOException;
@@ -43,9 +44,9 @@ public interface ConfigRepository {
/**
* Create a factory based configuration.
*
- * @param factoryPid
+ * @param factoryPid the configuration factory PID.
* @param properties the new properties to set in the configuration.
- * @return created pid
+ * @return the created configuration PID.
*/
String createFactoryConfiguration(String factoryPid, Dictionary<String, ?> properties);
}
http://git-wip-us.apache.org/repos/asf/karaf/blob/8a1e7574/diagnostic/boot/src/main/java/org/apache/karaf/diagnostic/core/DumpDestination.java
----------------------------------------------------------------------
diff --git a/diagnostic/boot/src/main/java/org/apache/karaf/diagnostic/core/DumpDestination.java b/diagnostic/boot/src/main/java/org/apache/karaf/diagnostic/core/DumpDestination.java
index 39c4edc..0891222 100644
--- a/diagnostic/boot/src/main/java/org/apache/karaf/diagnostic/core/DumpDestination.java
+++ b/diagnostic/boot/src/main/java/org/apache/karaf/diagnostic/core/DumpDestination.java
@@ -23,7 +23,7 @@ import java.io.OutputStream;
public interface DumpDestination {
/**
- * Creates new entry in dump destination.
+ * Create new entry in dump destination.
*
* Destination does not close returned output stream by default, dump
* provider should do this after completing write operation.
@@ -36,6 +36,8 @@ public interface DumpDestination {
/**
* Complete creation of the dump.
+ *
+ * @throws Exception If the save operation fails.
*/
void save() throws Exception;
http://git-wip-us.apache.org/repos/asf/karaf/blob/8a1e7574/diagnostic/boot/src/main/java/org/apache/karaf/diagnostic/core/DumpProvider.java
----------------------------------------------------------------------
diff --git a/diagnostic/boot/src/main/java/org/apache/karaf/diagnostic/core/DumpProvider.java b/diagnostic/boot/src/main/java/org/apache/karaf/diagnostic/core/DumpProvider.java
index ec7724c..3d898bd 100644
--- a/diagnostic/boot/src/main/java/org/apache/karaf/diagnostic/core/DumpProvider.java
+++ b/diagnostic/boot/src/main/java/org/apache/karaf/diagnostic/core/DumpProvider.java
@@ -22,7 +22,10 @@ package org.apache.karaf.diagnostic.core;
public interface DumpProvider {
/**
- * Creates dump in given entry.
+ * Create dump in given entry.
+ *
+ * @param destination The destination where to create the dump.
+ * @throws Exception If the dump creation fails.
*/
void createDump(DumpDestination destination) throws Exception;
http://git-wip-us.apache.org/repos/asf/karaf/blob/8a1e7574/diagnostic/boot/src/main/java/org/apache/karaf/diagnostic/core/providers/EnvironmentDumpProvider.java
----------------------------------------------------------------------
diff --git a/diagnostic/boot/src/main/java/org/apache/karaf/diagnostic/core/providers/EnvironmentDumpProvider.java b/diagnostic/boot/src/main/java/org/apache/karaf/diagnostic/core/providers/EnvironmentDumpProvider.java
index b86fb8d..662c693 100644
--- a/diagnostic/boot/src/main/java/org/apache/karaf/diagnostic/core/providers/EnvironmentDumpProvider.java
+++ b/diagnostic/boot/src/main/java/org/apache/karaf/diagnostic/core/providers/EnvironmentDumpProvider.java
@@ -50,7 +50,9 @@ public class EnvironmentDumpProvider extends TextDumpProvider {
private final BundleContext bundleContext;
/**
- * Creates new dump entry which contains information about the runtime environment.
+ * Create new dump entry which contains information about the runtime environment.
+ *
+ * @param context The bundle context to use in the MBean.
*/
public EnvironmentDumpProvider(final BundleContext context) {
super("environment.txt");
@@ -247,10 +249,10 @@ public class EnvironmentDumpProvider extends TextDumpProvider {
}
/**
- * Prints the duration in a human readable format as X days Y hours Z minutes etc.
+ * Print the duration in a human readable format as X days Y hours Z minutes etc.
*
- * @param uptime the uptime in millis
- * @return the time used for displaying on screen or in logs
+ * @param uptime The uptime in millis.
+ * @return The time used for displaying on screen or in logs.
*/
private String printDuration(double uptime) {
// Code based on code taken from Karaf
http://git-wip-us.apache.org/repos/asf/karaf/blob/8a1e7574/diagnostic/core/src/main/java/org/apache/karaf/diagnostic/management/DiagnosticDumpMBean.java
----------------------------------------------------------------------
diff --git a/diagnostic/core/src/main/java/org/apache/karaf/diagnostic/management/DiagnosticDumpMBean.java b/diagnostic/core/src/main/java/org/apache/karaf/diagnostic/management/DiagnosticDumpMBean.java
index e5dfc99..e6039f3 100644
--- a/diagnostic/core/src/main/java/org/apache/karaf/diagnostic/management/DiagnosticDumpMBean.java
+++ b/diagnostic/core/src/main/java/org/apache/karaf/diagnostic/management/DiagnosticDumpMBean.java
@@ -26,7 +26,7 @@ public interface DiagnosticDumpMBean {
* Creates dump over JMX.
*
* @param name Name of the dump.
- * @throws Exception In case of any problems.
+ * @throws MBeanException In case of any problems.
*/
void createDump(String name) throws MBeanException;
@@ -35,7 +35,9 @@ public interface DiagnosticDumpMBean {
*
* @param directory Should dump be created in directory.
* @param name Name of the dump.
- * @throws Exception In case of any problems.
+ * @param noThreadDump True to not include thread dump, false else.
+ * @param noHeapDump True to not include heap dump, false else.
+ * @throws MBeanException In case of any problems.
*/
void createDump(boolean directory, String name, boolean noThreadDump, boolean noHeapDump) throws MBeanException;
http://git-wip-us.apache.org/repos/asf/karaf/blob/8a1e7574/diagnostic/core/src/main/java/org/apache/karaf/diagnostic/management/internal/DiagnosticDumpMBeanImpl.java
----------------------------------------------------------------------
diff --git a/diagnostic/core/src/main/java/org/apache/karaf/diagnostic/management/internal/DiagnosticDumpMBeanImpl.java b/diagnostic/core/src/main/java/org/apache/karaf/diagnostic/management/internal/DiagnosticDumpMBeanImpl.java
index a7758e1..9a87f66 100644
--- a/diagnostic/core/src/main/java/org/apache/karaf/diagnostic/management/internal/DiagnosticDumpMBeanImpl.java
+++ b/diagnostic/core/src/main/java/org/apache/karaf/diagnostic/management/internal/DiagnosticDumpMBeanImpl.java
@@ -42,16 +42,16 @@ public class DiagnosticDumpMBeanImpl extends StandardMBean implements Diagnostic
private final static Logger LOGGER = LoggerFactory.getLogger(DiagnosticDumpMBeanImpl.class);
/**
- * Creates new diagnostic mbean.
+ * Create new diagnostic MBean.
*
- * @throws NotCompliantMBeanException
+ * @throws NotCompliantMBeanException If the MBean is not valid.
*/
public DiagnosticDumpMBeanImpl() throws NotCompliantMBeanException {
super(DiagnosticDumpMBean.class);
}
/**
- * Creates dump witch given name
+ * Create dump witch given name.
*
* @param name Name of the dump.
*/
@@ -83,9 +83,12 @@ public class DiagnosticDumpMBeanImpl extends StandardMBean implements Diagnostic
}
/**
- * Sets the bundle context
+ * Set the bundle context.
+ *
+ * @param bundleContext The bundle context to use in the MBean.
*/
public void setBundleContext(BundleContext bundleContext) {
this.bundleContext = bundleContext;
}
+
}
http://git-wip-us.apache.org/repos/asf/karaf/blob/8a1e7574/features/core/src/main/java/org/apache/karaf/features/internal/download/DownloadManagers.java
----------------------------------------------------------------------
diff --git a/features/core/src/main/java/org/apache/karaf/features/internal/download/DownloadManagers.java b/features/core/src/main/java/org/apache/karaf/features/internal/download/DownloadManagers.java
index b2bdfc0..59d37ea 100644
--- a/features/core/src/main/java/org/apache/karaf/features/internal/download/DownloadManagers.java
+++ b/features/core/src/main/java/org/apache/karaf/features/internal/download/DownloadManagers.java
@@ -25,9 +25,6 @@ public final class DownloadManagers {
private DownloadManagers() { }
- /**
- * Creates a DownloadManager
- */
public static DownloadManager createDownloadManager(MavenResolver resolver, ScheduledExecutorService executorService) {
return createDownloadManager(resolver, executorService, 0, 0);
}
http://git-wip-us.apache.org/repos/asf/karaf/blob/8a1e7574/features/core/src/main/java/org/apache/karaf/features/internal/download/impl/DefaultFuture.java
----------------------------------------------------------------------
diff --git a/features/core/src/main/java/org/apache/karaf/features/internal/download/impl/DefaultFuture.java b/features/core/src/main/java/org/apache/karaf/features/internal/download/impl/DefaultFuture.java
index 3460496..c641a03 100644
--- a/features/core/src/main/java/org/apache/karaf/features/internal/download/impl/DefaultFuture.java
+++ b/features/core/src/main/java/org/apache/karaf/features/internal/download/impl/DefaultFuture.java
@@ -52,6 +52,8 @@ public class DefaultFuture<T extends DefaultFuture> {
/**
* Creates a new instance.
+ *
+ * @param lock the future lock.
*/
public DefaultFuture(Object lock) {
this.lock = lock != null ? lock : this;
@@ -236,7 +238,9 @@ public class DefaultFuture<T extends DefaultFuture> {
}
/**
- * Sets the result of the asynchronous operation, and mark it as finished.
+ * Set the result of the asynchronous operation, and mark it as finished.
+ *
+ * @param newValue the result of the asynchronous operation.
*/
public void setValue(Object newValue) {
synchronized (lock) {
@@ -256,7 +260,9 @@ public class DefaultFuture<T extends DefaultFuture> {
}
/**
- * Returns the result of the asynchronous operation.
+ * Return the result of the asynchronous operation.
+ *
+ * @return the result of the asynchronous operation.
*/
protected Object getValue() {
synchronized (lock) {
http://git-wip-us.apache.org/repos/asf/karaf/blob/8a1e7574/features/core/src/main/java/org/apache/karaf/features/internal/download/impl/DownloadManagerHelper.java
----------------------------------------------------------------------
diff --git a/features/core/src/main/java/org/apache/karaf/features/internal/download/impl/DownloadManagerHelper.java b/features/core/src/main/java/org/apache/karaf/features/internal/download/impl/DownloadManagerHelper.java
index 531625f..29bbf2a 100644
--- a/features/core/src/main/java/org/apache/karaf/features/internal/download/impl/DownloadManagerHelper.java
+++ b/features/core/src/main/java/org/apache/karaf/features/internal/download/impl/DownloadManagerHelper.java
@@ -29,6 +29,9 @@ public final class DownloadManagerHelper {
/**
* Strips download urls from wrapper protocols.
+ *
+ * @param url the given url.
+ * @return the stripped URL for the wrapper protocols.
*/
public static String stripUrl(String url) {
String strippedUrl = url;
http://git-wip-us.apache.org/repos/asf/karaf/blob/8a1e7574/features/core/src/main/java/org/apache/karaf/features/internal/model/Bundle.java
----------------------------------------------------------------------
diff --git a/features/core/src/main/java/org/apache/karaf/features/internal/model/Bundle.java b/features/core/src/main/java/org/apache/karaf/features/internal/model/Bundle.java
index e7a759a..1bd45ef 100644
--- a/features/core/src/main/java/org/apache/karaf/features/internal/model/Bundle.java
+++ b/features/core/src/main/java/org/apache/karaf/features/internal/model/Bundle.java
@@ -14,7 +14,6 @@
* See the License for the specific language governing permissions and
* limitations under the License.
*/
-
package org.apache.karaf.features.internal.model;
import javax.xml.bind.annotation.XmlAccessType;
@@ -26,25 +25,23 @@ import javax.xml.bind.annotation.XmlValue;
import org.apache.karaf.features.BundleInfo;
-
/**
- * Deployable element to install.
- * <p/>
- * <p/>
- * <p>Java class for bundle complex type.
- * <p/>
- * <p>The following schema fragment specifies the expected content contained within this class.
- * <p/>
+ * <p>Deployable element to install.</p>
+ *
+ * <p>Java class for bundle complex type.</p>
+ *
+ * <p>The following schema fragment specifies the expected content contained within this class.</p>
+ *
* <pre>
- * <complexType name="bundle">
- * <simpleContent>
- * <extension base="<http://www.w3.org/2001/XMLSchema>anyURI">
- * <attribute name="start-level" type="{http://www.w3.org/2001/XMLSchema}int" />
- * <attribute name="start" type="{http://www.w3.org/2001/XMLSchema}boolean" />
- * <attribute name="dependency" type="{http://www.w3.org/2001/XMLSchema}boolean" />
- * </extension>
- * </simpleContent>
- * </complexType>
+ * <complexType name="bundle">
+ * <simpleContent>
+ * <extension base="<http://www.w3.org/2001/XMLSchema>anyURI">
+ * <attribute name="start-level" type="{http://www.w3.org/2001/XMLSchema}int" />
+ * <attribute name="start" type="{http://www.w3.org/2001/XMLSchema}boolean" />
+ * <attribute name="dependency" type="{http://www.w3.org/2001/XMLSchema}boolean" />
+ * </extension>
+ * </simpleContent>
+ * </complexType>
* </pre>
*/
@XmlAccessorType(XmlAccessType.FIELD)
http://git-wip-us.apache.org/repos/asf/karaf/blob/8a1e7574/features/core/src/main/java/org/apache/karaf/features/internal/model/Capability.java
----------------------------------------------------------------------
diff --git a/features/core/src/main/java/org/apache/karaf/features/internal/model/Capability.java b/features/core/src/main/java/org/apache/karaf/features/internal/model/Capability.java
index c2ee7b7..aba425d 100644
--- a/features/core/src/main/java/org/apache/karaf/features/internal/model/Capability.java
+++ b/features/core/src/main/java/org/apache/karaf/features/internal/model/Capability.java
@@ -21,22 +21,20 @@ import javax.xml.bind.annotation.XmlAccessorType;
import javax.xml.bind.annotation.XmlType;
import javax.xml.bind.annotation.XmlValue;
-
/**
- * Additional capability for a feature.
- * <p/>
- * <p/>
- * <p>Java class for bundle complex type.
- * <p/>
- * <p>The following schema fragment specifies the expected content contained within this class.
- * <p/>
+ * <p>Additional capability for a feature.</p>
+ *
+ * <p>Java class for bundle complex type.</p>
+ *
+ * <p>The following schema fragment specifies the expected content contained within this class.</p>
+ *
* <pre>
- * <complexType name="capability">
- * <simpleContent>
- * <extension base="<http://www.w3.org/2001/XMLSchema>string">
- * </extension>
- * </simpleContent>
- * </complexType>
+ * <complexType name="capability">
+ * <simpleContent>
+ * <extension base="<http://www.w3.org/2001/XMLSchema>string">
+ * </extension>
+ * </simpleContent>
+ * </complexType>
* </pre>
*/
@XmlAccessorType(XmlAccessType.FIELD)
http://git-wip-us.apache.org/repos/asf/karaf/blob/8a1e7574/features/core/src/main/java/org/apache/karaf/features/internal/model/Config.java
----------------------------------------------------------------------
diff --git a/features/core/src/main/java/org/apache/karaf/features/internal/model/Config.java b/features/core/src/main/java/org/apache/karaf/features/internal/model/Config.java
index a7cb405..816b595 100644
--- a/features/core/src/main/java/org/apache/karaf/features/internal/model/Config.java
+++ b/features/core/src/main/java/org/apache/karaf/features/internal/model/Config.java
@@ -31,24 +31,18 @@ import javax.xml.bind.annotation.XmlValue;
import org.apache.karaf.features.ConfigInfo;
-
/**
- * Configuration entries which should be created during feature installation. This
- * configuration may be used with OSGi Configuration Admin.
- * <p/>
- * <p/>
- * <p>Java class for config complex type.
- * <p/>
- * <p>The following schema fragment specifies the expected content contained within this class.
- * <p/>
+ * <p>Configuration entries which should be created during feature installation. This configuration may be used with OSGi Configuration Admin.</p>
+ * <p>Java class for config complex type.</p>
+ * <p>The following schema fragment specifies the expected content contained within this class.</p>
* <pre>
- * <complexType name="config">
- * <simpleContent>
- * <extension base="<http://www.w3.org/2001/XMLSchema>string">
- * <attribute name="name" use="required" type="{http://www.w3.org/2001/XMLSchema}string" />
- * </extension>
- * </simpleContent>
- * </complexType>
+ * <complexType name="config">
+ * <simpleContent>
+ * <extension base="<http://www.w3.org/2001/XMLSchema>string">
+ * <attribute name="name" use="required" type="{http://www.w3.org/2001/XMLSchema}string" />
+ * </extension>
+ * </simpleContent>
+ * </complexType>
* </pre>
*/
@XmlAccessorType(XmlAccessType.FIELD)
http://git-wip-us.apache.org/repos/asf/karaf/blob/8a1e7574/features/core/src/main/java/org/apache/karaf/features/internal/model/ConfigFile.java
----------------------------------------------------------------------
diff --git a/features/core/src/main/java/org/apache/karaf/features/internal/model/ConfigFile.java b/features/core/src/main/java/org/apache/karaf/features/internal/model/ConfigFile.java
index a418622..25d69f3 100644
--- a/features/core/src/main/java/org/apache/karaf/features/internal/model/ConfigFile.java
+++ b/features/core/src/main/java/org/apache/karaf/features/internal/model/ConfigFile.java
@@ -26,22 +26,18 @@ import org.apache.karaf.features.ConfigFileInfo;
/**
- * Additional configuration files which should be created during feature installation.
- * <p/>
- * <p/>
- * <p>Java class for configFile complex type.
- * <p/>
- * <p>The following schema fragment specifies the expected content contained within this class.
- * <p/>
+ * <p>Additional configuration files which should be created during feature installation.</p>
+ * <p>Java class for configFile complex type.</p>
+ * <p>The following schema fragment specifies the expected content contained within this class.</p>
* <pre>
- * <complexType name="configFile">
- * <simpleContent>
- * <extension base="<http://www.w3.org/2001/XMLSchema>string">
- * <attribute name="finalname" use="required" type="{http://www.w3.org/2001/XMLSchema}string" />
- * <attribute name="override" type="{http://www.w3.org/2001/XMLSchema}boolean" />
- * </extension>
- * </simpleContent>
- * </complexType>
+ * <complexType name="configFile">
+ * <simpleContent>
+ * <extension base="<http://www.w3.org/2001/XMLSchema>string">
+ * <attribute name="finalname" use="required" type="{http://www.w3.org/2001/XMLSchema}string" />
+ * <attribute name="override" type="{http://www.w3.org/2001/XMLSchema}boolean" />
+ * </extension>
+ * </simpleContent>
+ * </complexType>
* </pre>
*/
@XmlAccessorType(XmlAccessType.FIELD)
http://git-wip-us.apache.org/repos/asf/karaf/blob/8a1e7574/features/core/src/main/java/org/apache/karaf/features/internal/model/Content.java
----------------------------------------------------------------------
diff --git a/features/core/src/main/java/org/apache/karaf/features/internal/model/Content.java b/features/core/src/main/java/org/apache/karaf/features/internal/model/Content.java
index 02c453b..dffc981 100644
--- a/features/core/src/main/java/org/apache/karaf/features/internal/model/Content.java
+++ b/features/core/src/main/java/org/apache/karaf/features/internal/model/Content.java
@@ -16,17 +16,9 @@
*/
package org.apache.karaf.features.internal.model;
-import java.io.IOException;
-import java.io.StringReader;
import java.util.ArrayList;
import java.util.Collections;
-import java.util.Enumeration;
-import java.util.HashMap;
import java.util.List;
-import java.util.Map;
-import java.util.Properties;
-import java.util.regex.Matcher;
-import java.util.regex.Pattern;
import javax.xml.bind.annotation.XmlTransient;
@@ -43,24 +35,22 @@ public class Content {
protected List<Bundle> bundle;
/**
- * Gets the value of the config property.
- * <p/>
- * <p/>
- * This accessor method returns a reference to the live list,
+ * <p>Gets the value of the config property.</p>
+ *
+ * <p>This accessor method returns a reference to the live list,
* not a snapshot. Therefore any modification you make to the
* returned list will be present inside the JAXB object.
- * This is why there is not a <CODE>set</CODE> method for the config property.
- * <p/>
- * <p/>
- * For example, to add a new item, do as follows:
+ * This is why there is not a <CODE>set</CODE> method for the config property.</p>
+ *
+ * <p>For example, to add a new item, do as follows:</p>
* <pre>
* getConfig().add(newItem);
* </pre>
- * <p/>
- * <p/>
- * <p/>
- * Objects of the following type(s) are allowed in the list
- * {@link Config }
+ *
+ * <p>Objects of the following type(s) are allowed in the list
+ * {@link Config }</p>
+ *
+ * @return the list of config elements in a feature.
*/
public List<Config> getConfig() {
if (config == null) {
@@ -70,24 +60,22 @@ public class Content {
}
/**
- * Gets the value of the configfile property.
- * <p/>
- * <p/>
- * This accessor method returns a reference to the live list,
+ * <p>Gets the value of the configfile property.</p>
+ *
+ * <p>This accessor method returns a reference to the live list,
* not a snapshot. Therefore any modification you make to the
* returned list will be present inside the JAXB object.
- * This is why there is not a <CODE>set</CODE> method for the configfile property.
- * <p/>
- * <p/>
- * For example, to add a new item, do as follows:
+ * This is why there is not a <CODE>set</CODE> method for the configfile property.</p>
+ *
+ * <p>For example, to add a new item, do as follows:</p>
* <pre>
* getConfigfile().add(newItem);
* </pre>
- * <p/>
- * <p/>
- * <p/>
- * Objects of the following type(s) are allowed in the list
- * {@link ConfigFile }
+ *
+ * <p>Objects of the following type(s) are allowed in the list
+ * {@link ConfigFile }</p>
+ *
+ * @return the list of configfile elements in a feature.
*/
public List<ConfigFile> getConfigfile() {
if (configfile == null) {
@@ -97,24 +85,22 @@ public class Content {
}
/**
- * Gets the value of the feature property.
- * <p/>
- * <p/>
- * This accessor method returns a reference to the live list,
+ * <p>Gets the value of the feature property.</p>
+ *
+ * <p>This accessor method returns a reference to the live list,
* not a snapshot. Therefore any modification you make to the
* returned list will be present inside the JAXB object.
- * This is why there is not a <CODE>set</CODE> method for the feature property.
- * <p/>
- * <p/>
- * For example, to add a new item, do as follows:
+ * This is why there is not a <CODE>set</CODE> method for the feature property.</p>
+ *
+ * <p>For example, to add a new item, do as follows:</p>
* <pre>
* getFeatures().add(newItem);
* </pre>
- * <p/>
- * <p/>
- * <p/>
- * Objects of the following type(s) are allowed in the list
- * {@link Dependency }
+ *
+ * <p>Objects of the following type(s) are allowed in the list
+ * {@link Dependency }</p>
+ *
+ * @return the list of dependency features in a feature.
*/
public List<Dependency> getFeature() {
if (feature == null) {
@@ -124,24 +110,22 @@ public class Content {
}
/**
- * Gets the value of the bundle property.
- * <p/>
- * <p/>
- * This accessor method returns a reference to the live list,
+ * <p>Gets the value of the bundle property.</p>
+ *
+ * <p>This accessor method returns a reference to the live list,
* not a snapshot. Therefore any modification you make to the
* returned list will be present inside the JAXB object.
- * This is why there is not a <CODE>set</CODE> method for the bundle property.
- * <p/>
- * <p/>
- * For example, to add a new item, do as follows:
+ * This is why there is not a <CODE>set</CODE> method for the bundle property.</p>
+ *
+ * <p>For example, to add a new item, do as follows:</p>
* <pre>
* getBundle().add(newItem);
* </pre>
- * <p/>
- * <p/>
- * <p/>
- * Objects of the following type(s) are allowed in the list
- * {@link Bundle }
+ *
+ * <p>Objects of the following type(s) are allowed in the list
+ * {@link Bundle }</p>
+ *
+ * @return the list of bundle elements in a feature.
*/
public List<Bundle> getBundle() {
if (bundle == null) {
http://git-wip-us.apache.org/repos/asf/karaf/blob/8a1e7574/features/core/src/main/java/org/apache/karaf/features/internal/model/Dependency.java
----------------------------------------------------------------------
diff --git a/features/core/src/main/java/org/apache/karaf/features/internal/model/Dependency.java b/features/core/src/main/java/org/apache/karaf/features/internal/model/Dependency.java
index a0a3854..34067c6 100644
--- a/features/core/src/main/java/org/apache/karaf/features/internal/model/Dependency.java
+++ b/features/core/src/main/java/org/apache/karaf/features/internal/model/Dependency.java
@@ -24,21 +24,17 @@ import javax.xml.bind.annotation.XmlValue;
/**
- * Dependency of feature.
- * <p/>
- * <p/>
- * <p>Java class for dependency complex type.
- * <p/>
- * <p>The following schema fragment specifies the expected content contained within this class.
- * <p/>
+ * <p>Dependency of feature.</p>
+ * <p>Java class for dependency complex type.</p>
+ * <p>The following schema fragment specifies the expected content contained within this class.</p>
* <pre>
- * <complexType name="dependency">
- * <simpleContent>
- * <extension base="<http://karaf.apache.org/xmlns/features/v1.0.0>featureName">
- * <attribute name="version" type="{http://www.w3.org/2001/XMLSchema}string" default="0.0.0" />
- * </extension>
- * </simpleContent>
- * </complexType>
+ * <complexType name="dependency">
+ * <simpleContent>
+ * <extension base="<http://karaf.apache.org/xmlns/features/v1.0.0>featureName">
+ * <attribute name="version" type="{http://www.w3.org/2001/XMLSchema}string" default="0.0.0" />
+ * </extension>
+ * </simpleContent>
+ * </complexType>
* </pre>
*/
@XmlAccessorType(XmlAccessType.FIELD)
http://git-wip-us.apache.org/repos/asf/karaf/blob/8a1e7574/features/core/src/main/java/org/apache/karaf/features/internal/model/Feature.java
----------------------------------------------------------------------
diff --git a/features/core/src/main/java/org/apache/karaf/features/internal/model/Feature.java b/features/core/src/main/java/org/apache/karaf/features/internal/model/Feature.java
index 8ea59f1..635c2ea 100644
--- a/features/core/src/main/java/org/apache/karaf/features/internal/model/Feature.java
+++ b/features/core/src/main/java/org/apache/karaf/features/internal/model/Feature.java
@@ -34,34 +34,30 @@ import org.apache.felix.utils.version.VersionCleaner;
/**
- * Definition of the Feature.
- * <p/>
- * <p/>
- * <p>Java class for feature complex type.
- * <p/>
- * <p>The following schema fragment specifies the expected content contained within this class.
- * <p/>
+ * <p>Definition of the Feature.</p>
+ * <p>Java class for feature complex type.</p>
+ * <p>The following schema fragment specifies the expected content contained within this class.</p>
* <pre>
- * <complexType name="feature">
- * <complexContent>
- * <restriction base="{http://www.w3.org/2001/XMLSchema}anyType">
- * <sequence>
- * <element name="details" type="{http://www.w3.org/2001/XMLSchema}string" minOccurs="0"/>
- * <element name="config" type="{http://karaf.apache.org/xmlns/features/v1.0.0}config" maxOccurs="unbounded" minOccurs="0"/>
- * <element name="configfile" type="{http://karaf.apache.org/xmlns/features/v1.0.0}configFile" maxOccurs="unbounded" minOccurs="0"/>
- * <element name="feature" type="{http://karaf.apache.org/xmlns/features/v1.0.0}dependency" maxOccurs="unbounded" minOccurs="0"/>
- * <element name="bundle" type="{http://karaf.apache.org/xmlns/features/v1.0.0}bundle" maxOccurs="unbounded" minOccurs="0"/>
- * <element name="conditional" type="{http://karaf.apache.org/xmlns/features/v1.0.0}conditional" maxOccurs="unbounded" minOccurs="0"/>
- * <element name="capability" type="{http://karaf.apache.org/xmlns/features/v1.0.0}capability" maxOccurs="unbounded" minOccurs="0"/>
- * <element name="requirement" type="{http://karaf.apache.org/xmlns/features/v1.0.0}requirement" maxOccurs="unbounded" minOccurs="0"/>
- * </sequence>
- * <attribute name="name" use="required" type="{http://karaf.apache.org/xmlns/features/v1.0.0}featureName" />
- * <attribute name="version" type="{http://www.w3.org/2001/XMLSchema}string" default="0.0.0" />
- * <attribute name="description" type="{http://www.w3.org/2001/XMLSchema}string" />
- * <attribute name="resolver" type="{http://karaf.apache.org/xmlns/features/v1.0.0}resolver" />
- * </restriction>
- * </complexContent>
- * </complexType>
+ * <complexType name="feature">
+ * <complexContent>
+ * <restriction base="{http://www.w3.org/2001/XMLSchema}anyType">
+ * <sequence>
+ * <element name="details" type="{http://www.w3.org/2001/XMLSchema}string" minOccurs="0"/>
+ * <element name="config" type="{http://karaf.apache.org/xmlns/features/v1.0.0}config" maxOccurs="unbounded" minOccurs="0"/>
+ * <element name="configfile" type="{http://karaf.apache.org/xmlns/features/v1.0.0}configFile" maxOccurs="unbounded" minOccurs="0"/>
+ * <element name="feature" type="{http://karaf.apache.org/xmlns/features/v1.0.0}dependency" maxOccurs="unbounded" minOccurs="0"/>
+ * <element name="bundle" type="{http://karaf.apache.org/xmlns/features/v1.0.0}bundle" maxOccurs="unbounded" minOccurs="0"/>
+ * <element name="conditional" type="{http://karaf.apache.org/xmlns/features/v1.0.0}conditional" maxOccurs="unbounded" minOccurs="0"/>
+ * <element name="capability" type="{http://karaf.apache.org/xmlns/features/v1.0.0}capability" maxOccurs="unbounded" minOccurs="0"/>
+ * <element name="requirement" type="{http://karaf.apache.org/xmlns/features/v1.0.0}requirement" maxOccurs="unbounded" minOccurs="0"/>
+ * </sequence>
+ * <attribute name="name" use="required" type="{http://karaf.apache.org/xmlns/features/v1.0.0}featureName" />
+ * <attribute name="version" type="{http://www.w3.org/2001/XMLSchema}string" default="0.0.0" />
+ * <attribute name="description" type="{http://www.w3.org/2001/XMLSchema}string" />
+ * <attribute name="resolver" type="{http://karaf.apache.org/xmlns/features/v1.0.0}resolver" />
+ * </restriction>
+ * </complexContent>
+ * </complexType>
* </pre>
*/
@XmlAccessorType(XmlAccessType.FIELD)
@@ -122,7 +118,6 @@ public class Feature extends Content implements org.apache.karaf.features.Featur
this.version = VersionCleaner.clean(version);
}
-
public static org.apache.karaf.features.Feature valueOf(String str) {
if (str.contains(VERSION_SEPARATOR)) {
String strName = str.substring(0, str.indexOf(VERSION_SEPARATOR));
@@ -136,36 +131,32 @@ public class Feature extends Content implements org.apache.karaf.features.Featur
}
-
public String getId() {
return getName() + VERSION_SEPARATOR + getVersion();
}
/**
- * Gets the value of the name property.
+ * Get the value of the name property.
*
- * @return possible object is
- * {@link String }
+ * @return possible object is {@link String}
*/
public String getName() {
return name;
}
/**
- * Sets the value of the name property.
+ * Set the value of the name property.
*
- * @param value allowed object is
- * {@link String }
+ * @param value allowed object is {@link String}
*/
public void setName(String value) {
this.name = value;
}
/**
- * Gets the value of the version property.
+ * Get the value of the version property.
*
- * @return possible object is
- * {@link String }
+ * @return possible object is {@link String}
*/
public String getVersion() {
if (version == null) {
@@ -176,10 +167,9 @@ public class Feature extends Content implements org.apache.karaf.features.Featur
}
/**
- * Sets the value of the version property.
+ * Set the value of the version property.
*
- * @param value allowed object is
- * {@link String }
+ * @param value allowed object is {@link String}
*/
@XmlAttribute
public void setVersion(String value) {
@@ -189,120 +179,139 @@ public class Feature extends Content implements org.apache.karaf.features.Featur
/**
* Since version has a default value ("0.0.0"), returns
* whether or not the version has been set.
+ *
+ * @return true if the feature has a version, false else.
*/
public boolean hasVersion() {
return this.version != null;
}
/**
- * Gets the value of the description property.
+ * Get the value of the description property.
*
- * @return possible object is
- * {@link String }
+ * @return possible object is {@link String}.
*/
public String getDescription() {
return description;
}
/**
- * Sets the value of the description property.
+ * Set the value of the description property.
*
- * @param value allowed object is
- * {@link String }
+ * @param value allowed object is {@link String}.
*/
public void setDescription(String value) {
this.description = value;
}
+ /**
+ * Get the feature details.
+ *
+ * @return the feature details.
+ */
public String getDetails() {
return details;
}
+ /**
+ * Set the feature details.
+ *
+ * @param details the feature details.
+ */
public void setDetails(String details) {
this.details = details;
}
/**
- * Gets the value of the resolver property.
+ * Get the value of the resolver property.
*
- * @return possible object is
- * {@link String }
+ * @return possible object is {@link String}.
*/
public String getResolver() {
return resolver;
}
+ /**
+ * Get the feature install flag.
+ *
+ * @return the feature install flags.
+ */
public String getInstall() {
return install;
}
+ /**
+ * Set the feature install flag.
+ *
+ * @param install the feature install flag.
+ */
public void setInstall(String install) {
this.install = install;
}
/**
- * Sets the value of the resolver property.
+ * Set the value of the resolver property.
*
- * @param value allowed object is
- * {@link String }
+ * @param value allowed object is {@link String}.
*/
public void setResolver(String value) {
this.resolver = value;
}
/**
- * Gets the value of the startLevel property.
+ * Get the value of the startLevel property.
*
- * @return possible object is
- * {@link Integer }
+ * @return possible object is {@link Integer}.
*/
public int getStartLevel() {
return startLevel == null ? 0 : startLevel;
}
/**
- * Sets the value of the startLevel property.
+ * Set the value of the startLevel property.
*
- * @param value allowed object is
- * {@link Integer }
+ * @param value allowed object is {@link Integer}.
*/
public void setStartLevel(Integer value) {
this.startLevel = value;
}
/**
- * Gets the value of the hidden property.
+ * Get the value of the hidden property.
+ *
+ * @return true if the feature is hidden, false else.
*/
public boolean isHidden() {
return hidden == null ? false : hidden;
}
/**
- * Sets the value of the hidden property.
+ * Set the value of the hidden property.
+ *
+ * @param value true to set the feature as hidden, false else.
*/
public void setHidden(Boolean value) {
this.hidden = value;
}
/**
- * Gets the value of the conditional property.
- * <p/>
- * <p/>
+ * Get the value of the conditional property.
+ *
* This accessor method returns a reference to the live list,
* not a snapshot. Therefore any modification you make to the
* returned list will be present inside the JAXB object.
* This is why there is not a <CODE>set</CODE> method for the feature property.
- * <p/>
- * <p/>
+ *
* For example, to add a new item, do as follows:
+ *
* <pre>
* getConditionals().add(newItem);
* </pre>
- * <p/>
- * <p/>
- * <p/>
+ *
* Objects of the following type(s) are allowed in the list
- * {@link Conditional }
+ * {@link Conditional}.
+ *
+ * @return the list of feature conditions.
*/
public List<Conditional> getConditional() {
if (conditional == null) {
@@ -311,6 +320,11 @@ public class Feature extends Content implements org.apache.karaf.features.Featur
return this.conditional;
}
+ /**
+ * Get the feature capabilities.
+ *
+ * @return the feature capabilities as a {@link List}..
+ */
public List<Capability> getCapabilities() {
if (capability == null) {
capability = new ArrayList<>();
@@ -318,6 +332,11 @@ public class Feature extends Content implements org.apache.karaf.features.Featur
return this.capability;
}
+ /**
+ * Get the feature requirements.
+ *
+ * @return the feature requirements as a {@link List}.
+ */
public List<Requirement> getRequirements() {
if (requirement == null) {
requirement = new ArrayList<>();
@@ -325,14 +344,29 @@ public class Feature extends Content implements org.apache.karaf.features.Featur
return this.requirement;
}
+ /**
+ * Get the feature scoping.
+ *
+ * @return the feature scoping.
+ */
public Scoping getScoping() {
return scoping;
}
+ /**
+ * Set the feature scoping.
+ *
+ * @param scoping the feature scoping.
+ */
public void setScoping(Scoping scoping) {
this.scoping = scoping;
}
+ /**
+ * Return a string representation of the feature.
+ *
+ * @return the feature string representation.
+ */
public String toString() {
return getId();
}
http://git-wip-us.apache.org/repos/asf/karaf/blob/8a1e7574/features/core/src/main/java/org/apache/karaf/features/internal/model/Features.java
----------------------------------------------------------------------
diff --git a/features/core/src/main/java/org/apache/karaf/features/internal/model/Features.java b/features/core/src/main/java/org/apache/karaf/features/internal/model/Features.java
index 95be1d4..30039ae 100644
--- a/features/core/src/main/java/org/apache/karaf/features/internal/model/Features.java
+++ b/features/core/src/main/java/org/apache/karaf/features/internal/model/Features.java
@@ -28,30 +28,25 @@ import javax.xml.bind.annotation.XmlSchemaType;
import javax.xml.bind.annotation.XmlTransient;
import javax.xml.bind.annotation.XmlType;
-
/**
- * Root element of Feature definition. It contains optional attribute which allow
+ * <p>Root element of Feature definition. It contains optional attribute which allow
* name of repository. This name will be used in shell to display source repository
- * of given feature.
- * <p/>
- * <p/>
- * <p>Java class for featuresRoot complex type.
- * <p/>
- * <p>The following schema fragment specifies the expected content contained within this class.
- * <p/>
+ * of given feature.</p>
+ * <p>Java class for featuresRoot complex type.</p>
+ * <p>The following schema fragment specifies the expected content contained within this class.</p>
* <pre>
- * <complexType name="features">
- * <complexContent>
- * <restriction base="{http://www.w3.org/2001/XMLSchema}anyType">
- * <sequence>
- * <element name="repository" type="{http://www.w3.org/2001/XMLSchema}anyURI" maxOccurs="unbounded" minOccurs="0"/>
- * <element name="resource-repository" type="{http://www.w3.org/2001/XMLSchema}anyURI" maxOccurs="unbounded" minOccurs="0"/>
- * <element name="feature" type="{http://karaf.apache.org/xmlns/features/v1.0.0}feature" maxOccurs="unbounded" minOccurs="0"/>
- * </sequence>
- * <attribute name="name" type="{http://www.w3.org/2001/XMLSchema}string" />
- * </restriction>
- * </complexContent>
- * </complexType>
+ * <complexType name="features">
+ * <complexContent>
+ * <restriction base="{http://www.w3.org/2001/XMLSchema}anyType">
+ * <sequence>
+ * <element name="repository" type="{http://www.w3.org/2001/XMLSchema}anyURI" maxOccurs="unbounded" minOccurs="0"/>
+ * <element name="resource-repository" type="{http://www.w3.org/2001/XMLSchema}anyURI" maxOccurs="unbounded" minOccurs="0"/>
+ * <element name="feature" type="{http://karaf.apache.org/xmlns/features/v1.0.0}feature" maxOccurs="unbounded" minOccurs="0"/>
+ * </sequence>
+ * <attribute name="name" type="{http://www.w3.org/2001/XMLSchema}string" />
+ * </restriction>
+ * </complexContent>
+ * </complexType>
* </pre>
*/
@XmlRootElement(name = "features")
@@ -70,24 +65,23 @@ public class Features {
private String namespace;
/**
- * Gets the value of the repository property.
- * <p/>
- * <p/>
- * This accessor method returns a reference to the live list,
+ * <p>Get the value of the repository property.</p>
+ *
+ * <p>This accessor method returns a reference to the live list,
* not a snapshot. Therefore any modification you make to the
* returned list will be present inside the JAXB object.
- * This is why there is not a <CODE>set</CODE> method for the repository property.
- * <p/>
- * <p/>
- * For example, to add a new item, do as follows:
+ * This is why there is not a <CODE>set</CODE> method for the repository property.</p>
+ *
+ * <p>For example, to add a new item, do as follows:</p>
+ *
* <pre>
* getRepository().add(newItem);
* </pre>
- * <p/>
- * <p/>
- * <p/>
- * Objects of the following type(s) are allowed in the list
- * {@link String }
+ *
+ * <p>Objects of the following type(s) are allowed in the list
+ * {@link String}.</p>
+ *
+ * @return the list of inner repositories.
*/
public List<String> getRepository() {
if (repository == null) {
@@ -97,24 +91,25 @@ public class Features {
}
/**
- * Gets the value of the resource repository property.
- * <p/>
- * <p/>
- * This accessor method returns a reference to the live list,
+ * <p>Get the value of the resource repository property.</p>
+ *
+ * <p>This accessor method returns a reference to the live list,
* not a snapshot. Therefore any modification you make to the
- * returned list will be present inside the JAXB object.
- * This is why there is not a <CODE>set</CODE> method for the resource repository property.
- * <p/>
- * <p/>
- * For example, to add a new item, do as follows:
+ * returned list will be present inside the JAXB object.</p>
+ *
+ * <p>This is why there is not a <CODE>set</CODE> method for
+ * the resource repository property.</p>
+ *
+ * <p>For example, to add a new item, do as follows:</p>
+ *
* <pre>
* getResourceRepository().add(newItem);
* </pre>
- * <p/>
- * <p/>
- * <p/>
- * Objects of the following type(s) are allowed in the list
- * {@link String }
+ *
+ * <p>Objects of the following type(s) are allowed in the list
+ * {@link String}</p>
+ *
+ * @return the list of inner resource repositories.
*/
public List<String> getResourceRepository() {
if (resourceRepository == null) {
@@ -124,24 +119,25 @@ public class Features {
}
/**
- * Gets the value of the feature property.
- * <p/>
- * <p/>
- * This accessor method returns a reference to the live list,
+ * <p>Get the value of the feature property.</p>
+ *
+ * <p>This accessor method returns a reference to the live list,
* not a snapshot. Therefore any modification you make to the
- * returned list will be present inside the JAXB object.
- * This is why there is not a <CODE>set</CODE> method for the feature property.
- * <p/>
- * <p/>
- * For example, to add a new item, do as follows:
+ * returned list will be present inside the JAXB object.</p>
+ *
+ * <p>This is why there is not a <CODE>set</CODE> method
+ * for the feature property.</p>
+ *
+ * <p>For example, to add a new item, do as follows:</p>
+ *
* <pre>
* getFeatures().add(newItem);
* </pre>
- * <p/>
- * <p/>
- * <p/>
- * Objects of the following type(s) are allowed in the list
- * {@link Feature }
+ *
+ * <p>Objects of the following type(s) are allowed in the list
+ * {@link Feature}.</p>
+ *
+ * @return the list of inner features.
*/
public List<Feature> getFeature() {
if (feature == null) {
@@ -151,20 +147,18 @@ public class Features {
}
/**
- * Gets the value of the name property.
+ * Get the value of the name property.
*
- * @return possible object is
- * {@link String }
+ * @return possible object is {@link String}.
*/
public String getName() {
return name;
}
/**
- * Sets the value of the name property.
+ * Set the value of the name property.
*
- * @param value allowed object is
- * {@link String }
+ * @param value allowed object is {@link String}.
*/
public void setName(String value) {
this.name = value;
http://git-wip-us.apache.org/repos/asf/karaf/blob/8a1e7574/features/core/src/main/java/org/apache/karaf/features/internal/model/ObjectFactory.java
----------------------------------------------------------------------
diff --git a/features/core/src/main/java/org/apache/karaf/features/internal/model/ObjectFactory.java b/features/core/src/main/java/org/apache/karaf/features/internal/model/ObjectFactory.java
index 7ad5c18..6ae4cb2 100644
--- a/features/core/src/main/java/org/apache/karaf/features/internal/model/ObjectFactory.java
+++ b/features/core/src/main/java/org/apache/karaf/features/internal/model/ObjectFactory.java
@@ -21,19 +21,18 @@ import javax.xml.bind.annotation.XmlElementDecl;
import javax.xml.bind.annotation.XmlRegistry;
import javax.xml.namespace.QName;
-
/**
- * This object contains factory methods for each
+ * <p>This object contains factory methods for each
* Java content interface and Java element interface
- * generated in the org.apache.karaf.features.wrapper package.
- * <p>An ObjectFactory allows you to programatically
+ * generated in the org.apache.karaf.features.wrapper package.</p>
+ * <p>An ObjectFactory allows you to programmatically
* construct new instances of the Java representation
* for XML content. The Java representation of XML
* content can consist of schema derived interfaces
* and classes representing the binding of schema
* type definitions, element declarations and model
* groups. Factory methods for each of these are
- * provided in this class.
+ * provided in this class.</p>
*/
@XmlRegistry
public class ObjectFactory {
@@ -47,49 +46,64 @@ public class ObjectFactory {
}
/**
- * Create an instance of {@link ConfigFile }
+ * Create an instance of {@link ConfigFile}
+ *
+ * @return the config file.
*/
public ConfigFile createConfigFile() {
return new ConfigFile();
}
/**
- * Create an instance of {@link Dependency }
+ * Create an instance of {@link Dependency}
+ *
+ * @return the dependency.
*/
public Dependency createDependency() {
return new Dependency();
}
/**
- * Create an instance of {@link Bundle }
+ * Create an instance of {@link Bundle}
+ *
+ * @return the bundle.
*/
public Bundle createBundle() {
return new Bundle();
}
/**
- * Create an instance of {@link Features }
+ * Create an instance of {@link Features}
+ *
+ * @return the features.
*/
public Features createFeaturesRoot() {
return new Features();
}
/**
- * Create an instance of {@link Config }
+ * Create an instance of {@link Config}
+ *
+ * @return the config.
*/
public Config createConfig() {
return new Config();
}
/**
- * Create an instance of {@link Feature }
+ * Create an instance of {@link Feature}
+ *
+ * @return the feature.
*/
public Feature createFeature() {
return new Feature();
}
/**
- * Create an instance of {@link JAXBElement }{@code <}{@link Features }{@code >}}
+ * Create an instance of {@link JAXBElement}{@code <}{@link Features }{@code >}
+ *
+ * @param value the features
+ * @return the JAXB representation of the given features.
*/
@XmlElementDecl(namespace = "http://karaf.apache.org/xmlns/features/v1.0.0", name = "features")
public JAXBElement<Features> createFeatures(Features value) {
http://git-wip-us.apache.org/repos/asf/karaf/blob/8a1e7574/features/core/src/main/java/org/apache/karaf/features/internal/model/Requirement.java
----------------------------------------------------------------------
diff --git a/features/core/src/main/java/org/apache/karaf/features/internal/model/Requirement.java b/features/core/src/main/java/org/apache/karaf/features/internal/model/Requirement.java
index 6771e3d..7fbabc3 100644
--- a/features/core/src/main/java/org/apache/karaf/features/internal/model/Requirement.java
+++ b/features/core/src/main/java/org/apache/karaf/features/internal/model/Requirement.java
@@ -23,20 +23,16 @@ import javax.xml.bind.annotation.XmlValue;
/**
- * Additional requirement for a feature.
- * <p/>
- * <p/>
- * <p>Java class for bundle complex type.
- * <p/>
- * <p>The following schema fragment specifies the expected content contained within this class.
- * <p/>
+ * <p>Additional requirement for a feature.</p>
+ * <p>Java class for bundle complex type.</p>
+ * <p>The following schema fragment specifies the expected content contained within this class.</p>
* <pre>
- * <complexType name="capability">
- * <simpleContent>
- * <extension base="<http://www.w3.org/2001/XMLSchema>string">
- * </extension>
- * </simpleContent>
- * </complexType>
+ * <complexType name="capability">
+ * <simpleContent>
+ * <extension base="<http://www.w3.org/2001/XMLSchema>string">
+ * </extension>
+ * </simpleContent>
+ * </complexType>
* </pre>
*/
@XmlAccessorType(XmlAccessType.FIELD)
http://git-wip-us.apache.org/repos/asf/karaf/blob/8a1e7574/features/core/src/main/java/org/apache/karaf/features/internal/resolver/ResourceBuilder.java
----------------------------------------------------------------------
diff --git a/features/core/src/main/java/org/apache/karaf/features/internal/resolver/ResourceBuilder.java b/features/core/src/main/java/org/apache/karaf/features/internal/resolver/ResourceBuilder.java
index e624b7f..122d59a 100644
--- a/features/core/src/main/java/org/apache/karaf/features/internal/resolver/ResourceBuilder.java
+++ b/features/core/src/main/java/org/apache/karaf/features/internal/resolver/ResourceBuilder.java
@@ -1132,6 +1132,7 @@ public final class ResourceBuilder {
*
* @param value the delimited string to parse.
* @param delim the characters delimiting the tokens.
+ * @param trim true to trim the string, false else.
* @return a list of string or an empty list if there are none.
*/
public static List<String> parseDelimitedString(String value, String delim, boolean trim) {
http://git-wip-us.apache.org/repos/asf/karaf/blob/8a1e7574/features/core/src/main/java/org/apache/karaf/features/internal/service/BootFeaturesInstaller.java
----------------------------------------------------------------------
diff --git a/features/core/src/main/java/org/apache/karaf/features/internal/service/BootFeaturesInstaller.java b/features/core/src/main/java/org/apache/karaf/features/internal/service/BootFeaturesInstaller.java
index f3b1647..2b3f81b 100644
--- a/features/core/src/main/java/org/apache/karaf/features/internal/service/BootFeaturesInstaller.java
+++ b/features/core/src/main/java/org/apache/karaf/features/internal/service/BootFeaturesInstaller.java
@@ -58,10 +58,7 @@ public class BootFeaturesInstaller {
* The system separator character.
*/
private static final char SYSTEM_SEPARATOR = File.separatorChar;
-
- /**
- * @param features list of boot features separated by comma. Optionally contains ;version=x.x.x to specify a specific feature version
- */
+
public BootFeaturesInstaller(BundleContext bundleContext,
FeaturesServiceImpl featuresService,
String repositories,
http://git-wip-us.apache.org/repos/asf/karaf/blob/8a1e7574/features/core/src/main/java/org/apache/karaf/features/internal/service/Deployer.java
----------------------------------------------------------------------
diff --git a/features/core/src/main/java/org/apache/karaf/features/internal/service/Deployer.java b/features/core/src/main/java/org/apache/karaf/features/internal/service/Deployer.java
index b7b7af6..3a053f4 100644
--- a/features/core/src/main/java/org/apache/karaf/features/internal/service/Deployer.java
+++ b/features/core/src/main/java/org/apache/karaf/features/internal/service/Deployer.java
@@ -191,10 +191,11 @@ public class Deployer {
}
/**
+ * Perform a deployment.
*
* @param dstate deployment state
* @param request deployment request
- * @throws Exception
+ * @throws Exception in case of deployment failure.
*/
public void deploy(DeploymentState dstate, DeploymentRequest request) throws Exception {
http://git-wip-us.apache.org/repos/asf/karaf/blob/8a1e7574/features/core/src/main/java/org/apache/karaf/features/internal/service/FeatureConfigInstaller.java
----------------------------------------------------------------------
diff --git a/features/core/src/main/java/org/apache/karaf/features/internal/service/FeatureConfigInstaller.java b/features/core/src/main/java/org/apache/karaf/features/internal/service/FeatureConfigInstaller.java
index 7e588f0..f040ac2 100644
--- a/features/core/src/main/java/org/apache/karaf/features/internal/service/FeatureConfigInstaller.java
+++ b/features/core/src/main/java/org/apache/karaf/features/internal/service/FeatureConfigInstaller.java
@@ -149,8 +149,7 @@ public class FeatureConfigInstaller {
/**
* Substitute variables in the final name and append prefix if necessary.
- *
- * <p>
+ *
* <ol>
* <li>If the final name does not start with '${' it is prefixed with
* karaf.base (+ file separator).</li>
@@ -161,7 +160,6 @@ public class FeatureConfigInstaller {
* substituted, it will be prefixed with karaf.base (+ file separator), too.
* </li>
* </ol>
- * </p>
*
* @param finalname
* The final name that should be processed.