|
1 | 1 | /*
|
2 |
| - * Copyright 2002-2012 the original author or authors. |
| 2 | + * Copyright 2002-2013 the original author or authors. |
3 | 3 | *
|
4 | 4 | * Licensed under the Apache License, Version 2.0 (the "License");
|
5 | 5 | * you may not use this file except in compliance with the License.
|
|
16 | 16 |
|
17 | 17 | package org.springframework.core.env;
|
18 | 18 |
|
19 |
| - |
20 | 19 | /**
|
21 |
| - * Interface indicating a component contains and makes available an {@link Environment} object. |
| 20 | + * Interface indicating a component that contains and exposes an {@link Environment} reference. |
22 | 21 | *
|
23 | 22 | * <p>All Spring application contexts are EnvironmentCapable, and the interface is used primarily
|
24 | 23 | * for performing {@code instanceof} checks in framework methods that accept BeanFactory
|
|
29 | 28 | * extends EnvironmentCapable, and thus exposes a {@link #getEnvironment()} method; however,
|
30 | 29 | * {@link org.springframework.context.ConfigurableApplicationContext ConfigurableApplicationContext}
|
31 | 30 | * redefines {@link org.springframework.context.ConfigurableApplicationContext#getEnvironment
|
32 |
| - * getEnvironment()} and narrows the signature to return a {@link ConfigurableEnvironment}. The effect |
33 |
| - * is that an Environment object is 'read-only' until it accessed from a ConfigurableApplicationContext, |
34 |
| - * at which point it too may be configured. |
| 31 | + * getEnvironment()} and narrows the signature to return a {@link ConfigurableEnvironment}. |
| 32 | + * The effect is that an Environment object is 'read-only' until it is being accessed from |
| 33 | + * a ConfigurableApplicationContext, at which point it too may be configured. |
35 | 34 | *
|
36 | 35 | * @author Chris Beams
|
37 | 36 | * @since 3.1
|
38 | 37 | * @see Environment
|
39 | 38 | * @see ConfigurableEnvironment
|
40 |
| - * @see org.springframework.context.ConfigurableApplicationContext#getEnvironment |
| 39 | + * @see org.springframework.context.ConfigurableApplicationContext#getEnvironment() |
41 | 40 | */
|
42 | 41 | public interface EnvironmentCapable {
|
43 | 42 |
|
44 | 43 | /**
|
45 |
| - * Return the Environment for this object |
| 44 | + * Return the {@link Environment} associated with this component. |
46 | 45 | */
|
47 | 46 | Environment getEnvironment();
|
48 | 47 |
|
|
0 commit comments