# HG changeset patch # User darcy # Date 1374345579 25200 # Node ID d068b8fff162ad09f0b0a8bc1ef8fd39e46152fa # Parent 13013b301bd03ac786a59d38d8cfc4fcc2c07516 8020971: Fix doclint issues in java.nio.* Reviewed-by: lancea diff -r 13013b301bd0 -r d068b8fff162 jdk/src/share/classes/java/nio/channels/package-info.java --- a/jdk/src/share/classes/java/nio/channels/package-info.java Fri Jul 19 09:42:58 2013 -0700 +++ b/jdk/src/share/classes/java/nio/channels/package-info.java Sat Jul 20 11:39:39 2013 -0700 @@ -1,5 +1,5 @@ /* - * Copyright (c) 2001, 2010, Oracle and/or its affiliates. All rights reserved. + * Copyright (c) 2001, 2013, Oracle and/or its affiliates. All rights reserved. * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. * * This code is free software; you can redistribute it and/or modify it @@ -31,7 +31,7 @@ * * *
- * + * * * * @@ -110,7 +110,7 @@ * write them to a given writable byte channel. * *

Channels

Description

ChannelsDescription
{@link java.nio.channels.Channel}A nexus for I/O operations
  {@link java.nio.channels.ReadableByteChannel}
- * + * * * * @@ -138,7 +138,7 @@ * * *

File channels

Description

File channelsDescription
{@link java.nio.channels.FileChannel}Reads, writes, maps, and manipulates files
{@link java.nio.channels.FileLock}
- * + * * * * @@ -225,7 +225,7 @@ * * *

Multiplexed, non-blocking I/O

Description

Multiplexed, non-blocking I/O

Description

{@link java.nio.channels.SelectableChannel}A channel that can be multiplexed
  {@link java.nio.channels.DatagramChannel}
