stan/jdk-24
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

8077923: Add missing doclint in javax.management

Browse Source 
Reviewed-by: dfuchs
This commit is contained in:
Joe Darcy 2015-04-16 09:51:29 -07:00
parent 5b2c289414
commit 6fd1b64308
12 changed files with 57 additions and 37 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

11
jdk/src/java.management/share/classes/javax/management/AttributeValueExp.java
View File

@ -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 <CODE>ValueExp</CODE>.
*
* @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,

6
jdk/src/java.management/share/classes/javax/management/DescriptorKey.java
View File

@ -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();
}

8
jdk/src/java.management/share/classes/javax/management/DynamicMBean.java
View File

@ -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 <CODE>java.lang.Exception</CODE> thrown by the MBean's getter.
* @exception ReflectionException Wraps a <CODE>java.lang.Exception</CODE> 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 <CODE>java.lang.Exception</CODE> thrown by the MBean's setter.
* @exception ReflectionException Wraps a <CODE>java.lang.Exception</CODE> thrown while trying to invoke the MBean's setter.
*

6
jdk/src/java.management/share/classes/javax/management/ImmutableDescriptor.java
View File

@ -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 {
* <p>Construct a descriptor where the names and values of the fields
* are the keys and values of the given Map.</p>
*
* @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

13
jdk/src/java.management/share/classes/javax/management/QueryExp.java
View File

@ -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 ;

4
jdk/src/java.management/share/classes/javax/management/StandardEmitterMBean.java
View File

@ -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()}.</p>
*
* @param <T> 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()}.</p>
*
* @param <T> 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

11
jdk/src/java.management/share/classes/javax/management/StringValueExp.java
View File

@ -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 <CODE>ValueExp</CODE>.
*
* @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;

13
jdk/src/java.management/share/classes/javax/management/ValueExp.java
View File

@ -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 <CODE>ValueExp</CODE>.
*
* @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,

3
jdk/src/java.management/share/classes/javax/management/modelmbean/ModelMBeanInfo.java
View File

@ -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();

6
jdk/src/java.management/share/classes/javax/management/monitor/Monitor.java
View File

@ -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
* <P>
* Stops the monitor.
*
* @exception Exception
* @exception Exception if something goes wrong
*/
public void preDeregister() throws Exception {

7
jdk/src/java.management/share/classes/javax/management/openmbean/ArrayType.java
View File

@ -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<T> extends OpenType<T> {
* array type description = 3-dimension array of java.lang.String
* }</pre>
*
* @param <E> the Java type that described instances must have
* @param elementType the <i>open type</i> of element values contained
* in the arrays described by this <tt>ArrayType</tt>
* instance; must be an instance of either
@ -800,7 +801,7 @@ public class ArrayType<T> extends OpenType<T> {
* <tt>TabularType</tt> or another <tt>ArrayType</tt>
* with a <tt>SimpleType</tt>, <tt>CompositeType</tt>
* or <tt>TabularType</tt> as its <tt>elementType</tt>.
*
* @return an {@code ArrayType} instance
* @throws OpenDataException if <var>elementType's className</var> is not
* one of the allowed Java class names for open
* data.
@ -834,12 +835,14 @@ public class ArrayType<T> extends OpenType<T> {
* array type description = 3-dimension array of int
* }</pre>
*
* @param <T> 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 <var>arrayClass</var> is not
* a primitive array.

6
jdk/src/java.management/share/classes/javax/management/timer/Timer.java
View File

@ -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
* <P>
* Stops the timer.
*
* @exception java.lang.Exception
* @exception java.lang.Exception if something goes wrong
*/
public void preDeregister() throws java.lang.Exception {