Skip to content

Commit 1f72ab4

Browse files
committed
Add Javadoc to ManagedAttribute
Closes: gh-24742
1 parent 45a629e commit 1f72ab4

File tree

1 file changed

+18
-1
lines changed

1 file changed

+18
-1
lines changed

spring-context/src/main/java/org/springframework/jmx/export/annotation/ManagedAttribute.java

Lines changed: 18 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
/*
2-
* Copyright 2002-2015 the original author or authors.
2+
* Copyright 2002-2020 the original author or authors.
33
*
44
* Licensed under the Apache License, Version 2.0 (the "License");
55
* you may not use this file except in compliance with the License.
@@ -22,6 +22,8 @@
2222
import java.lang.annotation.RetentionPolicy;
2323
import java.lang.annotation.Target;
2424

25+
import javax.management.Descriptor;
26+
2527
/**
2628
* Method-level annotation that indicates to expose a given bean property as a
2729
* JMX attribute, corresponding to the {@code ManagedAttribute} attribute.
@@ -36,14 +38,29 @@
3638
@Documented
3739
public @interface ManagedAttribute {
3840

41+
/**
42+
* Set the default value for the attribute in a JMX {@link Descriptor}.
43+
*/
3944
String defaultValue() default "";
4045

46+
/**
47+
* Set the description for the attribute a JMX {@link Descriptor}.
48+
*/
4149
String description() default "";
4250

51+
/**
52+
* Set the currency time limit field in a JMX {@link Descriptor}.
53+
*/
4354
int currencyTimeLimit() default -1;
4455

56+
/**
57+
* Set the persistPolicy field in a JMX {@link Descriptor}.
58+
*/
4559
String persistPolicy() default "";
4660

61+
/**
62+
* Set the persistPeriod field in a JMX {@link Descriptor}.
63+
*/
4764
int persistPeriod() default -1;
4865

4966
}

0 commit comments

Comments
 (0)