Polish Javadoc

Author: philwebb

spring-boot-actuator/src/main/java/org/springframework/boot/actuate/audit/AuditEvent.java

@@ -61,7 +61,7 @@ public AuditEvent(String principal, String type, Map<String, Object> data) {
 
 	/**
 	 * Create a new audit event for the current time from data provided as name-value
-	 * pairs
+	 * pairs.
 	 * @param principal The user principal responsible
 	 * @param type the event type
 	 * @param data The event data in the form 'key=value' or simply 'key'

spring-boot-actuator/src/main/java/org/springframework/boot/actuate/audit/InMemoryAuditEventRepository.java

@@ -46,7 +46,8 @@ public InMemoryAuditEventRepository(int capacity) {
 	}
 
 	/**
-	 * @param capacity the capacity to set
+	 * Set the capacity of this event repository.
+	 * @param capacity the capacity
 	 */
 	public synchronized void setCapacity(int capacity) {
 		this.events = new AuditEvent[capacity];

spring-boot-actuator/src/main/java/org/springframework/boot/actuate/audit/listener/AuditApplicationEvent.java

@@ -82,6 +82,7 @@ public AuditApplicationEvent(AuditEvent auditEvent) {
 	}
 
 	/**
+	 * Get the audit event.
 	 * @return the audit event
 	 */
 	public AuditEvent getAuditEvent() {

spring-boot-actuator/src/main/java/org/springframework/boot/actuate/autoconfigure/HealthIndicatorAutoConfigurationProperties.java

@@ -21,7 +21,7 @@
 import org.springframework.boot.context.properties.ConfigurationProperties;
 
 /**
- * Configuration properties for some health properties
+ * Configuration properties for some health properties.
  *
  * @author Christian Dupuis
  * @since 1.2.0

spring-boot-actuator/src/main/java/org/springframework/boot/actuate/autoconfigure/ManagementContextResolver.java

@@ -52,7 +52,7 @@ public MvcEndpoints getMvcEndpoints() {
 	}
 
 	/**
-	 * Return the management {@link ApplicationContext}
+	 * Return the management {@link ApplicationContext}.
 	 * @return the management {@link ApplicationContext}
 	 */
 	public ApplicationContext getApplicationContext() {

spring-boot-actuator/src/main/java/org/springframework/boot/actuate/autoconfigure/ManagementWebSecurityAutoConfiguration.java

@@ -185,7 +185,7 @@ protected static class WebSecurityEnabler extends AuthenticationManagerConfigura
 	}
 
 	/**
-	 * WebSecurityEnabler condition
+	 * WebSecurityEnabler condition.
 	 */
 	static class WebSecurityEnablerCondition extends SpringBootCondition {
 

spring-boot-actuator/src/main/java/org/springframework/boot/actuate/autoconfigure/ShellProperties.java

@@ -221,7 +221,7 @@ public static abstract class CrshShellAuthenticationProperties extends
 	}
 
 	/**
-	 * SSH properties
+	 * SSH properties.
 	 */
 	public static class Ssh extends CrshShellProperties {
 
@@ -279,7 +279,7 @@ public Integer getPort() {
 	}
 
 	/**
-	 * Telnet properties
+	 * Telnet properties.
 	 */
 	public static class Telnet extends CrshShellProperties {
 
@@ -322,7 +322,7 @@ public Integer getPort() {
 	}
 
 	/**
-	 * Auth specific properties for JAAS authentication
+	 * Auth specific properties for JAAS authentication.
 	 */
 	@ConfigurationProperties(prefix = "shell.auth.jaas", ignoreUnknownFields = false)
 	public static class JaasAuthenticationProperties extends
@@ -351,7 +351,7 @@ public String getDomain() {
 	}
 
 	/**
-	 * Auth specific properties for key authentication
+	 * Auth specific properties for key authentication.
 	 */
 	@ConfigurationProperties(prefix = "shell.auth.key", ignoreUnknownFields = false)
 	public static class KeyAuthenticationProperties extends
@@ -382,7 +382,7 @@ public String getPath() {
 	}
 
 	/**
-	 * Auth specific properties for simple authentication
+	 * Auth specific properties for simple authentication.
 	 */
 	@ConfigurationProperties(prefix = "shell.auth.simple", ignoreUnknownFields = false)
 	public static class SimpleAuthenticationProperties extends
@@ -457,7 +457,7 @@ public void setPassword(String password) {
 	}
 
 	/**
-	 * Auth specific properties for Spring authentication
+	 * Auth specific properties for Spring authentication.
 	 */
 	@ConfigurationProperties(prefix = "shell.auth.spring", ignoreUnknownFields = false)
 	public static class SpringAuthenticationProperties extends

spring-boot-actuator/src/main/java/org/springframework/boot/actuate/cache/AbstractJmxCacheStatisticsProvider.java

@@ -37,9 +37,9 @@
  * Base {@link CacheStatisticsProvider} implementation that uses JMX to retrieve the cache
  * statistics.
  *
+ * @param <C> The cache type
  * @author Stephane Nicoll
  * @since 1.3.0
- * @param <C> The cache type
  */
 public abstract class AbstractJmxCacheStatisticsProvider<C extends Cache> implements
 		CacheStatisticsProvider<C> {

spring-boot-actuator/src/main/java/org/springframework/boot/actuate/endpoint/ConfigurationPropertiesReportEndpoint.java

@@ -144,6 +144,10 @@ private Map<String, Object> getConfigurationPropertiesBeans(
 	/**
 	 * Cautiously serialize the bean to a map (returning a map with an error message
 	 * instead of throwing an exception if there is a problem).
+	 * @param mapper the object mapper
+	 * @param bean the source bean
+	 * @param prefix the prefix
+	 * @return the serialized instance
 	 */
 	private Map<String, Object> safeSerialize(ObjectMapper mapper, Object bean,
 			String prefix) {
@@ -173,6 +177,7 @@ protected void configureObjectMapper(ObjectMapper mapper) {
 
 	/**
 	 * Ensure only bindable and non-cyclic bean properties are reported.
+	 * @param mapper the object mapper
 	 */
 	private void applySerializationModifier(ObjectMapper mapper) {
 		SerializerFactory factory = BeanSerializerFactory.instance
@@ -183,6 +188,7 @@ private void applySerializationModifier(ObjectMapper mapper) {
 	/**
 	 * Configure PropertyFilter to make sure Jackson doesn't process CGLIB generated bean
 	 * properties.
+	 * @param mapper the object mapper
 	 */
 	private void applyCglibFilters(ObjectMapper mapper) {
 		mapper.setAnnotationIntrospector(new CglibAnnotationIntrospector());
@@ -192,7 +198,11 @@ private void applyCglibFilters(ObjectMapper mapper) {
 
 	/**
 	 * Extract configuration prefix from {@link ConfigurationProperties} annotation.
-	 * @param beanFactoryMetaData
+	 * @param context the application context
+	 * @param beanFactoryMetaData the bean factory meta-data
+	 * @param beanName the bean name
+	 * @param bean the bean
+	 * @return the prefix
 	 */
 	private String extractPrefix(ApplicationContext context,
 			ConfigurationBeanFactoryMetaData beanFactoryMetaData, String beanName,
@@ -216,6 +226,8 @@ private String extractPrefix(ApplicationContext context,
 	/**
 	 * Sanitize all unwanted configuration properties to avoid leaking of sensitive
 	 * information.
+	 * @param map the source map
+	 * @return the sanitized map
 	 */
 	@SuppressWarnings("unchecked")
 	private Map<String, Object> sanitize(Map<String, Object> map) {

spring-boot-actuator/src/main/java/org/springframework/boot/actuate/endpoint/DataSourcePublicMetrics.java

@@ -113,6 +113,7 @@ protected String createPrefix(String name, DataSource dataSource, boolean primar
 	 * Attempt to locate the primary {@link DataSource} (i.e. either the only data source
 	 * available or the one amongst the candidates marked as {@link Primary}. Return
 	 * {@code null} if there no primary data source could be found.
+	 * @return the primary datasource
 	 */
 	private DataSource getPrimaryDataSource() {
 		try {

spring-boot-actuator/src/main/java/org/springframework/boot/actuate/endpoint/FlywayEndpoint.java

@@ -55,6 +55,9 @@ public List<FlywayMigration> invoke() {
 		return migrations;
 	}
 
+	/**
+	 * Migration properties.
+	 */
 	public static class FlywayMigration {
 
 		private MigrationType type;

spring-boot-actuator/src/main/java/org/springframework/boot/actuate/endpoint/HealthEndpoint.java

@@ -83,6 +83,8 @@ public Health invoke() {
 
 	/**
 	 * Turns the bean name into a key that can be used in the map of health information.
+	 * @param name the bean name
+	 * @return the key
 	 */
 	private String getKey(String name) {
 		int index = name.toLowerCase().indexOf("healthindicator");

spring-boot-actuator/src/main/java/org/springframework/boot/actuate/endpoint/PublicMetrics.java

@@ -29,7 +29,8 @@
 public interface PublicMetrics {
 
 	/**
-	 * @return an indication of current state through metrics
+	 * Return an indication of current state through metrics.
+	 * @return the public metrics
 	 */
 	Collection<Metric<?>> metrics();
 

spring-boot-actuator/src/main/java/org/springframework/boot/actuate/endpoint/RequestMappingEndpoint.java

@@ -58,14 +58,16 @@ public void setApplicationContext(ApplicationContext applicationContext)
 	}
 
 	/**
-	 * @param handlerMappings the mappings to set
+	 * Set the handler mappings.
+	 * @param handlerMappings the handler mappings
 	 */
 	public void setHandlerMappings(List<AbstractUrlHandlerMapping> handlerMappings) {
 		this.handlerMappings = handlerMappings;
 	}
 
 	/**
-	 * @param methodMappings the method mappings to set
+	 * Set the method mappings.
+	 * @param methodMappings the method mappings
 	 */
 	public void setMethodMappings(List<AbstractHandlerMethodMapping<?>> methodMappings) {
 		this.methodMappings = methodMappings;

spring-boot-actuator/src/main/java/org/springframework/boot/actuate/endpoint/SystemPublicMetrics.java

@@ -76,6 +76,7 @@ protected void addBasicMetrics(Collection<Metric<?>> result) {
 	/**
 	 * Add metrics from ManagementFactory if possible. Note that ManagementFactory is not
 	 * available on Google App Engine.
+	 * @param result the result
 	 */
 	private void addManagementMetrics(Collection<Metric<?>> result) {
 		try {
@@ -153,6 +154,8 @@ protected void addGarbageCollectionMetrics(Collection<Metric<?>> result) {
 	/**
 	 * Turn GC names like 'PS Scavenge' or 'PS MarkSweep' into something that is more
 	 * metrics friendly.
+	 * @param name the source name
+	 * @return a metric friendly name
 	 */
 	private String beautifyGcName(String name) {
 		return StringUtils.replace(name, " ", "_").toLowerCase();

spring-boot-actuator/src/main/java/org/springframework/boot/actuate/endpoint/jmx/EndpointMBeanExporter.java

@@ -61,6 +61,9 @@
 public class EndpointMBeanExporter extends MBeanExporter implements SmartLifecycle,
 		ApplicationContextAware {
 
+	/**
+	 * The default JMX domain.
+	 */
 	public static final String DEFAULT_DOMAIN = "org.springframework.boot";
 
 	private static Log logger = LogFactory.getLog(EndpointMBeanExporter.class);

spring-boot-actuator/src/main/java/org/springframework/boot/actuate/endpoint/mvc/ActuatorHalBrowserEndpoint.java

@@ -32,6 +32,14 @@
 import org.springframework.web.servlet.resource.ResourceTransformerChain;
 import org.springframework.web.servlet.resource.TransformedResource;
 
+/**
+ * {@link MvcEndpoint} to expose a HAL browser.
+ *
+ * @author Dave Syer
+ * @author Phillip Webb
+ * @author Andy Wilkinson
+ * @since 1.3.0
+ */
 public class ActuatorHalBrowserEndpoint extends ActuatorHalJsonEndpoint implements
 		ResourceLoaderAware {
 
@@ -93,6 +101,9 @@ public static HalBrowserLocation getHalBrowserLocation(ResourceLoader resourceLo
 		return null;
 	}
 
+	/**
+	 * HAL Browser properties.
+	 */
 	public static class HalBrowserLocation {
 
 		private final String resourceLocation;

spring-boot-actuator/src/main/java/org/springframework/boot/actuate/endpoint/mvc/ActuatorHalJsonEndpoint.java

@@ -29,12 +29,12 @@
 import org.springframework.web.servlet.config.annotation.WebMvcConfigurerAdapter;
 
 /**
- * {@link MvcEndpoint} for the actuator. Uses content negotiation to provide access to the
- * HAL browser (when on the classpath), and to HAL-formatted JSON.
+ * {@link MvcEndpoint} to expose HAL-formatted JSON.
  *
  * @author Dave Syer
- * @author Phil Webb
+ * @author Phillip Webb
  * @author Andy Wilkinson
+ * @since 1.3.0
  */
 @ConfigurationProperties("endpoints.actuator")
 public class ActuatorHalJsonEndpoint extends WebMvcConfigurerAdapter implements

spring-boot-actuator/src/main/java/org/springframework/boot/actuate/endpoint/mvc/EndpointHandlerMapping.java

@@ -97,7 +97,7 @@ public void afterPropertiesSet() {
 
 	/**
 	 * Since all handler beans are passed into the constructor there is no need to detect
-	 * anything here
+	 * anything here.
 	 */
 	@Override
 	protected boolean isHandler(Class<?> beanType) {
@@ -149,7 +149,8 @@ private RequestMappingInfo withNewPatterns(RequestMappingInfo mapping,
 	}
 
 	/**
-	 * @param prefix the prefix to set
+	 * Set the prefix used in mappings.
+	 * @param prefix the prefix
 	 */
 	public void setPrefix(String prefix) {
 		Assert.isTrue("".equals(prefix) || StringUtils.startsWithIgnoreCase(prefix, "/"),
@@ -158,13 +159,15 @@ public void setPrefix(String prefix) {
 	}
 
 	/**
-	 * @return the prefix used in mappings
+	 * Get the prefix used in mappings.
+	 * @return the prefix
 	 */
 	public String getPrefix() {
 		return this.prefix;
 	}
 
 	/**
+	 * Get the path of the endpoint.
 	 * @param endpoint the endpoint
 	 * @return the path used in mappings
 	 */
@@ -189,7 +192,7 @@ public boolean isDisabled() {
 	}
 
 	/**
-	 * Return the endpoints
+	 * Return the endpoints.
 	 * @return the endpoints
 	 */
 	public Set<? extends MvcEndpoint> getEndpoints() {

spring-boot-actuator/src/main/java/org/springframework/boot/actuate/endpoint/mvc/EndpointHandlerMappingCustomizer.java

@@ -25,7 +25,7 @@
 public interface EndpointHandlerMappingCustomizer {
 
 	/**
-	 * Customize the specified {@link EndpointHandlerMapping}
+	 * Customize the specified {@link EndpointHandlerMapping}.
 	 * @param mapping the {@link EndpointHandlerMapping} to customize
 	 */
 	void customize(EndpointHandlerMapping mapping);

spring-boot-actuator/src/main/java/org/springframework/boot/actuate/endpoint/mvc/EndpointMvcAdapter.java

@@ -74,10 +74,9 @@ public Class<? extends Endpoint> getEndpointType() {
 
 	/**
 	 * Returns the response that should be returned when the endpoint is disabled.
-	 *
-	 * @see Endpoint#isEnabled()
-	 * @since 1.2.4
 	 * @return The response to be returned when the endpoint is disabled
+	 * @since 1.2.4
+	 * @see Endpoint#isEnabled()
 	 */
 	protected ResponseEntity<?> getDisabledResponse() {
 		return MvcEndpoint.DISABLED_RESPONSE;

spring-boot-actuator/src/main/java/org/springframework/boot/actuate/endpoint/mvc/MvcEndpoint.java

@@ -34,6 +34,9 @@
  */
 public interface MvcEndpoint {
 
+	/**
+	 * A {@link ResponseEntity} returned for disabled endpoints.
+	 */
 	ResponseEntity<Map<String, String>> DISABLED_RESPONSE = new ResponseEntity<Map<String, String>>(
 			Collections.singletonMap("message", "This endpoint is disabled"),
 			HttpStatus.NOT_FOUND);

spring-boot-actuator/src/main/java/org/springframework/boot/actuate/endpoint/mvc/NamePatternFilter.java

@@ -26,9 +26,9 @@
  * must provide implementations of {@link #getValue(Object, String)} and
  * {@link #getNames(Object, NameCallback)}.
  *
+ * @param <T> The source data type
  * @author Phillip Webb
  * @author Sergei Egorov
- * @param <T> The source data type
  * @since 1.3.0
  */
 abstract class NamePatternFilter<T> {
@@ -66,12 +66,18 @@ private boolean isRegex(String name) {
 
 	protected abstract Object getValue(T source, String name);
 
+	/**
+	 * Callback used to add a name.
+	 */
 	protected interface NameCallback {
 
 		void addName(String name);
 
 	}
 
+	/**
+	 * {@link NameCallback} implementation to collect results.
+	 */
 	private class ResultCollectingNameCallback implements NameCallback {
 
 		private final Pattern pattern;