Apache
/
httpcomponents-client
mirror of https://github.com/apache/httpcomponents-client.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Javadoc 8 fixes: Use {@code foo} instead of <code>foo</foo>. 

git-svn-id: https://svn.apache.org/repos/asf/httpcomponents/httpclient/trunk@1619429 13f79535-47bb-0310-9956-ffa450edef68
This commit is contained in:
Gary D. Gregory 2014-08-21 15:09:04 +00:00
parent ebd174ab22
commit fb374dab5f
17 changed files with 36 additions and 36 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
httpclient-cache/src/main/java/org/apache/http/client/cache/HttpCacheUpdateCallback.java vendored
View File

@ -41,9 +41,9 @@ public interface HttpCacheUpdateCallback {
*
* @param existing
* the cache entry currently in-place in the cache, possibly
* <code>null</code> if nonexistent
* {@code null} if nonexistent
* @return the cache entry that should replace it, again,
* possibly <code>null</code> if the entry should be deleted
* possibly {@code null} if the entry should be deleted
*
* @since 4.1
*/

4
httpclient-cache/src/main/java/org/apache/http/impl/client/cache/AsynchronousValidationRequest.java vendored
View File

@ -105,8 +105,8 @@ public class AsynchronousValidationRequest implements Runnable {
* Revalidate the cache entry and return if the operation was successful.
* Success means a connection to the server was established and replay did
* not indicate a server error.
* @return <code>true</code> if the cache entry was successfully validated;
* otherwise <code>false</code>
* @return {@code true} if the cache entry was successfully validated;
* otherwise {@code false}
*/
private boolean revalidateCacheEntry() {
try {

4
httpclient-cache/src/main/java/org/apache/http/impl/client/cache/CacheConfig.java vendored
View File

@ -460,7 +460,7 @@ public class CacheConfig implements Cloneable {
* Sets the minimum number of threads to keep alive for background
* revalidations due to the {@code stale-while-revalidate} directive.
* @param min should be greater than zero and less than or equal
* to <code>getAsynchronousWorkersMax()</code>
* to {@code getAsynchronousWorkersMax()}
*
* @deprecated (4.3) use {@link Builder}.
*/
@ -680,7 +680,7 @@ public class CacheConfig implements Cloneable {
* Sets the minimum number of threads to keep alive for background
* revalidations due to the {@code stale-while-revalidate} directive.
* @param asynchronousWorkersCore should be greater than zero and less than or equal
* to <code>getAsynchronousWorkersMax()</code>
* to {@code getAsynchronousWorkersMax()}
*/
public Builder setAsynchronousWorkersCore(final int asynchronousWorkersCore) {
this.asynchronousWorkersCore = asynchronousWorkersCore;

2
httpclient-cache/src/main/java/org/apache/http/impl/client/cache/CacheKeyGenerator.java vendored
View File

@ -143,7 +143,7 @@ class CacheKeyGenerator {
* variant key.
* @param req originating request
* @param entry cache entry in question that has variants
* @return a <code>String</code> variant key
* @return a {@code String} variant key
*/
public String getVariantKey(final HttpRequest req, final HttpCacheEntry entry) {
final List<String> variantHeaderNames = new ArrayList<String>();

4
httpclient-cache/src/main/java/org/apache/http/impl/client/cache/ExponentialBackOffSchedulingStrategy.java vendored
View File

@ -71,7 +71,7 @@ public class ExponentialBackOffSchedulingStrategy implements SchedulingStrategy
/**
* Create a new scheduling strategy using a fixed pool of worker threads.
* @param cacheConfig the thread pool configuration to be used; not <code>null</code>
* @param cacheConfig the thread pool configuration to be used; not {@code null}
* @see org.apache.http.impl.client.cache.CacheConfig#getAsynchronousWorkersMax()
* @see #DEFAULT_BACK_OFF_RATE
* @see #DEFAULT_INITIAL_EXPIRY_IN_MILLIS
@ -88,7 +88,7 @@ public class ExponentialBackOffSchedulingStrategy implements SchedulingStrategy
* Create a new scheduling strategy by using a fixed pool of worker threads and the
* given parameters to calculated the delay.
*
* @param cacheConfig the thread pool configuration to be used; not <code>null</code>
* @param cacheConfig the thread pool configuration to be used; not {@code null}
* @param backOffRate the back off rate to be used; not negative
* @param initialExpiryInMillis the initial expiry in milli seconds; not negative
* @param maxExpiryInMillis the upper limit of the delay in milli seconds; not negative

2
httpclient-cache/src/main/java/org/apache/http/impl/client/cache/HttpCache.java vendored
View File

@ -83,7 +83,7 @@ interface HttpCache {
* {@link Map} is returned
* @param host
* @param request
* @return a <code>Map</code> mapping Etags to variant cache entries
* @return a {@code Map} mapping Etags to variant cache entries
* @throws IOException
*/
Map<String,Variant> getVariantCacheEntriesWithEtags(HttpHost host, HttpRequest request)

4
httpclient-cache/src/main/java/org/apache/http/impl/client/cache/ResponseCachingPolicy.java vendored
View File

@ -99,7 +99,7 @@ class ResponseCachingPolicy {
*
* @param httpMethod What type of request was this, a GET, PUT, other?
* @param response The origin response
* @return <code>true</code> if response is cacheable
* @return {@code true} if response is cacheable
*/
public boolean isResponseCacheable(final String httpMethod, final HttpResponse response) {
boolean cacheable = false;
@ -232,7 +232,7 @@ class ResponseCachingPolicy {
*
* @param request the {@link HttpRequest} that generated an origin hit
* @param response the {@link HttpResponse} from the origin
* @return <code>true</code> if response is cacheable
* @return {@code true} if response is cacheable
*/
public boolean isResponseCacheable(final HttpRequest request, final HttpResponse response) {
if (requestProtocolGreaterThanAccepted(request)) {

2
httpclient-cache/src/main/java/org/apache/http/impl/client/cache/SchedulingStrategy.java vendored
View File

@ -38,7 +38,7 @@ public interface SchedulingStrategy extends Closeable
/**
* Schedule an {@link AsynchronousValidationRequest} to be executed.
*
* @param revalidationRequest the request to be executed; not <code>null</code>
* @param revalidationRequest the request to be executed; not {@code null}
* @throws java.util.concurrent.RejectedExecutionException if the request could not be scheduled for execution
*/
void schedule(AsynchronousValidationRequest revalidationRequest);

10
httpclient-cache/src/main/java/org/apache/http/impl/client/cache/WarningValue.java vendored
View File

@ -66,7 +66,7 @@ class WarningValue {
* skipped, in keeping with the philosophy of "ignore what you
* cannot understand."
* @param h Warning {@link Header} to parse
* @return array of <code>WarnValue</code> objects
* @return array of {@code WarnValue} objects
*/
public static WarningValue[] getWarningValues(final Header h) {
final List<WarningValue> out = new ArrayList<WarningValue>();
@ -317,7 +317,7 @@ class WarningValue {
}
/** Returns the 3-digit code associated with this warning.
* @return <code>int</code>
* @return {@code int}
*/
public int getWarnCode() { return warnCode; }
@ -335,20 +335,20 @@ class WarningValue {
* <pre>
* Warning: 110 fred "Response is stale"
* </pre>
* then this method will return <code>"\"Response is stale\""</code>
* then this method will return {@code "\"Response is stale\""}
* (surrounding quotes included).
* @return {@link String}
*/
public String getWarnText() { return warnText; }
/** Returns the date and time when this warning was added, or
* <code>null</code> if a warning date was not supplied in the
* {@code null} if a warning date was not supplied in the
* header.
* @return {@link Date}
*/
public Date getWarnDate() { return warnDate; }
/** Formats a <code>WarningValue</code> as a {@link String}
/** Formats a {@code WarningValue} as a {@link String}
* suitable for including in a header. For example, you can:
* <pre>
* WarningValue wv = ...;

6
httpclient-cache/src/main/java/org/apache/http/impl/client/cache/memcached/MemcachedCacheEntry.java vendored
View File

@ -44,14 +44,14 @@ public interface MemcachedCacheEntry {
/**
* Returns the storage key associated with this entry. May return
* <code>null</code> if this is an "unset" instance waiting to be
* {@code null} if this is an "unset" instance waiting to be
* {@link #set(byte[])} with a serialized representation.
*/
String getStorageKey();
/**
* Returns the {@link HttpCacheEntry} associated with this entry.
* May return <code>null</code> if this is an "unset" instance
* May return {@code null} if this is an "unset" instance
* waiting to be {@link #set(byte[])} with a serialized
* representation.
*/
@ -64,7 +64,7 @@ public interface MemcachedCacheEntry {
* object should return updated (as appropriate) values for
* {@link #getStorageKey()} and {@link #getHttpCacheEntry()}. This
* should be viewed as an atomic operation on the
* <code>MemcachedCacheEntry</code>.
* {@code MemcachedCacheEntry}.
* @param bytes serialized representation
* @throws {@link MemcachedSerializationException} if deserialization
* fails. In this case, the prior values for {{@link #getStorageKey()}

4
httpclient-cache/src/main/java/org/apache/http/impl/client/cache/memcached/MemcachedCacheEntryFactory.java vendored
View File

@ -41,7 +41,7 @@ public interface MemcachedCacheEntryFactory {
* we are hashing storage keys into cache keys to accommodate
* limitations in memcached's key space, it is possible to have
* cache collisions. Therefore, we store the storage key along
* with the <code>HttpCacheEntry</code> so it can be compared
* with the {@code HttpCacheEntry} so it can be compared
* on retrieval and thus detect collisions.
* @param storageKey storage key under which the entry will
* be logically stored
@ -55,7 +55,7 @@ public interface MemcachedCacheEntryFactory {
* Creates an "unset" {@link MemcachedCacheEntry} ready to accept
* a serialized representation via {@link MemcachedCacheEntry#set(byte[])}
* and deserialize it into a storage key and a {@link HttpCacheEntry}.
* @return <code>MemcachedCacheEntry</code>
* @return {@code MemcachedCacheEntry}
*/
MemcachedCacheEntry getUnsetCacheEntry();

2
httpclient-cache/src/main/java/org/apache/http/impl/client/cache/memcached/PrefixKeyHashingScheme.java vendored
View File

@ -29,7 +29,7 @@ package org.apache.http.impl.client.cache.memcached;
/**
* This is a {@link KeyHashingScheme} decorator that simply adds
* a known prefix to the results of another <code>KeyHashingScheme</code>.
* a known prefix to the results of another {@code KeyHashingScheme}.
* Primarily useful for namespacing a shared memcached cluster, for
* example.
*/

4
httpclient-cache/src/test/java/org/apache/http/impl/client/cache/HttpTestUtils.java vendored
View File

@ -215,8 +215,8 @@ public class HttpTestUtils {
}
/*
* Assert.asserts that message <code>r2</code> represents exactly the same
* message as <code>r1</code>, except for hop-by-hop headers. "When a cache
* Assert.asserts that message {@code r2} represents exactly the same
* message as {@code r1}, except for hop-by-hop headers. "When a cache
* is semantically transparent, the client receives exactly the same
* response (except for hop-by-hop headers) that it would have received had
* its request been handled directly by the origin server."

4
httpclient-osgi/src/main/java/org/apache/http/osgi/impl/PropertiesUtils.java
View File

@ -83,10 +83,10 @@ final class PropertiesUtils {
/**
* Returns the parameter as a single value. If the
* parameter is neither an array nor a <code>java.util.Collection</code> the
* parameter is neither an array nor a {@code java.util.Collection} the
* parameter is returned unmodified. If the parameter is a non-empty array,
* the first array element is returned. If the property is a non-empty
* <code>java.util.Collection</code>, the first collection element is returned.
* {@code java.util.Collection}, the first collection element is returned.
*
* @param propValue the parameter to convert.
*/

2
httpclient/src/main/java-deprecated/org/apache/http/impl/conn/tsccm/ConnPoolByRoute.java
View File

@ -230,7 +230,7 @@ public class ConnPoolByRoute extends AbstractConnPool {
* @param create whether to create the pool if it doesn't exist
*
* @return the pool for the argument route,
* never {@code null</code> if <code>create</code> is <code>true}
* never {@code null</code> if {@code create} is <code>true}
*/
protected RouteSpecificPool getRoutePool(final HttpRoute route,
final boolean create) {

2
httpmime/src/main/java/org/apache/http/entity/mime/AbstractMultipartForm.java
View File

@ -183,7 +183,7 @@ abstract class AbstractMultipartForm {
* total length of the entire entity. The content of individual parts is not
* buffered.
*
* @return total length of the multipart entity if known, <code>-1</code>
* @return total length of the multipart entity if known, {@code -1}
* otherwise.
*/
public long getTotalLength() {

12
httpmime/src/main/java/org/apache/http/entity/mime/content/ContentDescriptor.java
View File

@ -44,10 +44,10 @@ public interface ContentDescriptor {
/**
* Gets the defaulted MIME media type for this content.
* For example <code>TEXT</code>, <code>IMAGE</code>, <code>MULTIPART</code>
* For example {@code TEXT}, {@code IMAGE}, {@code MULTIPART}
* @see #getMimeType()
* @return the MIME media type when content-type specified,
* otherwise the correct default (<code>TEXT</code>)
* otherwise the correct default ({@code TEXT})
*/
String getMediaType();
@ -55,19 +55,19 @@ public interface ContentDescriptor {
* Gets the defaulted MIME sub type for this content.
* @see #getMimeType()
* @return the MIME media type when content-type is specified,
* otherwise the correct default (<code>PLAIN</code>)
* otherwise the correct default ({@code PLAIN})
*/
String getSubType();
/**
* <p>The body descriptors character set, defaulted appropriately for the MIME type.</p>
* <p>
* For <code>TEXT</code> types, this will be defaulted to <code>us-ascii</code>.
* For {@code TEXT} types, this will be defaulted to {@code us-ascii}.
* For other types, when the charset parameter is missing this property will be null.
* </p>
* @return Character set, which has been parsed from the
* content-type definition. Not null for <code>TEXT</code> types, when unset will
* be set to default <code>us-ascii</code>. For other types, when unset,
* content-type definition. Not null for {@code TEXT} types, when unset will
* be set to default {@code us-ascii}. For other types, when unset,
* null will be returned.
*/
String getCharset();