Cleaning up Javadoc warnings and errors; removed "createDirectory()"

method that maybe was part of the interface but no longer is (was
replaced by createDirectory(name) which remains).
This commit is contained in:
Rob Greene 2018-03-09 22:49:40 -06:00
parent 59bd38fcac
commit 41ac815c42
11 changed files with 11 additions and 61 deletions

View File

@ -880,7 +880,7 @@ public class Disk {
/** /**
* Find the standard sized disk that will fit the requested number of bytes. * Find the standard sized disk that will fit the requested number of bytes.
* @returns int size of the disk if it will satisfy the request, -1 otherwise * @return int size of the disk if it will satisfy the request, -1 otherwise
*/ */
public static int sizeToFit(long bytes) { public static int sizeToFit(long bytes) {
if (bytes < APPLE_140KB_DISK) { if (bytes < APPLE_140KB_DISK) {

View File

@ -531,18 +531,10 @@ public class CpmFormatDisk extends FormattedDisk {
public void setFileData(FileEntry fileEntry, byte[] fileData) throws DiskFullException { public void setFileData(FileEntry fileEntry, byte[] fileData) throws DiskFullException {
// TODO implement setFileData // TODO implement setFileData
} }
/**
* Create a new DirectoryEntry.
* @see com.webcodepro.applecommander.storage.DirectoryEntry#createDirectory()
*/
public DirectoryEntry createDirectory() throws DiskFullException {
throw new UnsupportedOperationException(textBundle.get("DirectoryCreationNotSupported")); //$NON-NLS-1$
}
/** /**
* Create a new DirectoryEntry. * Create a new DirectoryEntry.
* @see com.webcodepro.applecommander.storage.DirectoryEntry#createDirectory() * @see com.webcodepro.applecommander.storage.DirectoryEntry#createDirectory(String)
*/ */
public DirectoryEntry createDirectory(String name) throws DiskFullException { public DirectoryEntry createDirectory(String name) throws DiskFullException {
throw new UnsupportedOperationException(textBundle.get("DirectoryCreationNotSupported")); //$NON-NLS-1$ throw new UnsupportedOperationException(textBundle.get("DirectoryCreationNotSupported")); //$NON-NLS-1$

View File

@ -758,15 +758,7 @@ public class DosFormatDisk extends FormattedDisk {
/** /**
* Create a new DirectoryEntry. * Create a new DirectoryEntry.
* @see com.webcodepro.applecommander.storage.DirectoryEntry#createDirectory() * @see com.webcodepro.applecommander.storage.DirectoryEntry#createDirectory(String)
*/
public DirectoryEntry createDirectory() throws DiskFullException {
throw new UnsupportedOperationException(textBundle.get("DirectoryCreationNotSupported")); //$NON-NLS-1$
}
/**
* Create a new DirectoryEntry.
* @see com.webcodepro.applecommander.storage.DirectoryEntry#createDirectory()
*/ */
public DirectoryEntry createDirectory(String name) throws DiskFullException { public DirectoryEntry createDirectory(String name) throws DiskFullException {
throw new UnsupportedOperationException(textBundle.get("DirectoryCreationNotSupported")); //$NON-NLS-1$ throw new UnsupportedOperationException(textBundle.get("DirectoryCreationNotSupported")); //$NON-NLS-1$

View File

@ -713,15 +713,7 @@ public class GutenbergFormatDisk extends FormattedDisk {
/** /**
* Create a new DirectoryEntry. * Create a new DirectoryEntry.
* @see com.webcodepro.applecommander.storage.DirectoryEntry#createDirectory() * @see com.webcodepro.applecommander.storage.DirectoryEntry#createDirectory(String)
*/
public DirectoryEntry createDirectory() throws DiskFullException {
throw new UnsupportedOperationException(textBundle.get("DirectoryCreationNotSupported")); //$NON-NLS-1$
}
/**
* Create a new DirectoryEntry.
* @see com.webcodepro.applecommander.storage.DirectoryEntry#createDirectory()
*/ */
public DirectoryEntry createDirectory(String name) throws DiskFullException { public DirectoryEntry createDirectory(String name) throws DiskFullException {
throw new UnsupportedOperationException(textBundle.get("DirectoryCreationNotSupported")); //$NON-NLS-1$ throw new UnsupportedOperationException(textBundle.get("DirectoryCreationNotSupported")); //$NON-NLS-1$

View File

@ -527,15 +527,7 @@ public class NakedosFormatDisk extends FormattedDisk {
/** /**
* Create a new DirectoryEntry. * Create a new DirectoryEntry.
* @see com.webcodepro.applecommander.storage.DirectoryEntry#createDirectory() * @see com.webcodepro.applecommander.storage.DirectoryEntry#createDirectory(String)
*/
public DirectoryEntry createDirectory() throws DiskFullException {
throw new UnsupportedOperationException(textBundle.get("DirectoryCreationNotSupported")); //$NON-NLS-1$
}
/**
* Create a new DirectoryEntry.
* @see com.webcodepro.applecommander.storage.DirectoryEntry#createDirectory()
*/ */
public DirectoryEntry createDirectory(String name) throws DiskFullException { public DirectoryEntry createDirectory(String name) throws DiskFullException {
throw new UnsupportedOperationException(textBundle.get("DirectoryCreationNotSupported")); //$NON-NLS-1$ throw new UnsupportedOperationException(textBundle.get("DirectoryCreationNotSupported")); //$NON-NLS-1$

View File

@ -661,15 +661,7 @@ public class PascalFormatDisk extends FormattedDisk {
/** /**
* Create a new DirectoryEntry. * Create a new DirectoryEntry.
* @see com.webcodepro.applecommander.storage.DirectoryEntry#createDirectory() * @see com.webcodepro.applecommander.storage.DirectoryEntry#createDirectory(String)
*/
public DirectoryEntry createDirectory() throws DiskFullException {
throw new UnsupportedOperationException(textBundle.get("DirectoryCreationNotSupported")); //$NON-NLS-1$
}
/**
* Create a new DirectoryEntry.
* @see com.webcodepro.applecommander.storage.DirectoryEntry#createDirectory()
*/ */
public DirectoryEntry createDirectory(String name) throws DiskFullException { public DirectoryEntry createDirectory(String name) throws DiskFullException {
throw new UnsupportedOperationException(textBundle.get("DirectoryCreationNotSupported")); //$NON-NLS-1$ throw new UnsupportedOperationException(textBundle.get("DirectoryCreationNotSupported")); //$NON-NLS-1$

View File

@ -98,7 +98,7 @@ public class ProdosDirectoryEntry extends ProdosFileEntry implements DirectoryEn
/** /**
* Create a new DirectoryEntry. * Create a new DirectoryEntry.
* @see com.webcodepro.applecommander.storage.DirectoryEntry#createDirectory() * @see com.webcodepro.applecommander.storage.DirectoryEntry#createDirectory(String)
*/ */
public DirectoryEntry createDirectory(String name) throws DiskFullException { public DirectoryEntry createDirectory(String name) throws DiskFullException {
return getDisk().createDirectory(getSubdirectoryHeader(), name); return getDisk().createDirectory(getSubdirectoryHeader(), name);

View File

@ -1343,7 +1343,7 @@ public class ProdosFormatDisk extends FormattedDisk {
/** /**
* Create a new DirectoryEntry. * Create a new DirectoryEntry.
* @see com.webcodepro.applecommander.storage.DirectoryEntry#createDirectory() * @see com.webcodepro.applecommander.storage.DirectoryEntry#createDirectory(String)
*/ */
public DirectoryEntry createDirectory(String name) throws DiskFullException { public DirectoryEntry createDirectory(String name) throws DiskFullException {
return createDirectory(getVolumeHeader(), name); return createDirectory(getVolumeHeader(), name);
@ -1351,7 +1351,6 @@ public class ProdosFormatDisk extends FormattedDisk {
/** /**
* Create a new DirectoryEntry. * Create a new DirectoryEntry.
* @see com.webcodepro.applecommander.storage.DirectoryEntry#createDirectory()
*/ */
public DirectoryEntry createDirectory(ProdosCommonDirectoryHeader directory, String name) throws DiskFullException { public DirectoryEntry createDirectory(ProdosCommonDirectoryHeader directory, String name) throws DiskFullException {
int blockNumber = directory.getFileEntryBlock(); int blockNumber = directory.getFileEntryBlock();

View File

@ -504,15 +504,7 @@ public class RdosFormatDisk extends FormattedDisk {
/** /**
* Create a new DirectoryEntry. * Create a new DirectoryEntry.
* @see com.webcodepro.applecommander.storage.DirectoryEntry#createDirectory() * @see com.webcodepro.applecommander.storage.DirectoryEntry#createDirectory(String)
*/
public DirectoryEntry createDirectory() throws DiskFullException {
throw new UnsupportedOperationException(textBundle.get("DirectoryCreationNotSupported")); //$NON-NLS-1$
}
/**
* Create a new DirectoryEntry.
* @see com.webcodepro.applecommander.storage.DirectoryEntry#createDirectory()
*/ */
public DirectoryEntry createDirectory(String name) throws DiskFullException { public DirectoryEntry createDirectory(String name) throws DiskFullException {
throw new UnsupportedOperationException(textBundle.get("DirectoryCreationNotSupported")); //$NON-NLS-1$ throw new UnsupportedOperationException(textBundle.get("DirectoryCreationNotSupported")); //$NON-NLS-1$

View File

@ -12,7 +12,7 @@ import java.nio.file.Paths;
* Support reading of data from and AppleSingle source. * Support reading of data from and AppleSingle source.
* Does not implement all components at this time, extend as required. * Does not implement all components at this time, extend as required.
* *
* @see https://github.com/AppleCommander/AppleCommander/issues/20 * @see <a href="https://github.com/AppleCommander/AppleCommander/issues/20">AppleCommander issue #20</a>
*/ */
public class AppleSingle { public class AppleSingle {
public static final int MAGIC_NUMBER = 0x0051600; public static final int MAGIC_NUMBER = 0x0051600;

View File

@ -25,7 +25,6 @@ import java.io.IOException;
import java.io.InputStream; import java.io.InputStream;
import com.webcodepro.applecommander.storage.Disk; import com.webcodepro.applecommander.storage.Disk;
import com.webcodepro.applecommander.storage.FileEntry;
import com.webcodepro.applecommander.storage.FormattedDisk; import com.webcodepro.applecommander.storage.FormattedDisk;
import com.webcodepro.applecommander.storage.StorageBundle; import com.webcodepro.applecommander.storage.StorageBundle;
import com.webcodepro.applecommander.storage.os.prodos.ProdosFileEntry; import com.webcodepro.applecommander.storage.os.prodos.ProdosFileEntry;
@ -184,7 +183,7 @@ public class ShrinkItUtilities
* *
* Reads the data from a thread * Reads the data from a thread
* *
* @returns byte[] buffer, possibly null * @return byte[] buffer, possibly null
*/ */
public static byte[] readThread(ThreadRecord thread) throws IOException public static byte[] readThread(ThreadRecord thread) throws IOException
{ {