JDK 9 RFR of adding missing javadoc to javax.transaction

[Lance Andersen]

Hi Joe,

This Looks OK.  I have already had discussions with the Java EE leads about adding the SUID and pushing the changes back upstream (and updating other classes in upstream javax.transaction as needed.
   
 I will be doing that soon and will push these changes as well.

Best,
Lance
On Apr 16, 2015, at 2:08 PM, joe darcy <joe.darcy at oracle.com> wrote:

> Hello,
> 
> While preparing to turn on doclint build warnings on more modules, I noticed there are missing javadoc comments on various classes in javax.transaction.
> 
> Please review the patch below which add in some obvious javadoc.
> 
> Thanks,
> 
> -Joe
> 
> diff -r 488af0e8ee33 src/java.transaction/share/classes/javax/transaction/InvalidTransactionException.java
> --- a/src/java.transaction/share/classes/javax/transaction/InvalidTransactionException.java Thu Apr 16 10:44:23 2015 -0700
> +++ b/src/java.transaction/share/classes/javax/transaction/InvalidTransactionException.java Thu Apr 16 11:07:12 2015 -0700
> @@ -1,5 +1,5 @@
> /*
> - * Copyright (c) 1998, 1999, Oracle and/or its affiliates. All rights reserved.
> + * Copyright (c) 1998, 2015, Oracle and/or its affiliates. All rights reserved.
>  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
>  *
>  * This code is free software; you can redistribute it and/or modify it
> @@ -39,10 +39,17 @@
> @SuppressWarnings("serial")             // serialVersionUID intentionally omitted
> public class InvalidTransactionException extends java.rmi.RemoteException {
> 
> +    /**
> +     * Constructs an {@code InvalidTransactionException}.
> +     */
>     public InvalidTransactionException() {
>         super();
>     }
> 
> +    /**
> +     * Constructs an {@code InvalidTransactionException}.
> +     * @param msg the detail message
> +     */
>     public InvalidTransactionException(String msg) {
>         super(msg);
>     }
> diff -r 488af0e8ee33 src/java.transaction/share/classes/javax/transaction/TransactionRequiredException.java
> --- a/src/java.transaction/share/classes/javax/transaction/TransactionRequiredException.java Thu Apr 16 10:44:23 2015 -0700
> +++ b/src/java.transaction/share/classes/javax/transaction/TransactionRequiredException.java Thu Apr 16 11:07:12 2015 -0700
> @@ -1,5 +1,5 @@
> /*
> - * Copyright (c) 1998, 1999, Oracle and/or its affiliates. All rights reserved.
> + * Copyright (c) 1998, 2015, Oracle and/or its affiliates. All rights reserved.
>  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
>  *
>  * This code is free software; you can redistribute it and/or modify it
> @@ -38,10 +38,17 @@
> @SuppressWarnings("serial")             // serialVersionUID intentionally omitted
> public class TransactionRequiredException extends java.rmi.RemoteException {
> 
> +    /**
> +     * Constructs a {@code TransactionRequiredException}.
> +     */
>     public TransactionRequiredException() {
>         super();
>     }
> 
> +    /**
> +     * Constructs a {@code TransactionRequiredException}.
> +     * @param msg the detail message
> +     */
>     public TransactionRequiredException(String msg) {
>         super(msg);
>     }
> diff -r 488af0e8ee33 src/java.transaction/share/classes/javax/transaction/TransactionRolledbackException.java
> --- a/src/java.transaction/share/classes/javax/transaction/TransactionRolledbackException.java Thu Apr 16 10:44:23 2015 -0700
> +++ b/src/java.transaction/share/classes/javax/transaction/TransactionRolledbackException.java Thu Apr 16 11:07:12 2015 -0700
> @@ -1,5 +1,5 @@
> /*
> - * Copyright (c) 1998, 1999, Oracle and/or its affiliates. All rights reserved.
> + * Copyright (c) 1998, 2015, Oracle and/or its affiliates. All rights reserved.
>  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
>  *
>  * This code is free software; you can redistribute it and/or modify it
> @@ -41,10 +41,17 @@
> @SuppressWarnings("serial")             // serialVersionUID intentionally omitted
> public class TransactionRolledbackException extends java.rmi.RemoteException {
> 
> +    /**
> +     * Constructs a {@code TransactionRolledbackException}.
> +     */
>     public TransactionRolledbackException() {
>         super();
>     }
> 
> +    /**
> +     * Constructs a {@code TransactionRolledbackException}.
> +     * @param msg the detail message
> +     */
>     public TransactionRolledbackException(String msg) {
>         super(msg);
>     }



Lance Andersen| Principal Member of Technical Staff | +1.781.442.2037
Oracle Java Engineering 
1 Network Drive 
Burlington, MA 01803
Lance.Andersen at oracle.com