Spring/spring-framework
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Add Javadoc to ManagedAttribute

Browse Source 
Closes: gh-24742
This commit is contained in:
Rossen Stoyanchev
2020-03-20 21:50:52 +00:00
parent 45a629e20a
commit 1f72ab4816
1 changed files with 18 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files

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

@@ -1,5 +1,5 @@
/*
* Copyright 2002-2015 the original author or authors.
* Copyright 2002-2020 the original author or authors.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
@@ -22,6 +22,8 @@ import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;
import javax.management.Descriptor;
/**
* Method-level annotation that indicates to expose a given bean property as a
* JMX attribute, corresponding to the {@code ManagedAttribute} attribute.
@@ -36,14 +38,29 @@ import java.lang.annotation.Target;
@Documented
public @interface ManagedAttribute {
/**
* Set the default value for the attribute in a JMX {@link Descriptor}.
*/
String defaultValue() default "";
/**
* Set the description for the attribute a JMX {@link Descriptor}.
*/
String description() default "";
/**
* Set the currency time limit field in a JMX {@link Descriptor}.
*/
int currencyTimeLimit() default -1;
/**
* Set the persistPolicy field in a JMX {@link Descriptor}.
*/
String persistPolicy() default "";
/**
* Set the persistPeriod field in a JMX {@link Descriptor}.
*/
int persistPeriod() default -1;
}