Skip to content

Commit

Permalink
8264779: Fix doclint warnings in java/nio
Browse files Browse the repository at this point in the history
Reviewed-by: chegar, iris, alanb, naoto
  • Loading branch information
c-cleary authored and ChrisHegarty committed Apr 9, 2021
1 parent 3e57924 commit a45733f
Show file tree
Hide file tree
Showing 9 changed files with 48 additions and 10 deletions.
5 changes: 4 additions & 1 deletion make/scripts/genExceptions.sh
@@ -1,6 +1,6 @@
#! /bin/sh
#
# Copyright (c) 2000, 2019, Oracle and/or its affiliates. All rights reserved.
# Copyright (c) 2000, 2021, 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
Expand Down Expand Up @@ -68,6 +68,9 @@ __END__

cat >>$out <<__END__
/**
* The $ARG_PHRASE.
*/
private $ARG_TYPE $ARG_ID;
/**
Expand Down
@@ -1,5 +1,5 @@
/*
* Copyright (c) 2000, 2019, Oracle and/or its affiliates. All rights reserved.
* Copyright (c) 2000, 2021, 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
Expand Down Expand Up @@ -41,6 +41,9 @@ public class MalformedInputException
@java.io.Serial
private static final long serialVersionUID = -3438823399834806194L;

/**
* The length of the input.
*/
private int inputLength;

/**
Expand Down
@@ -1,5 +1,5 @@
/*
* Copyright (c) 2001, 2019, Oracle and/or its affiliates. All rights reserved.
* Copyright (c) 2001, 2021, 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
Expand Down Expand Up @@ -41,6 +41,9 @@ public class UnmappableCharacterException
@java.io.Serial
private static final long serialVersionUID = -7026962371537706123L;

/**
* The length of the input character (or byte) sequence.
*/
private int inputLength;

/**
Expand Down
4 changes: 2 additions & 2 deletions src/java.base/share/classes/java/nio/charset/exceptions
@@ -1,5 +1,5 @@
#
# Copyright (c) 2000, 2007, Oracle and/or its affiliates. All rights reserved.
# Copyright (c) 2000, 2021, 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
Expand Down Expand Up @@ -28,7 +28,7 @@
SINCE=1.4
PACKAGE=java.nio.charset
# This year should only change if the generated source is modified.
COPYRIGHT_YEARS="2000, 2007,"
COPYRIGHT_YEARS="2000, 2021,"

SUPER=java.io.IOException

Expand Down
4 changes: 2 additions & 2 deletions src/java.base/share/classes/java/nio/exceptions
@@ -1,5 +1,5 @@
#
# Copyright (c) 2000, 2007, Oracle and/or its affiliates. All rights reserved.
# Copyright (c) 2000, 2021, 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
Expand Down Expand Up @@ -28,7 +28,7 @@
SINCE=1.4
PACKAGE=java.nio
# This year should only change if the generated source is modified.
COPYRIGHT_YEARS="2000, 2007,"
COPYRIGHT_YEARS="2000, 2021,"


SUPER=RuntimeException
Expand Down
@@ -1,5 +1,5 @@
/*
* Copyright (c) 2010, 2019, Oracle and/or its affiliates. All rights reserved.
* Copyright (c) 2010, 2021, 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
Expand Down Expand Up @@ -73,9 +73,19 @@ public IOException getCause() {
/**
* Called to read the object from a stream.
*
* @param s
* the {@code ObjectInputStream} to read
*
* @throws InvalidObjectException
* if the object is invalid or has a cause that is not
* an {@code IOException}
*
* @throws IOException
* if an I/O error occurs
*
* @throws ClassNotFoundException
* if the class of a serialized object could not be
* found
*/
@java.io.Serial
private void readObject(ObjectInputStream s)
Expand Down
@@ -1,5 +1,5 @@
/*
* Copyright (c) 2007, 2019, Oracle and/or its affiliates. All rights reserved.
* Copyright (c) 2007, 2021, 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
Expand Down Expand Up @@ -40,7 +40,15 @@ public class FileSystemException
@java.io.Serial
static final long serialVersionUID = -3055425747967319812L;

/**
* String identifying the file or {@code null} if not known.
*/
private final String file;

/**
* String identifying the other file or {@code null} if there isn't
* another file or if not known.
*/
private final String other;

/**
Expand Down
@@ -1,5 +1,5 @@
/*
* Copyright (c) 2007, 2019, Oracle and/or its affiliates. All rights reserved.
* Copyright (c) 2007, 2021, 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
Expand Down Expand Up @@ -39,7 +39,15 @@ public class InvalidPathException
@java.io.Serial
static final long serialVersionUID = 4355821422286746137L;

/**
* The input string.
*/
private String input;

/**
* The index of the input string at which the error occurred or
* {@code -1} if not known.
*/
private int index;

/**
Expand Down
Expand Up @@ -40,6 +40,9 @@ public class UserPrincipalNotFoundException
@java.io.Serial
static final long serialVersionUID = -5369283889045833024L;

/**
* The user principal name.
*/
private final String name;

/**
Expand Down

1 comment on commit a45733f

@openjdk-notifier
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please sign in to comment.