You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@aries.apache.org by cs...@apache.org on 2017/04/18 12:54:58 UTC

[06/50] aries-jpa git commit: [ARIES-1569] Fix javadoc creation for release

[ARIES-1569] Fix javadoc creation for release

git-svn-id: https://svn.apache.org/repos/asf/aries/trunk/jpa@1747670 13f79535-47bb-0310-9956-ffa450edef68


Project: http://git-wip-us.apache.org/repos/asf/aries-jpa/repo
Commit: http://git-wip-us.apache.org/repos/asf/aries-jpa/commit/168b966d
Tree: http://git-wip-us.apache.org/repos/asf/aries-jpa/tree/168b966d
Diff: http://git-wip-us.apache.org/repos/asf/aries-jpa/diff/168b966d

Branch: refs/heads/master
Commit: 168b966dce70e2589f89cab68748069aa9cf95cf
Parents: 445bc92
Author: cschneider <cs...@13f79535-47bb-0310-9956-ffa450edef68>
Authored: Fri Jun 10 09:15:55 2016 +0000
Committer: cschneider <cs...@13f79535-47bb-0310-9956-ffa450edef68>
Committed: Fri Jun 10 09:15:55 2016 +0000

----------------------------------------------------------------------
 examples/tasklist-blueprint/pom.xml             | 122 +++++++++----------
 .../jpa-container-blueprint-testbundle/pom.xml  |   6 +
 .../aries/jpa/container/impl/ManagedEMF.java    |   2 +-
 .../jpa/container/parser/impl/JPAHandler.java   |   2 +-
 .../parser/impl/PersistenceUnitParser.java      |   9 +-
 .../weaving/impl/TransformerRegistry.java       |  13 +-
 .../aries/jpa/support/osgi/impl/EMFTracker.java |   4 +-
 7 files changed, 77 insertions(+), 81 deletions(-)
----------------------------------------------------------------------


http://git-wip-us.apache.org/repos/asf/aries-jpa/blob/168b966d/examples/tasklist-blueprint/pom.xml
----------------------------------------------------------------------
diff --git a/examples/tasklist-blueprint/pom.xml b/examples/tasklist-blueprint/pom.xml
index ea47b2b..b5afd1e 100644
--- a/examples/tasklist-blueprint/pom.xml
+++ b/examples/tasklist-blueprint/pom.xml
@@ -1,67 +1,65 @@
 <?xml version="1.0" encoding="UTF-8"?>
-<!--
- Licensed to the Apache Software Foundation (ASF) under one
- or more contributor license agreements.  See the NOTICE file
- distributed with this work for additional information
- regarding copyright ownership.  The ASF licenses this file
- to you under the Apache License, Version 2.0 (the
- "License"); you may not use this file except in compliance
- with the License.  You may obtain a copy of the License at
+<!-- Licensed to the Apache Software Foundation (ASF) under one or more contributor 
+	license agreements. See the NOTICE file distributed with this work for additional 
+	information regarding copyright ownership. The ASF licenses this file to 
+	you under the Apache License, Version 2.0 (the "License"); you may not use 
+	this file except in compliance with the License. You may obtain a copy of 
+	the License at http://www.apache.org/licenses/LICENSE-2.0 Unless required 
+	by applicable law or agreed to in writing, software distributed under the 
+	License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS 
+	OF ANY KIND, either express or implied. See the License for the specific 
+	language governing permissions and limitations under the License. -->
+<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+	xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
+	<modelVersion>4.0.0</modelVersion>
+	<parent>
+		<groupId>org.apache.aries.jpa.example</groupId>
+		<artifactId>org.apache.aries.jpa.example.parent</artifactId>
+		<version>2.4.0-SNAPSHOT</version>
+		<relativePath>..</relativePath>
+	</parent>
+	<artifactId>org.apache.aries.jpa.example.tasklist.blueprint</artifactId>
+	<name>Apache Aries JPA example tasklist blueprint</name>
+	<packaging>bundle</packaging>
 
