stan/jdk-24
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

8038764: tidy warnings cleanup for javax.activation

Browse Source 
Minor HTML markup fix

Reviewed-by: lancea
This commit is contained in:
Alexander Stepanov 2015-04-22 15:52:42 +04:00
parent 078abb2617
commit 6f346f9afd
5 changed files with 58 additions and 60 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

11
jaxws/src/java.activation/share/classes/javax/activation/ActivationDataFlavor.java
View File

@ -31,10 +31,10 @@ import javax.activation.MimeType;
/**
* The ActivationDataFlavor class is a special subclass of
* <code>java.awt.datatransfer.DataFlavor</code>. It allows the JAF to
* {@code java.awt.datatransfer.DataFlavor}. It allows the JAF to
* set all three values stored by the DataFlavor class via a new
* constructor. It also contains improved MIME parsing in the <code>equals
* </code> method. Except for the improved parsing, its semantics are
* constructor. It also contains improved MIME parsing in the {@code equals}
* method. Except for the improved parsing, its semantics are
* identical to that of the JDK's DataFlavor class.
*
* @since 1.6
@ -70,7 +70,6 @@ public class ActivationDataFlavor extends DataFlavor {
* representationClass = representationClass<br>
* mimeType = mimeType<br>
* humanName = humanName
* <p>
*
* @param representationClass the class used in this DataFlavor
* @param mimeType the MIME type of the data represented by this class
@ -98,7 +97,7 @@ public class ActivationDataFlavor extends DataFlavor {
* otherwise:
* <p>
* representationClass = InputStream<p>
* mimeType = mimeType<p>
* mimeType = mimeType
*
* @param representationClass the class used in this DataFlavor
* @param humanPresentableName the human presentable name of the flavor
@ -175,7 +174,7 @@ public class ActivationDataFlavor extends DataFlavor {
/**
* Compares the DataFlavor passed in with this DataFlavor; calls
* the <code>isMimeTypeEqual</code> method.
* the {@code isMimeTypeEqual} method.
*
* @param dataFlavor the DataFlavor to compare with
* @return true if the MIME type and representation class

8
jaxws/src/java.activation/share/classes/javax/activation/CommandInfo.java
View File

@ -85,10 +85,10 @@ public class CommandInfo {
* Return the instantiated JavaBean component.
* <p>
* Begin by instantiating the component with
* <code>Beans.instantiate()</code>.
* {@code Beans.instantiate()}.
* <p>
* If the bean implements the <code>javax.activation.CommandObject</code>
* interface, call its <code>setCommandContext</code> method.
* If the bean implements the {@code javax.activation.CommandObject}
* interface, call its {@code setCommandContext} method.
* <p>
* If the DataHandler parameter is null, then the bean is
* instantiated with no data. NOTE: this may be useful
@ -102,7 +102,7 @@ public class CommandInfo {
* this method will check if it implements the
* java.io.Externalizable interface. If it does, the bean's
* readExternal method will be called if an InputStream
* can be acquired from the DataHandler.<p>
* can be acquired from the DataHandler.
*
* @param dh The DataHandler that describes the data to be
* passed to the command.

21
jaxws/src/java.activation/share/classes/javax/activation/CommandMap.java
View File

@ -46,7 +46,6 @@ public abstract class CommandMap {
/**
* Get the default CommandMap.
* <p>
*
* <ul>
* <li> In cases where a CommandMap instance has been previously set
@ -54,7 +53,7 @@ public abstract class CommandMap {
* return the CommandMap.
* <li>
* In cases where no CommandMap has been set, the CommandMap
* creates an instance of <code>MailcapCommandMap</code> and
* creates an instance of {@code MailcapCommandMap} and
* set that to the default, returning its value.
*
* </ul>
@ -77,7 +76,7 @@ public abstract class CommandMap {
/**
* Set the default CommandMap. Reset the CommandMap to the default by
* calling this method with <code>null</code>.
* calling this method with {@code null}.
*
* @param commandMap The new default CommandMap.
* @exception SecurityException if the caller doesn't have permission
@ -118,10 +117,10 @@ public abstract class CommandMap {
* Get the preferred command list from a MIME Type. The actual semantics
* are determined by the implementation of the CommandMap. <p>
*
* The <code>DataSource</code> provides extra information, such as
* The {@code DataSource} provides extra information, such as
* the file name, that a CommandMap implementation may use to further
* refine the list of commands that are returned. The implementation
* in this class simply calls the <code>getPreferredCommands</code>
* in this class simply calls the {@code getPreferredCommands}
* method that ignores this argument.
*
* @param mimeType the MIME type
@ -146,10 +145,10 @@ public abstract class CommandMap {
* Get all the available commands for this type. This method
* should return all the possible commands for this MIME type. <p>
*
* The <code>DataSource</code> provides extra information, such as
* The {@code DataSource} provides extra information, such as
* the file name, that a CommandMap implementation may use to further
* refine the list of commands that are returned. The implementation
* in this class simply calls the <code>getAllCommands</code>
* in this class simply calls the {@code getAllCommands}
* method that ignores this argument.
*
* @param mimeType the MIME type
@ -173,10 +172,10 @@ public abstract class CommandMap {
/**
* Get the default command corresponding to the MIME type. <p>
*
* The <code>DataSource</code> provides extra information, such as
* The {@code DataSource} provides extra information, such as
* the file name, that a CommandMap implementation may use to further
* refine the command that is chosen. The implementation
* in this class simply calls the <code>getCommand</code>
* in this class simply calls the {@code getCommand}
* method that ignores this argument.
*
* @param mimeType the MIME type
@ -206,10 +205,10 @@ public abstract class CommandMap {
* The mechanism and semantics for determining this are determined
* by the implementation of the particular CommandMap. <p>
*
* The <code>DataSource</code> provides extra information, such as
* The {@code DataSource} provides extra information, such as
* the file name, that a CommandMap implementation may use to further
* refine the choice of DataContentHandler. The implementation
* in this class simply calls the <code>createDataContentHandler</code>
* in this class simply calls the {@code createDataContentHandler}
* method that ignores this argument.
*
* @param mimeType the MIME type

4
jaxws/src/java.activation/share/classes/javax/activation/CommandObject.java
View File

@ -34,7 +34,7 @@ import java.io.IOException;
* data they should operate on. JavaBeans that don't implement
* this interface may be used as well. Such commands may obtain
* the data using the Externalizable interface, or using an
* application-specific method.<p>
* application-specific method.
*
* @since 1.6
*/
@ -44,7 +44,7 @@ public interface CommandObject {
* Initialize the Command with the verb it is requested to handle
* and the DataHandler that describes the data it will
* operate on. <b>NOTE:</b> it is acceptable for the caller
* to pass <i>null</i> as the value for <code>DataHandler</code>.
* to pass <i>null</i> as the value for {@code DataHandler}.
*
* @param verb The Command Verb this object refers to.
* @param dh The DataHandler.

74
jaxws/src/java.activation/share/classes/javax/activation/DataHandler.java
View File

@ -54,11 +54,11 @@ import java.awt.datatransfer.UnsupportedFlavorException;
*
* <b>DataHandler and CommandMaps</b><p>
* The DataHandler keeps track of the current CommandMap that it uses to
* service requests for commands (<code>getCommand</code>,
* <code>getAllCommands</code>, <code>getPreferredCommands</code>).
* service requests for commands ({@code getCommand, getAllCommands,
* getPreferredCommands}).
* Each instance of a DataHandler may have a CommandMap associated with
* it using the <code>setCommandMap</code> method. If a CommandMap was
* not set, DataHandler calls the <code>getDefaultCommandMap</code>
* it using the {@code setCommandMap} method. If a CommandMap was
* not set, DataHandler calls the {@code getDefaultCommandMap}
* method in CommandMap and uses the value it returns. See
* <i>CommandMap</i> for more information. <p>
*
@ -105,7 +105,7 @@ public class DataHandler implements Transferable {
private String shortType = null;
/**
* Create a <code>DataHandler</code> instance referencing the
* Create a {@code DataHandler} instance referencing the
* specified DataSource. The data exists in a byte stream form.
* The DataSource will provide an InputStream to access the data.
*
@ -118,7 +118,7 @@ public class DataHandler implements Transferable {
}
/**
* Create a <code>DataHandler</code> instance representing an object
* Create a {@code DataHandler} instance representing an object
* of this MIME type. This constructor is
* used when the application already has an in-memory representation
* of the data in the form of a Java Object.
@ -133,8 +133,8 @@ public class DataHandler implements Transferable {
}
/**
* Create a <code>DataHandler</code> instance referencing a URL.
* The DataHandler internally creates a <code>URLDataSource</code>
* Create a {@code DataHandler} instance referencing a URL.
* The DataHandler internally creates a {@code URLDataSource}
* instance to represent the URL.
*
* @param url a URL object
@ -181,7 +181,7 @@ public class DataHandler implements Transferable {
/**
* Return the name of the data object. If this DataHandler
* was created with a DataSource, this method calls through
* to the <code>DataSource.getName</code> method, otherwise it
* to the {@code DataSource.getName} method, otherwise it
* returns <i>null</i>.
*
* @return the name of the object
@ -211,7 +211,7 @@ public class DataHandler implements Transferable {
* Get the InputStream for this object. <p>
*
* For DataHandlers instantiated with a DataSource, the DataHandler
* calls the <code>DataSource.getInputStream</code> method and
* calls the {@code DataSource.getInputStream} method and
* returns the result to the caller.
* <p>
* For DataHandlers instantiated with an Object, the DataHandler
@ -219,11 +219,11 @@ public class DataHandler implements Transferable {
* the DataHandler can not find a DataContentHandler for this MIME
* type, it throws an UnsupportedDataTypeException. If it is
* successful, it creates a pipe and a thread. The thread uses the
* DataContentHandler's <code>writeTo</code> method to write the
* DataContentHandler's {@code writeTo} method to write the
* stream data into one end of the pipe. The other end of the pipe
* is returned to the caller. Because a thread is created to copy
* the data, IOExceptions that may occur during the copy can not be
* propagated back to the caller. The result is an empty stream.<p>
* propagated back to the caller. The result is an empty stream.
*
* @return the InputStream representing this data
* @exception IOException if an I/O error occurs
@ -281,7 +281,7 @@ public class DataHandler implements Transferable {
}
/**
* Write the data to an <code>OutputStream</code>.<p>
* Write the data to an {@code OutputStream}.<p>
*
* If the DataHandler was created with a DataSource, writeTo
* retrieves the InputStream and copies the bytes from the
@ -290,7 +290,7 @@ public class DataHandler implements Transferable {
* If the DataHandler was created with an object, writeTo
* retrieves the DataContentHandler for the object's type.
* If the DataContentHandler was found, it calls the
* <code>writeTo</code> method on the <code>DataContentHandler</code>.
* {@code writeTo} method on the {@code DataContentHandler}.
*
* @param os the OutputStream to write to
* @exception IOException if an I/O error occurs
@ -322,8 +322,8 @@ public class DataHandler implements Transferable {
* Get an OutputStream for this DataHandler to allow overwriting
* the underlying data.
* If the DataHandler was created with a DataSource, the
* DataSource's <code>getOutputStream</code> method is called.
* Otherwise, <code>null</code> is returned.
* DataSource's {@code getOutputStream} method is called.
* Otherwise, {@code null} is returned.
*
* @return the OutputStream
*
@ -348,12 +348,12 @@ public class DataHandler implements Transferable {
* The DataHandler attempts to find a DataContentHandler that
* corresponds to the MIME type of the data. If one is located,
* the DataHandler calls the DataContentHandler's
* <code>getTransferDataFlavors</code> method. <p>
* {@code getTransferDataFlavors} method. <p>
*
* If a DataContentHandler can <i>not</i> be located, and if the
* DataHandler was created with a DataSource (or URL), one
* DataFlavor is returned that represents this object's MIME type
* and the <code>java.io.InputStream</code> class. If the
* and the {@code java.io.InputStream} class. If the
* DataHandler was created with an object and a MIME type,
* getTransferDataFlavors returns one DataFlavor that represents
* this object's MIME type and the object's class.
@ -381,7 +381,7 @@ public class DataHandler implements Transferable {
* for this object.<p>
*
* This method iterates through the DataFlavors returned from
* <code>getTransferDataFlavors</code>, comparing each with
* {@code getTransferDataFlavors}, comparing each with
* the specified flavor.
*
* @param flavor the requested flavor for the data
@ -407,10 +407,10 @@ public class DataHandler implements Transferable {
*
* The DataHandler attempts to locate a DataContentHandler
* for this MIME type. If one is found, the passed in DataFlavor
* and the type of the data are passed to its <code>getTransferData</code>
* and the type of the data are passed to its {@code getTransferData}
* method. If the DataHandler fails to locate a DataContentHandler
* and the flavor specifies this object's MIME type and the
* <code>java.io.InputStream</code> class, this object's InputStream
* {@code java.io.InputStream} class, this object's InputStream
* is returned.
* Otherwise it throws an UnsupportedFlavorException. <p>
*
@ -438,10 +438,10 @@ public class DataHandler implements Transferable {
/**
* Set the CommandMap for use by this DataHandler.
* Setting it to <code>null</code> causes the CommandMap to revert
* Setting it to {@code null} causes the CommandMap to revert
* to the CommandMap returned by the
* <code>CommandMap.getDefaultCommandMap</code> method.
* Changing the CommandMap, or setting it to <code>null</code>,
* {@code CommandMap.getDefaultCommandMap} method.
* Changing the CommandMap, or setting it to {@code null},
* clears out any data cached from the previous CommandMap.
*
* @param commandMap the CommandMap to use in this DataHandler
@ -460,7 +460,7 @@ public class DataHandler implements Transferable {
/**
* Return the <i>preferred</i> commands for this type of data.
* This method calls the <code>getPreferredCommands</code> method
* This method calls the {@code getPreferredCommands} method
* in the CommandMap associated with this instance of DataHandler.
* This method returns an array that represents a subset of
* available commands. In cases where multiple commands for the
@ -484,7 +484,7 @@ public class DataHandler implements Transferable {
* This method returns an array containing all commands
* for the type of data represented by this DataHandler. The
* MIME type for the underlying data represented by this DataHandler
* is used to call through to the <code>getAllCommands</code> method
* is used to call through to the {@code getAllCommands} method
* of the CommandMap associated with this DataHandler.
*
* @return the CommandInfo objects representing all the commands
@ -502,7 +502,7 @@ public class DataHandler implements Transferable {
* Get the command <i>cmdName</i>. Use the search semantics as
* defined by the CommandMap installed in this DataHandler. The
* MIME type for the underlying data represented by this DataHandler
* is used to call through to the <code>getCommand</code> method
* is used to call through to the {@code getCommand} method
* of the CommandMap associated with this DataHandler.
*
* @param cmdName the command name
@ -527,7 +527,7 @@ public class DataHandler implements Transferable {
* If the DataHandler was instantiated with a DataSource,
* this method uses a DataContentHandler to return the content
* object for the data represented by this DataHandler. If no
* <code>DataContentHandler</code> can be found for the
* {@code DataContentHandler} can be found for the
* the type of this data, the DataHandler returns an
* InputStream for the data.
*
@ -547,9 +547,9 @@ public class DataHandler implements Transferable {
* and instantiates the corresponding command, usually
* a JavaBean component.
* <p>
* This method calls the CommandInfo's <code>getCommandObject</code>
* method with the <code>ClassLoader</code> used to load
* the <code>javax.activation.DataHandler</code> class itself.
* This method calls the CommandInfo's {@code getCommandObject}
* method with the {@code ClassLoader} used to load
* the {@code javax.activation.DataHandler} class itself.
*
* @param cmdinfo the CommandInfo corresponding to a command
* @return the instantiated command object
@ -701,16 +701,16 @@ class DataHandlerDataSource implements DataSource {
}
/**
* Returns an <code>InputStream</code> representing this object.
* @return the <code>InputStream</code>
* Returns an {@code InputStream} representing this object.
* @return the {@code InputStream}
*/
public InputStream getInputStream() throws IOException {
return dataHandler.getInputStream();
}
/**
* Returns the <code>OutputStream</code> for this object.
* @return the <code>OutputStream</code>
* Returns the {@code OutputStream} for this object.
* @return the {@code OutputStream}
*/
public OutputStream getOutputStream() throws IOException {
return dataHandler.getOutputStream();
@ -754,7 +754,7 @@ class DataSourceDataContentHandler implements DataContentHandler {
}
/**
* Return the DataFlavors for this <code>DataContentHandler</code>.
* Return the DataFlavors for this {@code DataContentHandler}.
* @return the DataFlavors
*/
public DataFlavor[] getTransferDataFlavors() {
@ -842,7 +842,7 @@ class ObjectDataContentHandler implements DataContentHandler {
}
/**
* Return the DataFlavors for this <code>DataContentHandler</code>.
* Return the DataFlavors for this {@code DataContentHandler}.
* @return the DataFlavors
*/
public synchronized DataFlavor[] getTransferDataFlavors() {