Fix various javadoc warnings
This commit is contained in:
@@ -35,7 +35,7 @@ package org.springframework.asm;
|
||||
* designates the <i>instruction</i> that is just after. Note however that there
|
||||
* can be other elements between a label and the instruction it designates (such
|
||||
* as other labels, stack map frames, line numbers, etc.).
|
||||
*
|
||||
*
|
||||
* @author Eric Bruneton
|
||||
*/
|
||||
public class Label {
|
||||
@@ -111,13 +111,13 @@ public class Label {
|
||||
* Field used to associate user information to a label. Warning: this field
|
||||
* is used by the ASM tree package. In order to use it with the ASM tree
|
||||
* package you must override the
|
||||
* {@link org.objectweb.asm.tree.MethodNode#getLabelNode} method.
|
||||
* {@code org.objectweb.asm.tree.MethodNode#getLabelNode} method.
|
||||
*/
|
||||
public Object info;
|
||||
|
||||
/**
|
||||
* Flags that indicate the status of this label.
|
||||
*
|
||||
*
|
||||
* @see #DEBUG
|
||||
* @see #RESOLVED
|
||||
* @see #RESIZED
|
||||
@@ -170,7 +170,7 @@ public class Label {
|
||||
* represented by the Label object that corresponds to the first instruction
|
||||
* of this basic block. Each node also stores the list of its successors in
|
||||
* the graph, as a linked list of Edge objects.
|
||||
*
|
||||
*
|
||||
* The control flow analysis algorithms used to compute the maximum stack
|
||||
* size or the stack map frames are similar and use two steps. The first
|
||||
* step, during the visit of each instruction, builds information about the
|
||||
@@ -182,7 +182,7 @@ public class Label {
|
||||
* information about the input frame of each basic block, from the input
|
||||
* state of the first basic block (known from the method signature), and by
|
||||
* the using the previously computed relative output frames.
|
||||
*
|
||||
*
|
||||
* The algorithm used to compute the maximum stack size only computes the
|
||||
* relative output and absolute input stack heights, while the algorithm
|
||||
* used to compute stack map frames computes relative output frames and
|
||||
@@ -192,10 +192,10 @@ public class Label {
|
||||
/**
|
||||
* Start of the output stack relatively to the input stack. The exact
|
||||
* semantics of this field depends on the algorithm that is used.
|
||||
*
|
||||
*
|
||||
* When only the maximum stack size is computed, this field is the number of
|
||||
* elements in the input stack.
|
||||
*
|
||||
*
|
||||
* When the stack map frames are completely computed, this field is the
|
||||
* offset of the first output stack element relatively to the top of the
|
||||
* input stack. This offset is always negative or null. A null offset means
|
||||
@@ -240,7 +240,7 @@ public class Label {
|
||||
* main loop of the fix point algorithm used in the second step of the
|
||||
* control flow analysis algorithms. It is also used in
|
||||
* {@link #visitSubroutine} to avoid using a recursive method.
|
||||
*
|
||||
*
|
||||
* @see MethodWriter#visitMaxs
|
||||
*/
|
||||
Label next;
|
||||
@@ -264,7 +264,7 @@ public class Label {
|
||||
* from the start of the method's bytecode. <i>This method is intended for
|
||||
* {@link Attribute} sub classes, and is normally not needed by class
|
||||
* generators or adapters.</i>
|
||||
*
|
||||
*
|
||||
* @return the offset corresponding to this label.
|
||||
* @throws IllegalStateException
|
||||
* if this label is not resolved yet.
|
||||
@@ -282,7 +282,7 @@ public class Label {
|
||||
* position of the label is known, the offset is computed and written
|
||||
* directly. Otherwise, a null offset is written and a new forward reference
|
||||
* is declared for this label.
|
||||
*
|
||||
*
|
||||
* @param owner
|
||||
* the code writer that calls this method.
|
||||
* @param out
|
||||
@@ -320,7 +320,7 @@ public class Label {
|
||||
* for a true forward reference, i.e. only if this label is not resolved
|
||||
* yet. For backward references, the offset of the reference can be, and
|
||||
* must be, computed and stored directly.
|
||||
*
|
||||
*
|
||||
* @param sourcePosition
|
||||
* the position of the referencing instruction. This position
|
||||
* will be used to compute the offset of this forward reference.
|
||||
@@ -348,7 +348,7 @@ public class Label {
|
||||
* when this label is added to the bytecode of the method, i.e. when its
|
||||
* position becomes known. This method fills in the blanks that where left
|
||||
* in the bytecode by each forward reference previously added to this label.
|
||||
*
|
||||
*
|
||||
* @param owner
|
||||
* the code writer that calls this method.
|
||||
* @param position
|
||||
@@ -416,7 +416,7 @@ public class Label {
|
||||
* isolated label or for the first label in a series of successive labels,
|
||||
* this method returns the label itself. For other labels it returns the
|
||||
* first label of the series.
|
||||
*
|
||||
*
|
||||
* @return the first label of the series to which this label belongs.
|
||||
*/
|
||||
Label getFirst() {
|
||||
@@ -429,7 +429,7 @@ public class Label {
|
||||
|
||||
/**
|
||||
* Returns true is this basic block belongs to the given subroutine.
|
||||
*
|
||||
*
|
||||
* @param id
|
||||
* a subroutine id.
|
||||
* @return true is this basic block belongs to the given subroutine.
|
||||
@@ -444,7 +444,7 @@ public class Label {
|
||||
/**
|
||||
* Returns true if this basic block and the given one belong to a common
|
||||
* subroutine.
|
||||
*
|
||||
*
|
||||
* @param block
|
||||
* another basic block.
|
||||
* @return true if this basic block and the given one belong to a common
|
||||
@@ -464,7 +464,7 @@ public class Label {
|
||||
|
||||
/**
|
||||
* Marks this basic block as belonging to the given subroutine.
|
||||
*
|
||||
*
|
||||
* @param id
|
||||
* a subroutine id.
|
||||
* @param nbSubroutines
|
||||
@@ -483,7 +483,7 @@ public class Label {
|
||||
* blocks as belonging to this subroutine. This method follows the control
|
||||
* flow graph to find all the blocks that are reachable from the current
|
||||
* block WITHOUT following any JSR target.
|
||||
*
|
||||
*
|
||||
* @param JSR
|
||||
* a JSR block that jumps to this subroutine. If this JSR is not
|
||||
* null it is added to the successor of the RET blocks found in
|
||||
@@ -550,7 +550,7 @@ public class Label {
|
||||
|
||||
/**
|
||||
* Returns a string representation of this label.
|
||||
*
|
||||
*
|
||||
* @return a string representation of this label.
|
||||
*/
|
||||
@Override
|
||||
|
||||
@@ -103,7 +103,7 @@ public final class ResolvableType implements Serializable {
|
||||
private TypeProvider typeProvider;
|
||||
|
||||
/**
|
||||
* The {@link VariableResolver} to use or {@code null} if no resolver is available.
|
||||
* The {@code VariableResolver} to use or {@code null} if no resolver is available.
|
||||
*/
|
||||
private final VariableResolver variableResolver;
|
||||
|
||||
|
||||
@@ -261,8 +261,8 @@ public class AntPathMatcher implements PathMatcher {
|
||||
/**
|
||||
* Build or retrieve an {@link AntPathStringMatcher} for the given pattern.
|
||||
* <p>The default implementation checks this AntPathMatcher's internal cache
|
||||
* (see {@link #setCachePatterns}, creating a new AntPathStringMatcher instance
|
||||
* through {@link AntPathStringMatcher#AntPathStringMatcher(String)} if none found.
|
||||
* (see {@link #setCachePatterns}), creating a new AntPathStringMatcher instance
|
||||
* if no cached copy is found.
|
||||
* When encountering too many patterns to cache at runtime (the threshold is 65536),
|
||||
* it turns the default cache off, assuming that arbitrary permutations of patterns
|
||||
* are coming in, with little chance for encountering a reoccurring pattern.
|
||||
|
||||
@@ -17,7 +17,7 @@
|
||||
package org.springframework.util;
|
||||
|
||||
/**
|
||||
* Exception thrown from {@link MediaType#parseMimeType(String)} in case of
|
||||
* Exception thrown from {@link MimeTypeUtils#parseMimeType(String)} in case of
|
||||
* encountering an invalid content type specification String.
|
||||
*
|
||||
* @author Juergen Hoeller
|
||||
|
||||
@@ -33,17 +33,15 @@ import java.util.TreeSet;
|
||||
* other Internet protocols including HTTP. This class however does not contain support
|
||||
* the q-parameters used in HTTP content negotiation. Those can be found in the sub-class
|
||||
* {@code org.springframework.http.MediaType} in the {@code spring-web} module.
|
||||
* <p>
|
||||
* Consists of a {@linkplain #getType() type} and a {@linkplain #getSubtype() subtype}.
|
||||
*
|
||||
* <p>Consists of a {@linkplain #getType() type} and a {@linkplain #getSubtype() subtype}.
|
||||
* Also has functionality to parse media types from a string using
|
||||
* {@link #parseMimeType(String)}, or multiple comma-separated media types using
|
||||
* {@link #parseMimeTypes(String)}.
|
||||
* {@link #valueOf(String)}. For more parsing options see {@link MimeTypeUtils}.
|
||||
*
|
||||
* @author Arjen Poutsma
|
||||
* @author Juergen Hoeller
|
||||
* @author Rossen Stoyanchev
|
||||
* @since 4.0
|
||||
*
|
||||
* @see MimeTypeUtils
|
||||
*/
|
||||
public class MimeType implements Comparable<MimeType>, Serializable {
|
||||
@@ -324,10 +322,12 @@ public class MimeType implements Comparable<MimeType>, Serializable {
|
||||
|
||||
/**
|
||||
* Indicate whether this {@code MediaType} is compatible with the given media type.
|
||||
* <p>For instance, {@code text/*} is compatible with {@code text/plain}, {@code text/html}, and vice versa.
|
||||
* In effect, this method is similar to {@link #includes(MediaType)}, except that it <b>is</b> symmetric.
|
||||
* <p>For instance, {@code text/*} is compatible with {@code text/plain},
|
||||
* {@code text/html}, and vice versa. In effect, this method is similar to
|
||||
* {@link #includes}, except that it <b>is</b> symmetric.
|
||||
* @param other the reference media type with which to compare
|
||||
* @return {@code true} if this media type is compatible with the given media type; {@code false} otherwise
|
||||
* @return {@code true} if this media type is compatible with the given media type;
|
||||
* {@code false} otherwise
|
||||
*/
|
||||
public boolean isCompatibleWith(MimeType other) {
|
||||
if (other == null) {
|
||||
@@ -369,7 +369,7 @@ public class MimeType implements Comparable<MimeType>, Serializable {
|
||||
/**
|
||||
* Compares this {@code MediaType} to another alphabetically.
|
||||
* @param other media type to compare to
|
||||
* @see #sortBySpecificity(List)
|
||||
* @see MimeTypeUtils#sortBySpecificity(List)
|
||||
*/
|
||||
@Override
|
||||
public int compareTo(MimeType other) {
|
||||
@@ -459,7 +459,7 @@ public class MimeType implements Comparable<MimeType>, Serializable {
|
||||
* Parse the given String value into a {@code MimeType} object,
|
||||
* with this method name following the 'valueOf' naming convention
|
||||
* (as supported by {@link org.springframework.core.convert.ConversionService}.
|
||||
* @see #parseMimeType(String)
|
||||
* @see MimeTypeUtils#parseMimeType(String)
|
||||
*/
|
||||
public static MimeType valueOf(String value) {
|
||||
return MimeTypeUtils.parseMimeType(value);
|
||||
|
||||
@@ -28,15 +28,13 @@ import java.util.Map;
|
||||
|
||||
import org.springframework.util.MimeType.SpecificityComparator;
|
||||
|
||||
|
||||
|
||||
/**
|
||||
*
|
||||
* @author Arjen Poutsma
|
||||
* @author Rossen Stoyanchev
|
||||
* @since 4.0
|
||||
*/
|
||||
public class MimeTypeUtils {
|
||||
public abstract class MimeTypeUtils {
|
||||
|
||||
/**
|
||||
* Public constant mime type that includes all media ranges (i.e. "*/*").
|
||||
@@ -44,7 +42,7 @@ public class MimeTypeUtils {
|
||||
public static final MimeType ALL;
|
||||
|
||||
/**
|
||||
* A String equivalent of {@link MediaType#ALL}.
|
||||
* A String equivalent of {@link MimeTypeUtils#ALL}.
|
||||
*/
|
||||
public static final String ALL_VALUE = "*/*";
|
||||
|
||||
@@ -54,7 +52,7 @@ public class MimeTypeUtils {
|
||||
public final static MimeType APPLICATION_ATOM_XML;
|
||||
|
||||
/**
|
||||
* A String equivalent of {@link MimeType#APPLICATION_ATOM_XML}.
|
||||
* A String equivalent of {@link MimeTypeUtils#APPLICATION_ATOM_XML}.
|
||||
*/
|
||||
public final static String APPLICATION_ATOM_XML_VALUE = "application/atom+xml";
|
||||
|
||||
@@ -64,7 +62,7 @@ public class MimeTypeUtils {
|
||||
public final static MimeType APPLICATION_FORM_URLENCODED;
|
||||
|
||||
/**
|
||||
* A String equivalent of {@link MimeType#APPLICATION_FORM_URLENCODED}.
|
||||
* A String equivalent of {@link MimeTypeUtils#APPLICATION_FORM_URLENCODED}.
|
||||
*/
|
||||
public final static String APPLICATION_FORM_URLENCODED_VALUE = "application/x-www-form-urlencoded";
|
||||
|
||||
@@ -74,7 +72,7 @@ public class MimeTypeUtils {
|
||||
public final static MimeType APPLICATION_JSON;
|
||||
|
||||
/**
|
||||
* A String equivalent of {@link MimeType#APPLICATION_JSON}.
|
||||
* A String equivalent of {@link MimeTypeUtils#APPLICATION_JSON}.
|
||||
*/
|
||||
public final static String APPLICATION_JSON_VALUE = "application/json";
|
||||
|
||||
@@ -84,7 +82,7 @@ public class MimeTypeUtils {
|
||||
public final static MimeType APPLICATION_OCTET_STREAM;
|
||||
|
||||
/**
|
||||
* A String equivalent of {@link MimeType#APPLICATION_OCTET_STREAM}.
|
||||
* A String equivalent of {@link MimeTypeUtils#APPLICATION_OCTET_STREAM}.
|
||||
*/
|
||||
public final static String APPLICATION_OCTET_STREAM_VALUE = "application/octet-stream";
|
||||
|
||||
@@ -94,7 +92,7 @@ public class MimeTypeUtils {
|
||||
public final static MimeType APPLICATION_XHTML_XML;
|
||||
|
||||
/**
|
||||
* A String equivalent of {@link MimeType#APPLICATION_XHTML_XML}.
|
||||
* A String equivalent of {@link MimeTypeUtils#APPLICATION_XHTML_XML}.
|
||||
*/
|
||||
public final static String APPLICATION_XHTML_XML_VALUE = "application/xhtml+xml";
|
||||
|
||||
@@ -104,7 +102,7 @@ public class MimeTypeUtils {
|
||||
public final static MimeType APPLICATION_XML;
|
||||
|
||||
/**
|
||||
* A String equivalent of {@link MimeType#APPLICATION_XML}.
|
||||
* A String equivalent of {@link MimeTypeUtils#APPLICATION_XML}.
|
||||
*/
|
||||
public final static String APPLICATION_XML_VALUE = "application/xml";
|
||||
|
||||
@@ -114,7 +112,7 @@ public class MimeTypeUtils {
|
||||
public final static MimeType IMAGE_GIF;
|
||||
|
||||
/**
|
||||
* A String equivalent of {@link MimeType#IMAGE_GIF}.
|
||||
* A String equivalent of {@link MimeTypeUtils#IMAGE_GIF}.
|
||||
*/
|
||||
public final static String IMAGE_GIF_VALUE = "image/gif";
|
||||
|
||||
@@ -124,7 +122,7 @@ public class MimeTypeUtils {
|
||||
public final static MimeType IMAGE_JPEG;
|
||||
|
||||
/**
|
||||
* A String equivalent of {@link MimeType#IMAGE_JPEG}.
|
||||
* A String equivalent of {@link MimeTypeUtils#IMAGE_JPEG}.
|
||||
*/
|
||||
public final static String IMAGE_JPEG_VALUE = "image/jpeg";
|
||||
|
||||
@@ -134,7 +132,7 @@ public class MimeTypeUtils {
|
||||
public final static MimeType IMAGE_PNG;
|
||||
|
||||
/**
|
||||
* A String equivalent of {@link MimeType#IMAGE_PNG}.
|
||||
* A String equivalent of {@link MimeTypeUtils#IMAGE_PNG}.
|
||||
*/
|
||||
public final static String IMAGE_PNG_VALUE = "image/png";
|
||||
|
||||
@@ -144,7 +142,7 @@ public class MimeTypeUtils {
|
||||
public final static MimeType MULTIPART_FORM_DATA;
|
||||
|
||||
/**
|
||||
* A String equivalent of {@link MimeType#MULTIPART_FORM_DATA}.
|
||||
* A String equivalent of {@link MimeTypeUtils#MULTIPART_FORM_DATA}.
|
||||
*/
|
||||
public final static String MULTIPART_FORM_DATA_VALUE = "multipart/form-data";
|
||||
|
||||
@@ -154,7 +152,7 @@ public class MimeTypeUtils {
|
||||
public final static MimeType TEXT_HTML;
|
||||
|
||||
/**
|
||||
* A String equivalent of {@link MimeType#TEXT_HTML}.
|
||||
* A String equivalent of {@link MimeTypeUtils#TEXT_HTML}.
|
||||
*/
|
||||
public final static String TEXT_HTML_VALUE = "text/html";
|
||||
|
||||
@@ -164,7 +162,7 @@ public class MimeTypeUtils {
|
||||
public final static MimeType TEXT_PLAIN;
|
||||
|
||||
/**
|
||||
* A String equivalent of {@link MimeType#TEXT_PLAIN}.
|
||||
* A String equivalent of {@link MimeTypeUtils#TEXT_PLAIN}.
|
||||
*/
|
||||
public final static String TEXT_PLAIN_VALUE = "text/plain";
|
||||
|
||||
@@ -174,7 +172,7 @@ public class MimeTypeUtils {
|
||||
public final static MimeType TEXT_XML;
|
||||
|
||||
/**
|
||||
* A String equivalent of {@link MimeType#TEXT_XML}.
|
||||
* A String equivalent of {@link MimeTypeUtils#TEXT_XML}.
|
||||
*/
|
||||
public final static String TEXT_XML_VALUE = "text/xml";
|
||||
|
||||
@@ -294,16 +292,16 @@ public class MimeTypeUtils {
|
||||
* <p>
|
||||
* Given two mime types:
|
||||
* <ol>
|
||||
* <li>if either mime type has a {@linkplain #isWildcardType() wildcard type}, then
|
||||
* the mime type without the wildcard is ordered before the other.</li>
|
||||
* <li>if the two mime types have different {@linkplain #getType() types}, then
|
||||
* they are considered equal and remain their current order.</li>
|
||||
* <li>if either mime type has a {@linkplain #isWildcardSubtype() wildcard subtype}
|
||||
* <li>if either mime type has a {@linkplain MimeType#isWildcardType() wildcard type},
|
||||
* then the mime type without the wildcard is ordered before the other.</li>
|
||||
* <li>if the two mime types have different {@linkplain MimeType#getType() types},
|
||||
* then they are considered equal and remain their current order.</li>
|
||||
* <li>if either mime type has a {@linkplain MimeType#isWildcardSubtype() wildcard subtype}
|
||||
* , then the mime type without the wildcard is sorted before the other.</li>
|
||||
* <li>if the two mime types have different {@linkplain #getSubtype() subtypes},
|
||||
* <li>if the two mime types have different {@linkplain MimeType#getSubtype() subtypes},
|
||||
* then they are considered equal and remain their current order.</li>
|
||||
* <li>if the two mime types have a different amount of
|
||||
* {@linkplain #getParameter(String) parameters}, then the mime type with the most
|
||||
* {@linkplain MimeType#getParameter(String) parameters}, then the mime type with the most
|
||||
* parameters is ordered before the other.</li>
|
||||
* </ol>
|
||||
* <p>
|
||||
|
||||
@@ -26,7 +26,7 @@ import org.springframework.util.Assert;
|
||||
/**
|
||||
* Abstract class that adapts a {@link Future} parameterized over S into a {@code
|
||||
* Future} parameterized over T. All methods are delegated to the adaptee, where {@link
|
||||
* #get()} and {@link #get(long, TimeUnit)} call {@@link #adapt(Object)} on the adaptee's
|
||||
* #get()} and {@link #get(long, TimeUnit)} call {@link #adapt(Object)} on the adaptee's
|
||||
* result.
|
||||
*
|
||||
* @param <T> the type of this {@code Future}
|
||||
|
||||
@@ -22,7 +22,7 @@ import java.util.concurrent.Future;
|
||||
* Extends the {@link Future} interface with the capability to accept completion
|
||||
* callbacks. If the future has already completed when the callback is added, the
|
||||
* callback will be triggered immediately.
|
||||
* <p>Inspired by {@link com.google.common.util.concurrent.ListenableFuture}.
|
||||
* <p>Inspired by {@code com.google.common.util.concurrent.ListenableFuture}.
|
||||
|
||||
* @author Arjen Poutsma
|
||||
* @since 4.0
|
||||
@@ -33,7 +33,6 @@ public interface ListenableFuture<T> extends Future<T> {
|
||||
* Registers the given callback to this {@code ListenableFuture}. The callback will
|
||||
* be triggered when this {@code Future} is complete or, if it is already complete,
|
||||
* immediately.
|
||||
*
|
||||
* @param callback the callback to register
|
||||
*/
|
||||
void addCallback(ListenableFutureCallback<? super T> callback);
|
||||
|
||||
@@ -22,7 +22,7 @@ import java.util.concurrent.ExecutionException;
|
||||
* Abstract class that adapts a {@link ListenableFuture} parameterized over S into a
|
||||
* {@code ListenableFuture} parameterized over T. All methods are delegated to the
|
||||
* adaptee, where {@link #get()}, {@link #get(long, java.util.concurrent.TimeUnit)}, and
|
||||
* {@link ListenableFutureCallback#onSuccess(Object)} call {@@link #adapt(Object)} on the
|
||||
* {@link ListenableFutureCallback#onSuccess(Object)} call {@link #adapt(Object)} on the
|
||||
* adaptee's result.
|
||||
*
|
||||
* @param <T> the type of this {@code Future}
|
||||
|
||||
@@ -23,7 +23,9 @@ import org.springframework.util.Assert;
|
||||
|
||||
/**
|
||||
* Registry for {@link ListenableFutureCallback} instances.
|
||||
* <p>Inspired by {@link com.google.common.util.concurrent.ExecutionList}.
|
||||
*
|
||||
* <p>Inspired by {@code com.google.common.util.concurrent.ExecutionList}.
|
||||
*
|
||||
* @author Arjen Poutsma
|
||||
* @since 4.0
|
||||
*/
|
||||
|
||||
Reference in New Issue
Block a user