-    http://www.apache.org/licenses/LICENSE-2.0
+	<dependencies>
+		<dependency>
+			<groupId>org.eclipse.persistence</groupId>
+			<artifactId>javax.persistence</artifactId>
+		</dependency>
+		<dependency>
+			<groupId>javax.transaction</groupId>
+			<artifactId>javax.transaction-api</artifactId>
+		</dependency>
+		<dependency>
+			<groupId>javax.interceptor</groupId>
+			<artifactId>javax.interceptor-api</artifactId>
+			<version>1.2</version>
+		</dependency>
+		<dependency>
+			<groupId>javax.servlet</groupId>
+			<artifactId>servlet-api</artifactId>
+		</dependency>
+		<dependency>
+			<groupId>org.osgi</groupId>
+			<artifactId>org.osgi.compendium</artifactId>
+		</dependency>
+		<dependency>
+			<groupId>org.apache.aries.jpa.example</groupId>
+			<artifactId>org.apache.aries.jpa.example.tasklist.model</artifactId>
+		</dependency>
 
- Unless required by applicable law or agreed to in writing,
- software distributed under the License is distributed on an
- "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
- KIND, either express or implied.  See the License for the
- specific language governing permissions and limitations
- under the License.
--->
-<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
-    <modelVersion>4.0.0</modelVersion>
-    <parent>
-        <groupId>org.apache.aries.jpa.example</groupId>
-        <artifactId>org.apache.aries.jpa.example.parent</artifactId>
-        <version>2.4.0-SNAPSHOT</version>
-        <relativePath>..</relativePath>
-    </parent>
-    <artifactId>org.apache.aries.jpa.example.tasklist.blueprint</artifactId>
-    <name>Apache Aries JPA example tasklist blueprint</name>
-    <packaging>bundle</packaging>
-
-    <dependencies>
-        <dependency>
-            <groupId>org.eclipse.persistence</groupId>
-            <artifactId>javax.persistence</artifactId>
-        </dependency>
-        <dependency>
-            <groupId>javax.transaction</groupId>
-            <artifactId>javax.transaction-api</artifactId>
-        </dependency>
-        <dependency>
-            <groupId>javax.servlet</groupId>
-            <artifactId>servlet-api</artifactId>
-        </dependency>
-        <dependency>
-            <groupId>org.osgi</groupId>
-            <artifactId>org.osgi.compendium</artifactId>
-        </dependency>
-        <dependency>
-            <groupId>org.apache.aries.jpa.example</groupId>
-            <artifactId>org.apache.aries.jpa.example.tasklist.model</artifactId>
-        </dependency>
-
-        <!-- Test dependencies -->
-        <dependency>
-            <groupId>org.hibernate</groupId>
-            <artifactId>hibernate-entitymanager</artifactId>
-            <scope>test</scope>
-        </dependency>
-        <dependency>
-            <groupId>org.apache.derby</groupId>
-            <artifactId>derby</artifactId>
-            <scope>test</scope>
-        </dependency>
-    </dependencies>
+		<!-- Test dependencies -->
+		<dependency>
+			<groupId>org.hibernate</groupId>
+			<artifactId>hibernate-entitymanager</artifactId>
+			<scope>test</scope>
+		</dependency>
+		<dependency>
+			<groupId>org.apache.derby</groupId>
+			<artifactId>derby</artifactId>
+			<scope>test</scope>
+		</dependency>
+	</dependencies>
 
 </project>
\ No newline at end of file

http://git-wip-us.apache.org/repos/asf/aries-jpa/blob/168b966d/itests/jpa-container-blueprint-testbundle/pom.xml
----------------------------------------------------------------------
diff --git a/itests/jpa-container-blueprint-testbundle/pom.xml b/itests/jpa-container-blueprint-testbundle/pom.xml
index 2a01b7e..0820cb2 100644
--- a/itests/jpa-container-blueprint-testbundle/pom.xml
+++ b/itests/jpa-container-blueprint-testbundle/pom.xml
@@ -45,6 +45,12 @@ Also testing declarative transactions</description>
             <version>1.2</version>
             <scope>provided</scope>
         </dependency>
