From 6fd1b643086b0bdb49ce4ee46486e3b4cc0d1425 Mon Sep 17 00:00:00 2001 From: Joe Darcy Date: Thu, 16 Apr 2015 09:51:29 -0700 Subject: [PATCH] 8077923: Add missing doclint in javax.management Reviewed-by: dfuchs --- .../classes/javax/management/AttributeValueExp.java | 11 +++++------ .../classes/javax/management/DescriptorKey.java | 6 +++++- .../classes/javax/management/DynamicMBean.java | 8 ++++---- .../javax/management/ImmutableDescriptor.java | 6 +++++- .../share/classes/javax/management/QueryExp.java | 13 ++++++++----- .../javax/management/StandardEmitterMBean.java | 4 +++- .../classes/javax/management/StringValueExp.java | 11 ++++++----- .../share/classes/javax/management/ValueExp.java | 13 ++++++++----- .../javax/management/modelmbean/ModelMBeanInfo.java | 3 ++- .../classes/javax/management/monitor/Monitor.java | 6 +++--- .../javax/management/openmbean/ArrayType.java | 7 +++++-- .../share/classes/javax/management/timer/Timer.java | 6 +++--- 12 files changed, 57 insertions(+), 37 deletions(-) diff --git a/jdk/src/java.management/share/classes/javax/management/AttributeValueExp.java b/jdk/src/java.management/share/classes/javax/management/AttributeValueExp.java index f2d6f7684db..66475a899bf 100644 --- a/jdk/src/java.management/share/classes/javax/management/AttributeValueExp.java +++ b/jdk/src/java.management/share/classes/javax/management/AttributeValueExp.java @@ -1,5 +1,5 @@ /* - * Copyright (c) 1999, 2008, Oracle and/or its affiliates. All rights reserved. + * Copyright (c) 1999, 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 @@ -93,11 +93,10 @@ public class AttributeValueExp implements ValueExp { * * @return The ValueExp. * - * @exception BadAttributeValueExpException - * @exception InvalidApplicationException - * @exception BadStringOperationException - * @exception BadBinaryOpValueExpException - * + * @throws BadStringOperationException {@inheritDoc} + * @throws BadBinaryOpValueExpException {@inheritDoc} + * @throws BadAttributeValueExpException {@inheritDoc} + * @throws InvalidApplicationException {@inheritDoc} */ @Override public ValueExp apply(ObjectName name) throws BadStringOperationException, BadBinaryOpValueExpException, diff --git a/jdk/src/java.management/share/classes/javax/management/DescriptorKey.java b/jdk/src/java.management/share/classes/javax/management/DescriptorKey.java index c9bd8b2963c..814e234d35c 100644 --- a/jdk/src/java.management/share/classes/javax/management/DescriptorKey.java +++ b/jdk/src/java.management/share/classes/javax/management/DescriptorKey.java @@ -1,5 +1,5 @@ /* - * Copyright (c) 2005, 2013, Oracle and/or its affiliates. All rights reserved. + * Copyright (c) 2005, 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 @@ -168,5 +168,9 @@ import java.lang.annotation.*; @Retention(RetentionPolicy.RUNTIME) @Target(ElementType.METHOD) public @interface DescriptorKey { + /** + * Returns the descriptor key. + * @return the descriptor key + */ String value(); } diff --git a/jdk/src/java.management/share/classes/javax/management/DynamicMBean.java b/jdk/src/java.management/share/classes/javax/management/DynamicMBean.java index 80e3007e7fd..129fb99a3f5 100644 --- a/jdk/src/java.management/share/classes/javax/management/DynamicMBean.java +++ b/jdk/src/java.management/share/classes/javax/management/DynamicMBean.java @@ -1,5 +1,5 @@ /* - * Copyright (c) 1999, 2003, Oracle and/or its affiliates. All rights reserved. + * Copyright (c) 1999, 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 @@ -43,7 +43,7 @@ public interface DynamicMBean { * * @return The value of the attribute retrieved. * - * @exception AttributeNotFoundException + * @exception AttributeNotFoundException if specified attribute does not exist or cannot be retrieved * @exception MBeanException Wraps a java.lang.Exception thrown by the MBean's getter. * @exception ReflectionException Wraps a java.lang.Exception thrown while trying to invoke the getter. * @@ -58,8 +58,8 @@ public interface DynamicMBean { * @param attribute The identification of the attribute to * be set and the value it is to be set to. * - * @exception AttributeNotFoundException - * @exception InvalidAttributeValueException + * @exception AttributeNotFoundException if specified attribute does not exist or cannot be retrieved + * @exception InvalidAttributeValueException if value specified is not valid for the attribute * @exception MBeanException Wraps a java.lang.Exception thrown by the MBean's setter. * @exception ReflectionException Wraps a java.lang.Exception thrown while trying to invoke the MBean's setter. * diff --git a/jdk/src/java.management/share/classes/javax/management/ImmutableDescriptor.java b/jdk/src/java.management/share/classes/javax/management/ImmutableDescriptor.java index 60e75fab315..eb0a02d41dd 100644 --- a/jdk/src/java.management/share/classes/javax/management/ImmutableDescriptor.java +++ b/jdk/src/java.management/share/classes/javax/management/ImmutableDescriptor.java @@ -1,5 +1,5 @@ /* - * Copyright (c) 2004, 2013, Oracle and/or its affiliates. All rights reserved. + * Copyright (c) 2004, 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 @@ -65,6 +65,8 @@ public class ImmutableDescriptor implements Descriptor { /** * Construct a descriptor containing the given fields and values. * + * @param fieldNames the field names + * @param fieldValues the field values * @throws IllegalArgumentException if either array is null, or * if the arrays have different sizes, or * if a field name is null or empty, or if the same field name @@ -81,6 +83,7 @@ public class ImmutableDescriptor implements Descriptor { * is {@code a=b=c} then the field name is {@code a} and its value * is {@code b=c}. * + * @param fields the field names * @throws IllegalArgumentException if the parameter is null, or * if a field name is empty, or if the same field name appears * more than once, or if one of the strings does not contain @@ -94,6 +97,7 @@ public class ImmutableDescriptor implements Descriptor { *

Construct a descriptor where the names and values of the fields * are the keys and values of the given Map.

* + * @param fields the field names and values * @throws IllegalArgumentException if the parameter is null, or * if a field name is null or empty, or if the same field name appears * more than once (which can happen because field names are not case diff --git a/jdk/src/java.management/share/classes/javax/management/QueryExp.java b/jdk/src/java.management/share/classes/javax/management/QueryExp.java index e4f76577a6f..819855ee5e4 100644 --- a/jdk/src/java.management/share/classes/javax/management/QueryExp.java +++ b/jdk/src/java.management/share/classes/javax/management/QueryExp.java @@ -1,5 +1,5 @@ /* - * Copyright (c) 1999, 2008, Oracle and/or its affiliates. All rights reserved. + * Copyright (c) 1999, 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 @@ -53,10 +53,13 @@ public interface QueryExp extends Serializable { * * @return True if the query was successfully applied to the MBean, false otherwise * - * @exception BadStringOperationException - * @exception BadBinaryOpValueExpException - * @exception BadAttributeValueExpException - * @exception InvalidApplicationException + * @throws BadStringOperationException when an invalid string + * operation is passed to a method for constructing a query + * @throws BadBinaryOpValueExpException when an invalid expression + * is passed to a method for constructing a query + * @throws BadAttributeValueExpException when an invalid MBean + * attribute is passed to a query constructing method + * @throws InvalidApplicationException when an invalid apply is attempted */ public boolean apply(ObjectName name) throws BadStringOperationException, BadBinaryOpValueExpException, BadAttributeValueExpException, InvalidApplicationException ; diff --git a/jdk/src/java.management/share/classes/javax/management/StandardEmitterMBean.java b/jdk/src/java.management/share/classes/javax/management/StandardEmitterMBean.java index 250d109679a..c4ead04d5f4 100644 --- a/jdk/src/java.management/share/classes/javax/management/StandardEmitterMBean.java +++ b/jdk/src/java.management/share/classes/javax/management/StandardEmitterMBean.java @@ -1,5 +1,5 @@ /* - * Copyright (c) 2005, 2013, Oracle and/or its affiliates. All rights reserved. + * Copyright (c) 2005, 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 @@ -91,6 +91,7 @@ public class StandardEmitterMBean extends StandardMBean * that will have no effect on this object's * {@code getNotificationInfo()}.

* + * @param the implementation type of the MBean * @param implementation the implementation of the MBean interface. * @param mbeanInterface a Standard MBean interface. * @param emitter the object that will handle notifications. @@ -129,6 +130,7 @@ public class StandardEmitterMBean extends StandardMBean * that will have no effect on this object's * {@code getNotificationInfo()}.

* + * @param the implementation type of the MBean * @param implementation the implementation of the MBean interface. * @param mbeanInterface a Standard MBean interface. * @param isMXBean If true, the {@code mbeanInterface} parameter diff --git a/jdk/src/java.management/share/classes/javax/management/StringValueExp.java b/jdk/src/java.management/share/classes/javax/management/StringValueExp.java index 629117fb228..ed9b3c3539e 100644 --- a/jdk/src/java.management/share/classes/javax/management/StringValueExp.java +++ b/jdk/src/java.management/share/classes/javax/management/StringValueExp.java @@ -1,5 +1,5 @@ /* - * Copyright (c) 1999, 2008, Oracle and/or its affiliates. All rights reserved. + * Copyright (c) 1999, 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 @@ -95,11 +95,12 @@ public class StringValueExp implements ValueExp { * * @return The ValueExp. * - * @exception BadStringOperationException - * @exception BadBinaryOpValueExpException - * @exception BadAttributeValueExpException - * @exception InvalidApplicationException + * @throws BadStringOperationException {@inheritDoc} + * @throws BadBinaryOpValueExpException {@inheritDoc} + * @throws BadAttributeValueExpException {@inheritDoc} + * @throws InvalidApplicationException {@inheritDoc} */ + @Override public ValueExp apply(ObjectName name) throws BadStringOperationException, BadBinaryOpValueExpException, BadAttributeValueExpException, InvalidApplicationException { return this; diff --git a/jdk/src/java.management/share/classes/javax/management/ValueExp.java b/jdk/src/java.management/share/classes/javax/management/ValueExp.java index 7a0619122de..1afe1b6a44f 100644 --- a/jdk/src/java.management/share/classes/javax/management/ValueExp.java +++ b/jdk/src/java.management/share/classes/javax/management/ValueExp.java @@ -1,5 +1,5 @@ /* - * Copyright (c) 1999, 2004, Oracle and/or its affiliates. All rights reserved. + * Copyright (c) 1999, 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 @@ -80,10 +80,13 @@ public interface ValueExp extends java.io.Serializable { * * @return The ValueExp. * - * @exception BadStringOperationException - * @exception BadBinaryOpValueExpException - * @exception BadAttributeValueExpException - * @exception InvalidApplicationException + * @throws BadStringOperationException when an invalid string + * operation is passed to a method for constructing a query + * @throws BadBinaryOpValueExpException when an invalid expression + * is passed to a method for constructing a query + * @throws BadAttributeValueExpException when an invalid MBean + * attribute is passed to a query constructing method + * @throws InvalidApplicationException when an invalid apply is attempted */ public ValueExp apply(ObjectName name) throws BadStringOperationException, BadBinaryOpValueExpException, diff --git a/jdk/src/java.management/share/classes/javax/management/modelmbean/ModelMBeanInfo.java b/jdk/src/java.management/share/classes/javax/management/modelmbean/ModelMBeanInfo.java index 8894ae882f7..642cddd3d27 100644 --- a/jdk/src/java.management/share/classes/javax/management/modelmbean/ModelMBeanInfo.java +++ b/jdk/src/java.management/share/classes/javax/management/modelmbean/ModelMBeanInfo.java @@ -1,5 +1,5 @@ /* - * Copyright (c) 2000, 2013, Oracle and/or its affiliates. All rights reserved. + * Copyright (c) 2000, 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 @@ -307,6 +307,7 @@ public interface ModelMBeanInfo /** * Creates and returns a copy of this object. + * @return a copy of this object */ public java.lang.Object clone(); diff --git a/jdk/src/java.management/share/classes/javax/management/monitor/Monitor.java b/jdk/src/java.management/share/classes/javax/management/monitor/Monitor.java index 5389a66bcb5..6276fb33b50 100644 --- a/jdk/src/java.management/share/classes/javax/management/monitor/Monitor.java +++ b/jdk/src/java.management/share/classes/javax/management/monitor/Monitor.java @@ -1,5 +1,5 @@ /* - * Copyright (c) 1999, 2013, Oracle and/or its affiliates. All rights reserved. + * Copyright (c) 1999, 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 @@ -387,7 +387,7 @@ public abstract class Monitor * * @return The name of the monitor MBean registered. * - * @exception Exception + * @exception Exception if something goes wrong */ public ObjectName preRegister(MBeanServer server, ObjectName name) throws Exception { @@ -416,7 +416,7 @@ public abstract class Monitor *

* Stops the monitor. * - * @exception Exception + * @exception Exception if something goes wrong */ public void preDeregister() throws Exception { diff --git a/jdk/src/java.management/share/classes/javax/management/openmbean/ArrayType.java b/jdk/src/java.management/share/classes/javax/management/openmbean/ArrayType.java index 2d12347044a..53665e8f2f9 100644 --- a/jdk/src/java.management/share/classes/javax/management/openmbean/ArrayType.java +++ b/jdk/src/java.management/share/classes/javax/management/openmbean/ArrayType.java @@ -1,5 +1,5 @@ /* - * Copyright (c) 2000, 2013, Oracle and/or its affiliates. All rights reserved. + * Copyright (c) 2000, 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 @@ -793,6 +793,7 @@ public class ArrayType extends OpenType { * array type description = 3-dimension array of java.lang.String * } * + * @param the Java type that described instances must have * @param elementType the open type of element values contained * in the arrays described by this ArrayType * instance; must be an instance of either @@ -800,7 +801,7 @@ public class ArrayType extends OpenType { * TabularType or another ArrayType * with a SimpleType, CompositeType * or TabularType as its elementType. - * + * @return an {@code ArrayType} instance * @throws OpenDataException if elementType's className is not * one of the allowed Java class names for open * data. @@ -834,12 +835,14 @@ public class ArrayType extends OpenType { * array type description = 3-dimension array of int * } * + * @param the Java type that described instances must have * @param arrayClass a primitive array class such as {@code int[].class}, * {@code boolean[][].class}, etc. The {@link * #getElementOpenType()} method of the returned * {@code ArrayType} returns the {@link SimpleType} * corresponding to the wrapper type of the primitive * type of the array. + * @return an {@code ArrayType} instance * * @throws IllegalArgumentException if arrayClass is not * a primitive array. diff --git a/jdk/src/java.management/share/classes/javax/management/timer/Timer.java b/jdk/src/java.management/share/classes/javax/management/timer/Timer.java index 461b68e0dbd..b199e8e258a 100644 --- a/jdk/src/java.management/share/classes/javax/management/timer/Timer.java +++ b/jdk/src/java.management/share/classes/javax/management/timer/Timer.java @@ -1,5 +1,5 @@ /* - * Copyright (c) 1999, 2012, Oracle and/or its affiliates. All rights reserved. + * Copyright (c) 1999, 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 @@ -195,7 +195,7 @@ public class Timer extends NotificationBroadcasterSupport * * @return The name of the timer MBean registered. * - * @exception java.lang.Exception + * @exception java.lang.Exception if something goes wrong */ public ObjectName preRegister(MBeanServer server, ObjectName name) throws java.lang.Exception { @@ -217,7 +217,7 @@ public class Timer extends NotificationBroadcasterSupport *

* Stops the timer. * - * @exception java.lang.Exception + * @exception java.lang.Exception if something goes wrong */ public void preDeregister() throws java.lang.Exception {