Author: davidb
Date: Fri Dec 29 21:44:35 2017
New Revision: 1819523
URL: http://svn.apache.org/viewvc?rev=1819523&view=rev
Log:
Fixes to javadoc to make it releasable.
Modified:
aries/trunk/jmx/jmx-blueprint-api/src/main/java/org/apache/aries/jmx/blueprint/BlueprintStateMBean.java
aries/trunk/jmx/jmx-blueprint-api/src/main/java/org/apache/aries/jmx/blueprint/Item.java
aries/trunk/jmx/jmx-blueprint-api/src/main/java/org/apache/aries/jmx/blueprint/JmxConstants.java
Modified:
aries/trunk/jmx/jmx-blueprint-api/src/main/java/org/apache/aries/jmx/blueprint/BlueprintStateMBean.java
URL:
http://svn.apache.org/viewvc/aries/trunk/jmx/jmx-blueprint-api/src/main/java/org/apache/aries/jmx/blueprint/BlueprintStateMBean.java?rev=1819523&r1=1819522&r2=1819523&view=diff
==============================================================================
---
aries/trunk/jmx/jmx-blueprint-api/src/main/java/org/apache/aries/jmx/blueprint/BlueprintStateMBean.java
(original)
+++
aries/trunk/jmx/jmx-blueprint-api/src/main/java/org/apache/aries/jmx/blueprint/BlueprintStateMBean.java
Fri Dec 29 21:44:35 2017
@@ -32,7 +32,7 @@ import javax.management.openmbean.Tabula
*
* This MBean also emits events that clients can use to get notified of the
* changes in the blueprint containers state in the framework.
- *
+ *
* @version $Revision$
*/
public interface BlueprintStateMBean {
@@ -40,16 +40,16 @@ public interface BlueprintStateMBean {
* The object name for this MBean.
*/
String OBJECTNAME =
JmxConstants.ARIES_BLUEPRINT+":service=blueprintState,version=1.0";
-
+
///////////////////////////////////////////////////////////////
// Define Event's CompositeType
///////////////////////////////////////////////////////////////
-
+
/**
* The key BUNDLE_ID, used in {@link #BUNDLE_ID_ITEM}.
*/
String BUNDLE_ID = "BundleId";
-
+
/**
* The item containing the Blueprint bundle id associated with this event.
* The key is {@link #BUNDLE_ID}, and the type is {@link SimpleType#LONG}.
@@ -58,12 +58,12 @@ public interface BlueprintStateMBean {
BUNDLE_ID,
"the Blueprint bundle id
associated with this event.",
SimpleType.LONG);
-
+
/**
* The key EXTENDER_BUNDLE_ID, used in {@link #EXTENDER_BUNDLE_ID_ITEM}.
*/
String EXTENDER_BUNDLE_ID = "ExtenderBundleId";
-
+
/**
* The item containing the Blueprint extender bundle id that is generating
this event.
* The key is {@link #EXTENDER_BUNDLE_ID}, and the type is {@link
SimpleType#LONG}.
@@ -75,9 +75,9 @@ public interface BlueprintStateMBean {
/**
* The key REPLAY, used in {@link #REPLAY_ITEM}.
- */
+ */
String REPLAY = "Replay";
-
+
/**
* The item containing the flag that represents whether this event is a
replay event.
* The key is {@link #REPLAY}, and the type is {@link SimpleType#BOOLEAN}.
@@ -86,13 +86,13 @@ public interface BlueprintStateMBean {
REPLAY,
"the flag that represents
whether this event is a replay event.",
SimpleType.BOOLEAN);
-
-
+
+
/**
* The key EVENT_TYPE, used in {@link #EVENT_TYPE_ITEM}.
*/
String EVENT_TYPE = "EventType";
-
+
/**
* The item containing the type of this event.
* The key is {@link #EVENT_TYPE}, and the type is {@link
SimpleType#STRING}.
@@ -101,12 +101,12 @@ public interface BlueprintStateMBean {
EVENT_TYPE,
"The type of the event:
{CREATING=1, CREATED=2, DESTROYING=3, DESTROYED=4, FAILURE=5, GRACE_PERIOD=6,
WAITING=7}",
SimpleType.INTEGER);
-
+
/**
* The key TIMESTAMP, used in {@link #TIMESTAMP_ITEM}.
- */
+ */
String TIMESTAMP = "Timestamp";
-
+
/**
* The item containing the time at which this event was created.
* The key is {@link #TIMESTAMP}, and the type is {@link SimpleType#LONG}.
@@ -121,7 +121,7 @@ public interface BlueprintStateMBean {
* The key DEPENDENCIES, used in {@link #DEPENDENCIES_ITEM}.
*/
String DEPENDENCIES = "Dependencies";
-
+
/**
* The item containing the filters identifying the missing dependencies
that caused the WAITING, GRACE_PERIOD or FAILURE event.
* The key is {@link #DEPENDENCIES}, and the type is {@link
JmxConstants#STRING_ARRAY_TYPE}.
@@ -130,12 +130,12 @@ public interface BlueprintStateMBean {
DEPENDENCIES,
"the filters identifying
the missing dependencies that caused the WAITING, GRACE_PERIOD or FAILURE
event.",
JmxConstants.STRING_ARRAY_TYPE);
-
+
/**
- * The key EXCEPTION_MESSAGE, used in {@link #ERROR_MESSAGE_ITEM}.
- */
+ * The key EXCEPTION_MESSAGE, used in {@link #EXCEPTION_MESSAGE_ITEM}.
+ */
String EXCEPTION_MESSAGE = "ExceptionMessage";
-
+
/**
* The item containing the exception message that cause this FAILURE event.
* The key is {@link #EXCEPTION_MESSAGE}, and the type is {@link
SimpleType#STRING}.
@@ -144,7 +144,7 @@ public interface BlueprintStateMBean {
EXCEPTION_MESSAGE,
"the exception message
that cause this FAILURE event.",
SimpleType.STRING);
-
+
/**
* The CompositeType for a blueprint event. It contains the following
items:
* <ul>
@@ -158,8 +158,8 @@ public interface BlueprintStateMBean {
* </ul>
*/
CompositeType OSGI_BLUEPRINT_EVENT_TYPE = Item.compositeType(
- "OSGI_BLUEPRINT_EVENT",
- "Blueprint event",
+ "OSGI_BLUEPRINT_EVENT",
+ "Blueprint event",
BUNDLE_ID_ITEM,
EXTENDER_BUNDLE_ID_ITEM,
EVENT_TYPE_ITEM,
@@ -167,44 +167,44 @@ public interface BlueprintStateMBean {
TIMESTAMP_ITEM,
DEPENDENCIES_ITEM,
EXCEPTION_MESSAGE_ITEM);
-
-
+
+
/**
* The Tabular Type for A list of blueprint events. The row type is
* {@link #OSGI_BLUEPRINT_EVENT_TYPE}.
*/
TabularType OSGI_BLUEPRINT_EVENTS_TYPE = Item.tabularType(
- "BUNDLES",
+ "BUNDLES",
"A list of blueprint
events",
- OSGI_BLUEPRINT_EVENT_TYPE,
+ OSGI_BLUEPRINT_EVENT_TYPE,
new String[] { BUNDLE_ID
});
-
+
/**
* Returns the BlueprintEvent associated with this blueprint container.
* The returned Composite Data is typed by {@link
#OSGI_BLUEPRINT_EVENT_TYPE}.
- *
+ *
* @param bundleId The bundle id of a blueprint bundle
- * @return the last event associated with the blueprint bundle, see {@link
#OSGI_BLUEPRINT_EVENT_TYPE}
+ * @return the last event associated with the blueprint bundle, see {@link
#OSGI_BLUEPRINT_EVENT_TYPE}
* @throws IOException if the operation fails
* @throws IllegalArgumentException if the bundle is not a blueprint bundle
*/
public CompositeData getLastEvent(long bundleId) throws IOException;
-
+
/**
* Returns all the last events associated with the blueprint bundles.
- *
+ *
* @return the tabular representation of all the last events associated
with the blueprint bundles see {@link #OSGI_BLUEPRINT_EVENTS_TYPE}
* @throws IOException if the operation fails
- */
+ */
public TabularData getLastEvents() throws IOException;
-
+
/**
- * Returns all the blueprint bundles' IDs, which are either
+ * Returns all the blueprint bundles' IDs, which are either
* successfully created or not by current extender.
- *
+ *
* @return the list of all the blueprint bundles's IDs (either
successfully created or not by current extender)
* @throws IOException if the operation fails
*/
public long[] getBlueprintBundleIds() throws IOException;
-
+
}
Modified:
aries/trunk/jmx/jmx-blueprint-api/src/main/java/org/apache/aries/jmx/blueprint/Item.java
URL:
http://svn.apache.org/viewvc/aries/trunk/jmx/jmx-blueprint-api/src/main/java/org/apache/aries/jmx/blueprint/Item.java?rev=1819523&r1=1819522&r2=1819523&view=diff
==============================================================================
---
aries/trunk/jmx/jmx-blueprint-api/src/main/java/org/apache/aries/jmx/blueprint/Item.java
(original)
+++
aries/trunk/jmx/jmx-blueprint-api/src/main/java/org/apache/aries/jmx/blueprint/Item.java
Fri Dec 29 21:44:35 2017
@@ -40,7 +40,7 @@ import javax.management.openmbean.Tabula
* An Item instance describes an item in a Composite Type. It groups the
triplet of name, description, and Open Type.
* These Item instances allows the definitions of an item to stay together.
*
- * @Immutable
+ * Immutable
*/
public class Item {
Modified:
aries/trunk/jmx/jmx-blueprint-api/src/main/java/org/apache/aries/jmx/blueprint/JmxConstants.java
URL:
http://svn.apache.org/viewvc/aries/trunk/jmx/jmx-blueprint-api/src/main/java/org/apache/aries/jmx/blueprint/JmxConstants.java?rev=1819523&r1=1819522&r2=1819523&view=diff
==============================================================================
---
aries/trunk/jmx/jmx-blueprint-api/src/main/java/org/apache/aries/jmx/blueprint/JmxConstants.java
(original)
+++
aries/trunk/jmx/jmx-blueprint-api/src/main/java/org/apache/aries/jmx/blueprint/JmxConstants.java
Fri Dec 29 21:44:35 2017
@@ -26,10 +26,10 @@ import javax.management.openmbean.Simple
* Constants.
*
* Additionally, this class contains a number of utility types that are used in
- * different places in the specification. These are {@link #LONG_ARRAY_TYPE},
- * {@link #STRING_ARRAY_TYPE}, and {@link #PRIMITIVE_BYTE_ARRAY_TYPE}.
+ * different places in the specification. These are {@link #BYTE_ARRAY_TYPE},
+ * and {@link #STRING_ARRAY_TYPE}.
*
- * @Immutable
+ * Immutable
*/
public class JmxConstants {