+		<dependency>
+			<groupId>javax.interceptor</groupId>
+			<artifactId>javax.interceptor-api</artifactId>
+			<version>1.2</version>
+			<scope>provided</scope>
+		</dependency>
         <dependency>
             <groupId>org.apache.geronimo.specs</groupId>
             <artifactId>geronimo-jpa_2.0_spec</artifactId>

http://git-wip-us.apache.org/repos/asf/aries-jpa/blob/168b966d/jpa-container/src/main/java/org/apache/aries/jpa/container/impl/ManagedEMF.java
----------------------------------------------------------------------
diff --git a/jpa-container/src/main/java/org/apache/aries/jpa/container/impl/ManagedEMF.java b/jpa-container/src/main/java/org/apache/aries/jpa/container/impl/ManagedEMF.java
index 04b8851..8e9bb54 100644
--- a/jpa-container/src/main/java/org/apache/aries/jpa/container/impl/ManagedEMF.java
+++ b/jpa-container/src/main/java/org/apache/aries/jpa/container/impl/ManagedEMF.java
@@ -46,7 +46,7 @@ import org.slf4j.LoggerFactory;
 /**
  * Creates an EntityManagerFactory(EMF) for a persistence unit and publishes it as a service.
  * Custom properties can be configured by supplying a config admin configuriation named like
- * the JPA_CONFIGURATION_PREFIX.<persistence unit name>.
+ * the JPA_CONFIGURATION_PREFIX.persistence unit name.
  */
 public class ManagedEMF implements Closeable, ManagedService {
     private static final Logger LOGGER = LoggerFactory.getLogger(ManagedEMF.class);

http://git-wip-us.apache.org/repos/asf/aries-jpa/blob/168b966d/jpa-container/src/main/java/org/apache/aries/jpa/container/parser/impl/JPAHandler.java
----------------------------------------------------------------------
diff --git a/jpa-container/src/main/java/org/apache/aries/jpa/container/parser/impl/JPAHandler.java b/jpa-container/src/main/java/org/apache/aries/jpa/container/parser/impl/JPAHandler.java
index 4ccd164..d2f0386 100644
--- a/jpa-container/src/main/java/org/apache/aries/jpa/container/parser/impl/JPAHandler.java
+++ b/jpa-container/src/main/java/org/apache/aries/jpa/container/parser/impl/JPAHandler.java
@@ -49,7 +49,7 @@ public class JPAHandler extends DefaultHandler {
     /**
      * Create a new JPA Handler for a bundle
      * 
-     * @param bundle
+     * @param bundle to parse
      */
     public JPAHandler(Bundle bundle) {
         this.bundle = bundle;

http://git-wip-us.apache.org/repos/asf/aries-jpa/blob/168b966d/jpa-container/src/main/java/org/apache/aries/jpa/container/parser/impl/PersistenceUnitParser.java
----------------------------------------------------------------------
diff --git a/jpa-container/src/main/java/org/apache/aries/jpa/container/parser/impl/PersistenceUnitParser.java b/jpa-container/src/main/java/org/apache/aries/jpa/container/parser/impl/PersistenceUnitParser.java
index 6c5cf73..8f26c48 100644
--- a/jpa-container/src/main/java/org/apache/aries/jpa/container/parser/impl/PersistenceUnitParser.java
+++ b/jpa-container/src/main/java/org/apache/aries/jpa/container/parser/impl/PersistenceUnitParser.java
@@ -53,11 +53,9 @@ public class PersistenceUnitParser {
      * "META-INF/persistence.xml" and the Meta-Persistence header. Note that getEntry is used to ensure we do
      * not alter the state of the bundle Note also that web application bundles will never return persistence
      * descriptors
-     * @param context 
      * 
      * @param bundle The bundle to search
-     * @param packageAdmin 
-     * @return
+     * @return persistence units located in the bundle
      */
     public static Collection<PersistenceUnit> getPersistenceUnits(Bundle bundle) {
         Collection<PersistenceUnit> punits = new ArrayList<PersistenceUnit>();
@@ -123,9 +121,8 @@ public class PersistenceUnitParser {
     /**
      * Locate a persistence descriptor file in a bundle based on a String name.
      * 
-     * @param bundle
-     * @param persistenceXmlFiles
-     * @param jarLocation
+     * @param bundle to look in
+     * @param location location in bundle
      * @throws IOException
      */
     private static InputStream locateFile(Bundle bundle, String location) throws IOException {

http://git-wip-us.apache.org/repos/asf/aries-jpa/blob/168b966d/jpa-container/src/main/java/org/apache/aries/jpa/container/weaving/impl/TransformerRegistry.java
----------------------------------------------------------------------
diff --git a/jpa-container/src/main/java/org/apache/aries/jpa/container/weaving/impl/TransformerRegistry.java b/jpa-container/src/main/java/org/apache/aries/jpa/container/weaving/impl/TransformerRegistry.java
index b499cc2..a3d1420 100644
--- a/jpa-container/src/main/java/org/apache/aries/jpa/container/weaving/impl/TransformerRegistry.java
+++ b/jpa-container/src/main/java/org/apache/aries/jpa/container/weaving/impl/TransformerRegistry.java
@@ -22,26 +22,21 @@ import javax.persistence.spi.ClassTransformer;
 
 import org.osgi.framework.Bundle;
 
-/**
- * {@link ClassTransformer} instances should be registered with the
- * instance of this interface returned by {@link TransformerRegistrySingleton#getTransformerRegistry()}
- */
 public interface TransformerRegistry {
 
   /**
    * Register a new transformer with the WeavingHook
    * 
-   * @param pBundle  The persistence bundle to weave
-   * @param transformer  The transformer to weave with
-   * @param provider The provider to provide packages from
+   * @param pBundle The persistence bundle to weave
+   * @param transformer The transformer to weave with
    */
   public void addTransformer(Bundle pBundle, ClassTransformer transformer);
   
   
   /**
    * Remove a given transformer from this weaving hook. This must be 
-   * @param pBundle
-   * @param transformer
+   * @param pBundle The persistence bundle to unweave
+   * @param transformer The transformer to remove
    */
   public void removeTransformer(Bundle pBundle, ClassTransformer transformer);
 }

http://git-wip-us.apache.org/repos/asf/aries-jpa/blob/168b966d/jpa-support/src/main/java/org/apache/aries/jpa/support/osgi/impl/EMFTracker.java
----------------------------------------------------------------------
diff --git a/jpa-support/src/main/java/org/apache/aries/jpa/support/osgi/impl/EMFTracker.java b/jpa-support/src/main/java/org/apache/aries/jpa/support/osgi/impl/EMFTracker.java
index 6e8826e..6884ba5 100644
--- a/jpa-support/src/main/java/org/apache/aries/jpa/support/osgi/impl/EMFTracker.java
+++ b/jpa-support/src/main/java/org/apache/aries/jpa/support/osgi/impl/EMFTracker.java
@@ -41,7 +41,7 @@ import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
 
 /**
- * Tracks EntityManagerFactory services and publishes a Supplier<EntityManager> for each.
+ * Tracks EntityManagerFactory services and publishes a Supplier&lt;EntityManager&gt; for each.
  * IF the persistence unit uses JTA a TMTracker is created. If it uses RESOURCE_LOCAL as 
  * ResourceLocalJpaTemplate is created.
  */
@@ -88,7 +88,7 @@ public class EMFTracker extends ServiceTracker {
 
     /**
      * 
-     * @param emf
+     * @param emf to get type from
      * @return
      */
     private PersistenceUnitTransactionType getTransactionType(EntityManagerFactory emf) {