Skip to content
This repository was archived by the owner on Sep 7, 2018. It is now read-only.

Commit 646c88d

Browse files
bshannonbshannon
committed
Fix some javadoc errors.
1 parent 89afe16 commit 646c88d

File tree

9 files changed

+23
-13
lines changed

9 files changed

+23
-13
lines changed

‎activation/src/main/java/javax/activation/CommandInfo.java‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -130,6 +130,9 @@ public String getCommandClass() {
130130
* passed to the command.
131131
* @param loader The ClassLoader to be used to instantiate the bean.
132132
* @return The bean
133+
* @exception IOException for failures reading data
134+
* @exception ClassNotFoundException if command object class can't
135+
* be found
133136
* @see java.beans.Beans#instantiate
134137
* @see javax.activation.CommandObject
135138
*/

‎activation/src/main/java/javax/activation/CommandMap.java‎

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
/*
22
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
33
*
4-
* Copyright (c) 1997-2015 Oracle and/or its affiliates. All rights reserved.
4+
* Copyright (c) 1997-2017 Oracle and/or its affiliates. All rights reserved.
55
*
66
* The contents of this file are subject to the terms of either the GNU
77
* General Public License Version 2 only ("GPL") or the Common Development
@@ -60,7 +60,6 @@ public abstract class CommandMap {
6060

6161
/**
6262
* Get the default CommandMap.
63-
* <p>
6463
*
6564
* <ul>
6665
* <li> In cases where a CommandMap instance has been previously set

‎activation/src/main/java/javax/activation/CommandObject.java‎

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
/*
22
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
33
*
4-
* Copyright (c) 1997-2015 Oracle and/or its affiliates. All rights reserved.
4+
* Copyright (c) 1997-2017 Oracle and/or its affiliates. All rights reserved.
55
*
66
* The contents of this file are subject to the terms of either the GNU
77
* General Public License Version 2 only ("GPL") or the Common Development
@@ -49,7 +49,7 @@
4949
* data they should operate on. JavaBeans that don't implement
5050
* this interface may be used as well. Such commands may obtain
5151
* the data using the Externalizable interface, or using an
52-
* application-specific method.<p>
52+
* application-specific method.
5353
*/
5454
public interface CommandObject {
5555

@@ -61,6 +61,7 @@ public interface CommandObject {
6161
*
6262
* @param verb The Command Verb this object refers to.
6363
* @param dh The DataHandler.
64+
* @exception IOException for failures accessing data
6465
*/
6566
public void setCommandContext(String verb, DataHandler dh)
6667
throws IOException;

‎activation/src/main/java/javax/activation/DataHandler.java‎

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
/*
22
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
33
*
4-
* Copyright (c) 1997-2015 Oracle and/or its affiliates. All rights reserved.
4+
* Copyright (c) 1997-2017 Oracle and/or its affiliates. All rights reserved.
55
*
66
* The contents of this file are subject to the terms of either the GNU
77
* General Public License Version 2 only ("GPL") or the Common Development
@@ -339,6 +339,7 @@ public void writeTo(OutputStream os) throws IOException {
339339
* Otherwise, <code>null</code> is returned.
340340
*
341341
* @return the OutputStream
342+
* @exception IOException for failures creating the OutputStream
342343
*
343344
* @see javax.activation.DataSource#getOutputStream
344345
* @see javax.activation.URLDataSource

‎activation/src/main/java/javax/activation/DataSource.java‎

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
/*
22
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
33
*
4-
* Copyright (c) 1997-2015 Oracle and/or its affiliates. All rights reserved.
4+
* Copyright (c) 1997-2017 Oracle and/or its affiliates. All rights reserved.
55
*
66
* The contents of this file are subject to the terms of either the GNU
77
* General Public License Version 2 only ("GPL") or the Common Development
@@ -62,6 +62,7 @@ public interface DataSource {
6262
* positioned at the beginning of the data.
6363
*
6464
* @return an InputStream
65+
* @exception IOException for failures creating the InputStream
6566
*/
6667
public InputStream getInputStream() throws IOException;
6768

@@ -73,6 +74,7 @@ public interface DataSource {
7374
* be positioned at the location the data is to be written.
7475
*
7576
* @return an OutputStream
77+
* @exception IOException for failures creating the OutputStream
7678
*/
7779
public OutputStream getOutputStream() throws IOException;
7880

‎activation/src/main/java/javax/activation/MailcapCommandMap.java‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -59,7 +59,6 @@
5959
* system for mailcap file entries. When requests are made
6060
* to search for commands in the MailcapCommandMap, it searches
6161
* mailcap files in the following order:
62-
* <p>
6362
* <ol>
6463
* <li> Programatically added entries to the MailcapCommandMap instance.
6564
* <li> The file <code>.mailcap</code> in the user's home directory.
@@ -92,7 +91,7 @@
9291
* specifically those parameter names that begin with <code>x-java-</code>.
9392
* The MailcapCommandMap uses this signature to find
9493
* command entries for inclusion into its registries.
95-
* Parameter names with the form <code>x-java-&lt;name></code>
94+
* Parameter names with the form <code>x-java-&lt;name&gt;</code>
9695
* are read by the MailcapCommandMap as identifying a command
9796
* with the name <i>name</i>. When the <i>name</i> is <code>
9897
* content-handler</code> the MailcapCommandMap recognizes the class
@@ -117,7 +116,7 @@
117116
* following general form:<p>
118117
* <code>
119118
* # Comments begin with a '#' and continue to the end of the line.<br>
120-
* &lt;mime type>; ; &lt;parameter list><br>
119+
* &lt;mime type&gt;; ; &lt;parameter list&gt;<br>
121120
* # Where a parameter list consists of one or more parameters,<br>
122121
* # where parameters look like: x-java-view=com.sun.TextViewer<br>
123122
* # and a parameter list looks like: <br>
@@ -671,6 +670,7 @@ public synchronized String[] getMimeTypes() {
671670
* entries that specify a view command for the specified
672671
* MIME type are returned.
673672
*
673+
* @param mimeType the MIME type
674674
* @return array of native command entries
675675
* @since JAF 1.1
676676
*/

‎activation/src/main/java/javax/activation/MimeType.java‎

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
/*
22
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
33
*
4-
* Copyright (c) 1997-2015 Oracle and/or its affiliates. All rights reserved.
4+
* Copyright (c) 1997-2017 Oracle and/or its affiliates. All rights reserved.
55
*
66
* The contents of this file are subject to the terms of either the GNU
77
* General Public License Version 2 only ("GPL") or the Common Development
@@ -71,6 +71,7 @@ public MimeType() {
7171
* Constructor that builds a MimeType from a String.
7272
*
7373
* @param rawdata the MIME type string
74+
* @exception MimeTypeParseException if the MIME type can't be parsed
7475
*/
7576
public MimeType(String rawdata) throws MimeTypeParseException {
7677
parse(rawdata);
@@ -271,6 +272,7 @@ public boolean match(MimeType type) {
271272
*
272273
* @param rawdata the MIME type string to compare with
273274
* @return true if they match
275+
* @exception MimeTypeParseException if the MIME type can't be parsed
274276
*/
275277
public boolean match(String rawdata) throws MimeTypeParseException {
276278
return match(new MimeType(rawdata));

‎activation/src/main/java/javax/activation/MimeTypeParameterList.java‎

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
/*
22
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
33
*
4-
* Copyright (c) 1997-2015 Oracle and/or its affiliates. All rights reserved.
4+
* Copyright (c) 1997-2017 Oracle and/or its affiliates. All rights reserved.
55
*
66
* The contents of this file are subject to the terms of either the GNU
77
* General Public License Version 2 only ("GPL") or the Common Development
@@ -71,6 +71,7 @@ public MimeTypeParameterList() {
7171
* Constructs a new MimeTypeParameterList with the passed in data.
7272
*
7373
* @param parameterList an RFC 2045, 2046 compliant parameter list.
74+
* @exception MimeTypeParseException if the MIME type can't be parsed
7475
*/
7576
public MimeTypeParameterList(String parameterList)
7677
throws MimeTypeParseException {
@@ -84,6 +85,7 @@ public MimeTypeParameterList(String parameterList)
8485
* A routine for parsing the parameter list out of a String.
8586
*
8687
* @param parameterList an RFC 2045, 2046 compliant parameter list.
88+
* @exception MimeTypeParseException if the MIME type can't be parsed
8789
*/
8890
protected void parse(String parameterList) throws MimeTypeParseException {
8991
if (parameterList == null)

‎activation/src/main/java/javax/activation/MimetypesFileTypeMap.java‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -55,7 +55,6 @@
5555
* system for MIME types file entries. When requests are made
5656
* to search for MIME types in the MimetypesFileTypeMap, it searches
5757
* MIME types files in the following order:
58-
* <p>
5958
* <ol>
6059
* <li> Programmatically added entries to the MimetypesFileTypeMap instance.
6160
* <li> The file <code>.mime.types</code> in the user's home directory.
@@ -74,7 +73,7 @@
7473
*
7574
* <code>
7675
* # comments begin with a '#'<br>
77-
* # the format is &lt;mime type> &lt;space separated file extensions><br>
76+
* # the format is &lt;mime type&gt; &lt;space separated file extensions&gt;<br>
7877
* # for example:<br>
7978
* text/plain txt text TXT<br>
8079
* # this would map file.txt, file.text, and file.TXT to<br>
@@ -274,6 +273,7 @@ private MimeTypeFile loadFile(String name) {
274273
* added from the named file.
275274
*
276275
* @param mimeTypeFileName the file name
276+
* @exception IOException for errors reading the file
277277
*/
278278
public MimetypesFileTypeMap(String mimeTypeFileName) throws IOException {
279279
this();

0 commit comments

Comments
 (0)