Update javadoc link URL and version number

This commit is contained in:
hedgecrw85 2018-08-08 12:44:01 -05:00
parent 76d2089756
commit 3991057187
6 changed files with 171 additions and 5 deletions

View File

@ -5,7 +5,7 @@ apply plugin: 'osgi'
group = 'com.fazecast'
archivesBaseName = 'jSerialComm'
version = '2.1.2'
version = '2.2.0'
ext.moduleName = 'com.fazecast.jSerialComm'
assert hasProperty('java6Home'): "Set the property 'java6Home' in your gradle.properties file pointing to a Java 6 JDK installation"
@ -13,7 +13,7 @@ assert hasProperty('java9Home'): "Set the property 'java9Home' in your gradle.pr
sourceCompatibility = 1.6
targetCompatibility = 1.6
javadoc.options.links("http://docs.oracle.com/javase/8/docs/api/")
javadoc.options.links("https://docs.oracle.com/javase/9/docs/api/")
javadoc.options.addBooleanOption('html4', true)
def java6ExecutablesPath = new File(java6Home, 'bin')

View File

@ -31,7 +31,7 @@ import java.util.EventListener;
* This interface must be implemented to enable simple event-based serial port I/O.
*
* @author Will Hedgecock <will.hedgecock@fazecast.com>
* @version 2.1.2
* @version 2.2.0
* @see java.util.EventListener
*/
public interface SerialPortDataListener extends EventListener

View File

@ -31,7 +31,7 @@ import java.util.EventObject;
* This class describes an asynchronous serial port event.
*
* @author Will Hedgecock <will.hedgecock@fazecast.com>
* @version 2.1.2
* @version 2.2.0
* @see java.util.EventObject
*/
public final class SerialPortEvent extends EventObject

View File

@ -0,0 +1,83 @@
/*
* SerialPortIOException.java
*
* Created on: Aug 08, 2018
* Last Updated on: Aug 08, 2018
* Author: Will Hedgecock
*
* Copyright (C) 2018-2018 Fazecast, Inc.
*
* This file is part of jSerialComm.
*
* jSerialComm is free software: you can redistribute it and/or modify
* it under the terms of either the Apache Software License, version 2, or
* the GNU Lesser General Public License as published by the Free Software
* Foundation, version 3 or above.
*
* jSerialComm is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
*
* You should have received a copy of both the GNU Lesser General Public
* License and the Apache Software License along with jSerialComm. If not,
* see <http://www.gnu.org/licenses/> and <http://www.apache.org/licenses/>.
*/
package com.fazecast.jSerialComm;
import java.io.IOException;
/**
* This class describes a serial port IO exception.
*
* @author Will Hedgecock &lt;will.hedgecock@fazecast.com&gt;
* @version 2.2.0
* @see java.util.EventObject
*/
public final class SerialPortIOException extends IOException
{
private static final long serialVersionUID = 3353684802475494674L;
/**
* Constructs a {@link SerialPortIOException} with {@code null} as its error detail message.
*/
public SerialPortIOException()
{
super();
}
/**
* Constructs a {@link SerialPortIOException} with the specified detail message.
*
* @param message The detail message (which is saved for later retrieval by the {@link getMessage()} method).
*/
public SerialPortIOException(String message)
{
super(message);
}
/**
* Constructs a {@link SerialPortIOException} with the specified detail message and cause.
* <p>
* Note that the detail message associated with {@link cause} is <i>not</i> automatically incorporated into this exception's detail message.
*
* @param message message The detail message (which is saved for later retrieval by the {@link getMessage()} method).
* @param cause The cause (which is saved for later retrieval by the {@link getCause()} method). (A null value is permitted, and indicates that the cause is nonexistent or unknown.)
*/
public SerialPortIOException(String message, Throwable cause)
{
super(message, cause);
}
/**
* Constructs a {@link SerialPortIOException} with the specified cause and a detail message of {@code (cause==null ? null : cause.toString()) }
* (which typically contains the class and detail message of {@code cause}). This constructor is useful for IO exceptions that are little more
* than wrappers for other throwables.
*
* @param cause The cause (which is saved for later retrieval by the {@link getCause()} method). (A null value is permitted, and indicates that the cause is nonexistent or unknown.)
*/
public SerialPortIOException(Throwable cause)
{
super(cause);
}
}

View File

@ -31,7 +31,7 @@ package com.fazecast.jSerialComm;
* <i>Note</i>: Using this interface will negate any serial port read timeout settings since they make no sense in an asynchronous context.
*
* @author Will Hedgecock &lt;will.hedgecock@fazecast.com&gt;
* @version 2.1.2
* @version 2.2.0
* @see com.fazecast.jSerialComm.SerialPortDataListener
* @see java.util.EventListener
*/

View File

@ -0,0 +1,83 @@
/*
* SerialPortTimeoutException.java
*
* Created on: Aug 08, 2018
* Last Updated on: Aug 08, 2018
* Author: Will Hedgecock
*
* Copyright (C) 2018-2018 Fazecast, Inc.
*
* This file is part of jSerialComm.
*
* jSerialComm is free software: you can redistribute it and/or modify
* it under the terms of either the Apache Software License, version 2, or
* the GNU Lesser General Public License as published by the Free Software
* Foundation, version 3 or above.
*
* jSerialComm is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
*
* You should have received a copy of both the GNU Lesser General Public
* License and the Apache Software License along with jSerialComm. If not,
* see <http://www.gnu.org/licenses/> and <http://www.apache.org/licenses/>.
*/
package com.fazecast.jSerialComm;
import java.io.IOException;
/**
* This class describes a serial port timeout exception.
*
* @author Will Hedgecock &lt;will.hedgecock@fazecast.com&gt;
* @version 2.2.0
* @see java.util.EventObject
*/
public final class SerialPortTimeoutException extends IOException
{
private static final long serialVersionUID = 3209035213903386044L;
/**
* Constructs a {@link SerialPortTimeoutException} with {@code null} as its error detail message.
*/
public SerialPortTimeoutException()
{
super();
}
/**
* Constructs a {@link SerialPortTimeoutException} with the specified detail message.
*
* @param message The detail message (which is saved for later retrieval by the {@link getMessage()} method).
*/
public SerialPortTimeoutException(String message)
{
super(message);
}
/**
* Constructs a {@link SerialPortTimeoutException} with the specified detail message and cause.
* <p>
* Note that the detail message associated with {@link cause} is <i>not</i> automatically incorporated into this exception's detail message.
*
* @param message message The detail message (which is saved for later retrieval by the {@link getMessage()} method).
* @param cause The cause (which is saved for later retrieval by the {@link getCause()} method). (A null value is permitted, and indicates that the cause is nonexistent or unknown.)
*/
public SerialPortTimeoutException(String message, Throwable cause)
{
super(message, cause);
}
/**
* Constructs a {@link SerialPortTimeoutException} with the specified cause and a detail message of {@code (cause==null ? null : cause.toString()) }
* (which typically contains the class and detail message of {@code cause}). This constructor is useful for IO exceptions that are little more
* than wrappers for other throwables.
*
* @param cause The cause (which is saved for later retrieval by the {@link getCause()} method). (A null value is permitted, and indicates that the cause is nonexistent or unknown.)
*/
public SerialPortTimeoutException(Throwable cause)
{
super(cause);
}
}