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

Javadoc fixes

Browse Source
This commit is contained in:
Juergen Hoeller
2013-08-28 22:16:08 +02:00
parent fe8dec912d
commit 465e6292eb
2 changed files with 9 additions and 11 deletions
Download Patch File Download Diff File Expand all files Collapse all files

15
spring-core/src/main/java/org/springframework/core/env/EnvironmentCapable.java vendored
View File

@@ -1,5 +1,5 @@
/*
* Copyright 2002-2012 the original author or authors.
* Copyright 2002-2013 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.
@@ -16,9 +16,8 @@
package org.springframework.core.env;
/**
* Interface indicating a component contains and makes available an {@link Environment} object.
* Interface indicating a component that contains and exposes an {@link Environment} reference.
*
* <p>All Spring application contexts are EnvironmentCapable, and the interface is used primarily
* for performing {@code instanceof} checks in framework methods that accept BeanFactory
@@ -29,20 +28,20 @@ package org.springframework.core.env;
* extends EnvironmentCapable, and thus exposes a {@link #getEnvironment()} method; however,
* {@link org.springframework.context.ConfigurableApplicationContext ConfigurableApplicationContext}
* redefines {@link org.springframework.context.ConfigurableApplicationContext#getEnvironment
* getEnvironment()} and narrows the signature to return a {@link ConfigurableEnvironment}. The effect
* is that an Environment object is 'read-only' until it accessed from a ConfigurableApplicationContext,
* at which point it too may be configured.
* getEnvironment()} and narrows the signature to return a {@link ConfigurableEnvironment}.
* The effect is that an Environment object is 'read-only' until it is being accessed from
* a ConfigurableApplicationContext, at which point it too may be configured.
*
* @author Chris Beams
* @since 3.1
* @see Environment
* @see ConfigurableEnvironment
* @see org.springframework.context.ConfigurableApplicationContext#getEnvironment
* @see org.springframework.context.ConfigurableApplicationContext#getEnvironment()
*/
public interface EnvironmentCapable {
/**
* Return the Environment for this object
* Return the {@link Environment} associated with this component.
*/
Environment getEnvironment();