- * + * * * * diff -r 13013b301bd0 -r d068b8fff162 jdk/src/share/classes/java/nio/charset/Charset.java --- a/jdk/src/share/classes/java/nio/charset/Charset.java Fri Jul 19 09:42:58 2013 -0700 +++ b/jdk/src/share/classes/java/nio/charset/Charset.java Sat Jul 20 11:39:39 2013 -0700 @@ -1,5 +1,5 @@ /* - * Copyright (c) 2000, 2011, Oracle and/or its affiliates. All rights reserved. + * Copyright (c) 2000, 2013, Oracle and/or its affiliates. All rights reserved. * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. * * This code is free software; you can redistribute it and/or modify it @@ -65,7 +65,7 @@ * concurrent threads. * * - * + * *

Charset names

* *

Charsets are named by strings composed of the following characters: @@ -111,21 +111,17 @@ * The aliases of a charset are returned by the {@link #aliases() aliases} * method. * - * - * - *

Some charsets have an historical name that is defined for - * compatibility with previous versions of the Java platform. A charset's + *

Some charsets have an historical name that is defined for + * compatibility with previous versions of the Java platform. A charset's * historical name is either its canonical name or one of its aliases. The * historical name is returned by the getEncoding() methods of the * {@link java.io.InputStreamReader#getEncoding InputStreamReader} and {@link * java.io.OutputStreamWriter#getEncoding OutputStreamWriter} classes. * - * - * - *

If a charset listed in the If a charset listed in the IANA Charset * Registry is supported by an implementation of the Java platform then - * its canonical name must be the name listed in the registry. Many charsets + * its canonical name must be the name listed in the registry. Many charsets * are given more than one name in the registry, in which case the registry * identifies one of the names as MIME-preferred. If a charset has more * than one registry name then its canonical name must be the MIME-preferred @@ -142,15 +138,15 @@ * *

Standard charsets

* - * + * * - *

Every implementation of the Java platform is required to support the - * following standard charsets. Consult the release documentation for your + *

Every implementation of the Java platform is required to support the + * following standard charsets. Consult the release documentation for your * implementation to see if any other charsets are supported. The behavior * of such optional charsets may differ between implementations. * *

Asynchronous I/O

Description

Asynchronous I/ODescription
{@link java.nio.channels.AsynchronousFileChannel}An asynchronous channel for reading, writing, and manipulating a file
{@link java.nio.channels.AsynchronousSocketChannel}
- * + * * * diff -r 13013b301bd0 -r d068b8fff162 jdk/src/share/classes/java/nio/charset/MalformedInputException.java --- a/jdk/src/share/classes/java/nio/charset/MalformedInputException.java Fri Jul 19 09:42:58 2013 -0700 +++ b/jdk/src/share/classes/java/nio/charset/MalformedInputException.java Sat Jul 20 11:39:39 2013 -0700 @@ -1,5 +1,5 @@ /* - * Copyright (c) 2000, 2007, Oracle and/or its affiliates. All rights reserved. + * Copyright (c) 2000, 2013, Oracle and/or its affiliates. All rights reserved. * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. * * This code is free software; you can redistribute it and/or modify it @@ -42,14 +42,27 @@ private int inputLength; + /** + * Constructs an {@code MalformedInputException} with the given + * length. + * @param inputLength the length of the input + */ public MalformedInputException(int inputLength) { this.inputLength = inputLength; } + /** + * Returns the length of the input. + * @return the length of the input + */ public int getInputLength() { return inputLength; } + /** + * Returns the message. + * @return the message + */ public String getMessage() { return "Input length = " + inputLength; } diff -r 13013b301bd0 -r d068b8fff162 jdk/src/share/classes/java/nio/charset/UnmappableCharacterException.java --- a/jdk/src/share/classes/java/nio/charset/UnmappableCharacterException.java Fri Jul 19 09:42:58 2013 -0700 +++ b/jdk/src/share/classes/java/nio/charset/UnmappableCharacterException.java Sat Jul 20 11:39:39 2013 -0700 @@ -1,5 +1,5 @@ /* - * Copyright (c) 2001, 2007, Oracle and/or its affiliates. All rights reserved. + * Copyright (c) 2001, 2013, Oracle and/or its affiliates. All rights reserved. * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. * * This code is free software; you can redistribute it and/or modify it @@ -42,14 +42,27 @@ private int inputLength; + /** + * Constructs an {@code UnmappableCharacterException} with the + * given length. + * @param inputLength the length of the input + */ public UnmappableCharacterException(int inputLength) { this.inputLength = inputLength; } + /** + * Returns the length of the input. + * @return the length of the input + */ public int getInputLength() { return inputLength; } + /** + * Returns the message. + * @return the message + */ public String getMessage() { return "Input length = " + inputLength; } diff -r 13013b301bd0 -r d068b8fff162 jdk/src/share/classes/java/nio/file/package-info.java --- a/jdk/src/share/classes/java/nio/file/package-info.java Fri Jul 19 09:42:58 2013 -0700 +++ b/jdk/src/share/classes/java/nio/file/package-info.java Sat Jul 20 11:39:39 2013 -0700 @@ -1,5 +1,5 @@ /* - * Copyright (c) 2007, 2011, Oracle and/or its affiliates. All rights reserved. + * Copyright (c) 2007, 2013, Oracle and/or its affiliates. All rights reserved. * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. * * This code is free software; you can redistribute it and/or modify it @@ -33,8 +33,8 @@ * package is used by service provider implementors wishing to extend the * platform default provider, or to construct other provider implementations.

* - *

Symbolic Links

- * Many operating systems and file systems support for symbolic links. + *

Symbolic Links

+ *

Many operating systems and file systems support for symbolic links. * A symbolic link is a special file that serves as a reference to another file. * For the most part, symbolic links are transparent to applications and * operations on symbolic links are automatically redirected to the target @@ -45,8 +45,8 @@ * that are semantically close but support for these other types of links is * not included in this package.

* - *

Interoperability

- * The {@link java.io.File} class defines the {@link java.io.File#toPath + *

Interoperability

+ *

The {@link java.io.File} class defines the {@link java.io.File#toPath * toPath} method to construct a {@link java.nio.file.Path} by converting * the abstract path represented by the {@code java.io.File} object. The resulting * {@code Path} can be used to operate on the same file as the {@code File} @@ -55,7 +55,7 @@ * and {@code java.io.File} objects.

* *

Visibility

- * The view of the files and file system provided by classes in this package are + *

The view of the files and file system provided by classes in this package are * guaranteed to be consistent with other views provided by other instances in the * same Java virtual machine. The view may or may not, however, be consistent with * the view of the file system as seen by other concurrently running programs due @@ -65,8 +65,8 @@ * or on some other machine. The exact nature of any such inconsistencies are * system-dependent and are therefore unspecified.

* - *

Synchronized I/O File Integrity

- * The {@link java.nio.file.StandardOpenOption#SYNC SYNC} and {@link + *

Synchronized I/O File Integrity

+ *

The {@link java.nio.file.StandardOpenOption#SYNC SYNC} and {@link * java.nio.file.StandardOpenOption#DSYNC DSYNC} options are used when opening a file * to require that updates to the file are written synchronously to the underlying * storage device. In the case of the default provider, and the file resides on @@ -83,7 +83,7 @@ * specific.

* *

General Exceptions

- * Unless otherwise noted, passing a {@code null} argument to a constructor + *

Unless otherwise noted, passing a {@code null} argument to a constructor * or method of any class or interface in this package will cause a {@link * java.lang.NullPointerException NullPointerException} to be thrown. Additionally, * invoking a method with a collection containing a {@code null} element will

Charset

Description

CharsetDescription
US-ASCIISeven-bit ASCII, a.k.a. ISO646-US, * a.k.a. the Basic Latin block of the Unicode character set