Fixes #10086 - Revisiting ProxyConfiguration.getProxies() (#10116)

Removed "for removal" deprecation, added clarifying javadocs.

Signed-off-by: Simone Bordet <simone.bordet@gmail.com>
This commit is contained in:
Simone Bordet 2023-07-17 16:45:17 +02:00 committed by GitHub
parent c967b100e7
commit 218c8d0fb0
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 9 additions and 1 deletions

View File

@ -41,10 +41,18 @@ public class ProxyConfiguration
private final List<Proxy> proxies = new BlockingArrayQueue<>();
/**
* <p>Returns the list of proxies added to this configuration.</p>
* <p>This method is deprecated because it has historically been
* used to add/remove proxies directly to/from the returned list,
* but this has now been replaced by {@link #addProxy(Proxy)} and
* {@link #removeProxy(Proxy)} instead.</p>
* <p>In the future, this method will return an unmodifiable
* list of proxies just for querying purposes.</p>
*
* @deprecated use {@link #addProxy(Proxy)} and {@link #removeProxy(Proxy)} instead
* @return the forward proxies to use
*/
@Deprecated(forRemoval = true)
@Deprecated
public List<Proxy> getProxies()
{
return proxies;