Skip to content

GitLab

I
Icy
Commit 0fd9147f authored by Kitwaii's avatar Kitwaii
Browse files
Options

Updated Javadoc

parent a159e587
Hide whitespace changes
Inline Side-by-side
Showing with 65 additions and 65 deletions
src/main/java/icy/system/FileDrop.java
View file @ 0fd9147f
......@@ -48,12 +48,12 @@ import javax.swing.border.Border;
/**
* <p>
* This class makes it easy to drag and drop files from the operating
* system to a Java program. Any <tt>Component</tt> can be
* dropped onto, but only <tt>JComponent</tt>s will indicate
* system to a Java program. Any <i>Component</i> can be
* dropped onto, but only <i>JComponent</i>s will indicate
* the drop event with a changed
* </p>
* <p>To use this class, construct a new <tt>FileDrop</tt> by passing it the target component and a
* <tt>Listener</tt> to receive notification when file(s) have been dropped. Here is an example:
* <p>To use this class, construct a new <i>FileDrop</i> by passing it the target component and a
* <i>Listener</i> to receive notification when file(s) have been dropped. Here is an example:
* </p>
* <code>
* JPanel myPanel = new JPanel();
......@@ -67,10 +67,10 @@ import javax.swing.border.Border;
* </code>
* <p>
* You can specify the border that will appear when files are being dragged by calling the
* constructor with a <tt>Border</tt>. Only <tt>JComponent</tt>s will show any indication with a
* constructor with a <i>Border</i>. Only <i>JComponent</i>s will show any indication with a
* </p>
* <p>You can turn on some debugging features by passing a <tt>PrintStream</tt> object (such as
* <tt>System.out</tt>) into the full constructor. A <tt>null</tt> value will result in no extra
* <p>You can turn on some debugging features by passing a <i>PrintStream</i> object (such as
* <i>System.out</i>) into the full constructor. A <i>null</i> value will result in no extra
* debugging information being output.
* </p>
* <p>
......@@ -95,7 +95,7 @@ public class FileDrop
{
/**
* The MIME type for {@link #DATA_FLAVOR} is
* <tt>application/x-net.iharder.TransferableObject</tt>.
* <i>application/x-net.iharder.TransferableObject</i>.
*
* @since 1.1
*/
......@@ -103,8 +103,8 @@ public class FileDrop
/**
* The default {@link DataFlavor} for {@link TransferableObject} has
* the representation class <tt>net.iharder.TransferableObject.class</tt> and the MIME
* type <tt>application/x-net.iharder.TransferableObject</tt>.
* the representation class <i>net.iharder.TransferableObject.class</i> and the MIME
* type <i>application/x-net.iharder.TransferableObject</i>.
*
* @since 1.1
*/
......@@ -120,7 +120,7 @@ public class FileDrop
* Along with the {@link #DATA_FLAVOR} associated with this class,
* this creates a custom data flavor with a representation class
* determined from <code>data.getClass()</code> and the MIME type
* <tt>application/x-net.iharder.TransferableObject</tt>.
* <i>application/x-net.iharder.TransferableObject</i>.
*
* @param data
* The data to transfer
......@@ -152,7 +152,7 @@ public class FileDrop
* object that is returned by <var>fetcher</var>.
* Along with the {@link #DATA_FLAVOR} associated with this class,
* this creates a custom data flavor with a representation class <var>dataClass</var>
* and the MIME type <tt>application/x-net.iharder.TransferableObject</tt>.
* and the MIME type <i>application/x-net.iharder.TransferableObject</i>.
*
* @see Fetcher
* @param dataClass
......@@ -169,7 +169,7 @@ public class FileDrop
/**
* Returns the custom {@link DataFlavor} associated
* with the encapsulated object or <tt>null</tt> if the {@link Fetcher} constructor was used
* with the encapsulated object or <i>null</i> if the {@link Fetcher} constructor was used
* without passing a {@link Class}.
*
* @return The custom data flavor for the encapsulated object
......@@ -228,7 +228,7 @@ public class FileDrop
} // end getTransferData
/**
* Returns <tt>true</tt> if <var>flavor</var> is one of the supported
* Returns <i>true</i> if <var>flavor</var> is one of the supported
* flavors. Flavors are supported using the <code>equals(...)</code> method.
*
* @param flavor
......@@ -286,15 +286,15 @@ public class FileDrop
/**
* Constructor with a default border and debugging optionally turned on.
* With Debugging turned on, more status messages will be displayed to <tt>out</tt>. A common
* way to use this constructor is with <tt>System.out</tt> or <tt>System.err</tt>. A
* <tt>null</tt> value for
* the parameter <tt>out</tt> will result in no debugging output.
* With Debugging turned on, more status messages will be displayed to <i>out</i>. A common
* way to use this constructor is with <i>System.out</i> or <i>System.err</i>. A
* <i>null</i> value for
* the parameter <i>out</i> will result in no debugging output.
*
* @param c
* Component on which files will be dropped.
* @param listener
* Listens for <tt>filesDropped</tt>.
* Listens for <i>filesDropped</i>.
* @since 1.0
*/
public FileDrop(final Component c, final FileDropListener listener)
......@@ -305,19 +305,19 @@ public class FileDrop
/**
* Constructor with a default border, debugging optionally turned on
* and the option to recursively set drop targets.
* If your component is a <tt>Container</tt>, then each of its children
* If your component is a <i>Container</i>, then each of its children
* components will also listen for drops, though only the parent will change borders.
* With Debugging turned on, more status messages will be displayed to <tt>out</tt>. A common
* way to use this constructor is with <tt>System.out</tt> or <tt>System.err</tt>. A
* <tt>null</tt> value for
* the parameter <tt>out</tt> will result in no debugging output.
* With Debugging turned on, more status messages will be displayed to <i>out</i>. A common
* way to use this constructor is with <i>System.out</i> or <i>System.err</i>. A
* <i>null</i> value for
* the parameter <i>out</i> will result in no debugging output.
*
* @param c
* Component on which files will be dropped.
* @param recursive
* Recursively set children as drop targets.
* @param listener
* Listens for <tt>filesDropped</tt>.
* Listens for <i>filesDropped</i>.
* @since 1.0
*/
public FileDrop(final Component c, final boolean recursive, final FileDropListener listener)
......@@ -331,9 +331,9 @@ public class FileDrop
* @param c
* Component on which files will be dropped.
* @param dragBorder
* Border to use on <tt>JComponent</tt> when dragging occurs.
* Border to use on <i>JComponent</i> when dragging occurs.
* @param listener
* Listens for <tt>filesDropped</tt>.
* Listens for <i>filesDropped</i>.
* @since 1.0
*/
public FileDrop(final Component c, final Border dragBorder, final FileDropListener listener)
......@@ -343,17 +343,17 @@ public class FileDrop
/**
* Constructor with a specified border and the option to recursively set drop targets.
* If your component is a <tt>Container</tt>, then each of its children
* If your component is a <i>Container</i>, then each of its children
* components will also listen for drops, though only the parent will change borders.
*
* @param c
* Component on which files will be dropped.
* @param dragBorder
* Border to use on <tt>JComponent</tt> when dragging occurs.
* Border to use on <i>JComponent</i> when dragging occurs.
* @param recursive
* Recursively set children as drop targets.
* @param listener
* Listens for <tt>filesDropped</tt>.
* Listens for <i>filesDropped</i>.
* @since 1.0
*/
public FileDrop(final Component c, final Border dragBorder, final boolean recursive, final FileDropListener listener)
......@@ -363,17 +363,17 @@ public class FileDrop
/**
* Constructor with a specified border and the option to recursively set drop targets.
* If your component is a <tt>Container</tt>, then each of its children
* If your component is a <i>Container</i>, then each of its children
* components will also listen for drops, though only the parent will change borders.
*
* @param c
* Component on which files will be dropped.
* @param dragBorder
* Border to use on <tt>JComponent</tt> when dragging occurs.
* Border to use on <i>JComponent</i> when dragging occurs.
* @param recursive
* Recursively set children as drop targets.
* @param listener
* Listens for <tt>filesDropped</tt>.
* Listens for <i>filesDropped</i>.
* @since 1.0
*/
public FileDrop(final Component c, final Border dragBorder, final boolean recursive,
......@@ -384,21 +384,21 @@ public class FileDrop
/**
* Full constructor with a specified border and debugging optionally turned on.
* With Debugging turned on, more status messages will be displayed to <tt>out</tt>. A common
* way to use this constructor is with <tt>System.out</tt> or <tt>System.err</tt>. A
* <tt>null</tt> value for
* the parameter <tt>out</tt> will result in no debugging output.
* With Debugging turned on, more status messages will be displayed to <i>out</i>. A common
* way to use this constructor is with <i>System.out</i> or <i>System.err</i>. A
* <i>null</i> value for
* the parameter <i>out</i> will result in no debugging output.
*
* @param out
* PrintStream to record debugging info or null for no debugging.
* @param c
* Component on which files will be dropped.
* @param dragBorder
* Border to use on <tt>JComponent</tt> when dragging occurs.
* Border to use on <i>JComponent</i> when dragging occurs.
* @param recursive
* Recursively set children as drop targets.
* @param listener
* Listens for <tt>filesDropped</tt>.
* Listens for <i>filesDropped</i>.
* @since 1.0
*/
FileDrop(final Component c, final Border dragBorder, final boolean recursive, final FileDropListener listener,
......@@ -732,7 +732,7 @@ public class FileDrop
* This method is called when files have been successfully dropped.
*
* @param files
* An array of <tt>File</tt>s that were dropped.
* An array of <i>File</i>s that were dropped.
* @since 1.0
*/
public abstract void filesDropped(File[] files);
......@@ -760,7 +760,7 @@ public class FileDrop
* @param evt
* The DropTargetDropEvent which initiated the drop operation.
* @param files
* An array of <tt>File</tt>s that were dropped.
* An array of <i>File</i>s that were dropped.
* @since 2.0
*/
public abstract void filesDropped(DropTargetDropEvent evt, File[] files);
......
src/main/java/icy/system/thread/InstanceProcessor.java
View file @ 0fd9147f
......@@ -58,7 +58,7 @@ public class InstanceProcessor extends Processor
/**
* Try to submit the specified task for execution and returns a Future representing that task.<br>
* The Future's <tt>get</tt> method will return <tt>null</tt> upon <em>successful</em>
* The Future's <i>get</i> method will return <i>null</i> upon <em>successful</em>
* completion.<br>
* Returns a <code>null</code> Future object if processor has already this task pending in queue
* (in this case the new task is simply ignored)..
......
src/main/java/icy/system/thread/Processor.java
View file @ 0fd9147f
......@@ -460,8 +460,8 @@ public class Processor extends ThreadPoolExecutor
* @param value
* the default value for the returned future
* @param <T> generic Object
* @return a <tt>RunnableFuture</tt> which when run will run the underlying runnable and which,
* as a <tt>Future</tt>, will yield the given value as its result and provide for
* @return a <i>RunnableFuture</i> which when run will run the underlying runnable and which,
* as a <i>Future</i>, will yield the given value as its result and provide for
* cancellation of the underlying task.
*/
protected <T> FutureTaskAdapter<T> newTaskFor(boolean handledException, Runnable runnable, T value)
......@@ -476,8 +476,8 @@ public class Processor extends ThreadPoolExecutor
* @param callable
* the callable task being wrapped
* @param <T> generic Object
* @return a <tt>RunnableFuture</tt> which when run will call the
* underlying callable and which, as a <tt>Future</tt>, will yield
* @return a <i>RunnableFuture</i> which when run will call the
* underlying callable and which, as a <i>Future</i>, will yield
* the callable's result as its result and provide for
* cancellation of the underlying task.
*/
......@@ -535,8 +535,8 @@ public class Processor extends ThreadPoolExecutor
/**
* Submits a Runnable task for execution and returns a Future
* representing that task. The Future's <tt>get</tt> method will
* return <tt>null</tt> upon <em>successful</em> completion.
* representing that task. The Future's <i>get</i> method will
* return <i>null</i> upon <em>successful</em> completion.
*
* @param handleException
* if set to <code>true</code> then any occurring exception during the runnable
......@@ -560,7 +560,7 @@ public class Processor extends ThreadPoolExecutor
/**
* Submits a Runnable task for execution and returns a Future
* representing that task. The Future's <tt>get</tt> method will
* representing that task. The Future's <i>get</i> method will
* return the given result upon successful completion.
*
* @param handleException
......@@ -589,11 +589,11 @@ public class Processor extends ThreadPoolExecutor
/**
* Submits a value-returning task for execution and returns a
* Future representing the pending results of the task. The
* Future's <tt>get</tt> method will return the task's result upon
* Future's <i>get</i> method will return the task's result upon
* successful completion.
* <p>
* If you would like to immediately block waiting for a task, you can use constructions of the form
* <tt>result = exec.submit(aCallable).get();</tt>
* <i>result = exec.submit(aCallable).get();</i>
* <p>
* Note: The {@link Executors} class includes a set of methods that can convert some other common closure-like
* objects, for example, {@link java.security.PrivilegedAction} to {@link Callable} form so they can be submitted.
......@@ -848,7 +848,7 @@ public class Processor extends ThreadPoolExecutor
/**
* @param task running task
* @return Return the number of task waiting in queue for the specified <tt>Runnable</tt> instance.
* @return Return the number of task waiting in queue for the specified <i>Runnable</i> instance.
*/
public int getWaitingTasksCount(Runnable task)
{
......@@ -863,7 +863,7 @@ public class Processor extends ThreadPoolExecutor
/**
* @param task running task
* @return Return the number of task waiting in queue for the specified <tt>Callable</tt> instance.
* @return Return the number of task waiting in queue for the specified <i>Callable</i> instance.
*/
public int getWaitingTasksCount(Callable<?> task)
{
......@@ -898,7 +898,7 @@ public class Processor extends ThreadPoolExecutor
/**
* @param task running task
* @return Return true if we have at least one task in queue for the specified <tt>Runnable</tt> instance.
* @return Return true if we have at least one task in queue for the specified <i>Runnable</i> instance.
*/
public boolean hasWaitingTasks(Runnable task)
{
......@@ -912,7 +912,7 @@ public class Processor extends ThreadPoolExecutor
/**
* @param task called task
* @return Return true if we have at least one task in queue for the specified <tt>Callable</tt> instance.
* @return Return true if we have at least one task in queue for the specified <i>Callable</i> instance.
*/
public boolean hasWaitingTasks(Callable<?> task)
{
......@@ -938,7 +938,7 @@ public class Processor extends ThreadPoolExecutor
/**
* @param task running task
* @return Remove first waiting task for the specified <tt>FutureTaskAdapter</tt> instance.
* @return Remove first waiting task for the specified <i>FutureTaskAdapter</i> instance.
*/
protected boolean removeFirstWaitingTask(FutureTaskAdapter<?> task)
{
......@@ -958,7 +958,7 @@ public class Processor extends ThreadPoolExecutor
/**
* @param task running task
* @return Remove first waiting task for the specified <tt>Runnable</tt> instance.
* @return Remove first waiting task for the specified <i>Runnable</i> instance.
*/
public boolean removeFirstWaitingTask(Runnable task)
{
......@@ -978,7 +978,7 @@ public class Processor extends ThreadPoolExecutor
/**
* @param task called task
* @return Remove first waiting task for the specified <tt>Callable</tt> instance.
* @return Remove first waiting task for the specified <i>Callable</i> instance.
*/
public boolean removeFirstWaitingTask(Callable<?> task)
{
......@@ -1010,7 +1010,7 @@ public class Processor extends ThreadPoolExecutor
/**
* @param task running task
* @return Remove all waiting tasks for the specified <tt>Runnable</tt> instance.
* @return Remove all waiting tasks for the specified <i>Runnable</i> instance.
*/
public boolean removeWaitingTasks(Runnable task)
{
......@@ -1028,7 +1028,7 @@ public class Processor extends ThreadPoolExecutor
/**
* @param task called task
* @return Remove all waiting tasks for the specified <tt>Callable</tt> instance.
* @return Remove all waiting tasks for the specified <i>Callable</i> instance.
*/
public boolean removeWaitingTasks(Callable<?> task)
{
......
src/main/java/icy/system/thread/SingleProcessor.java
View file @ 0fd9147f
......@@ -43,7 +43,7 @@ public class SingleProcessor extends Processor
/**
* Try to submit the specified task for execution and returns a Future representing that task.<br>
* The Future's <tt>get</tt> method will return <tt>null</tt> upon <em>successful</em>
* The Future's <i>get</i> method will return <i>null</i> upon <em>successful</em>
* completion.<br>
* Returns a <code>null</code> Future object if processor is already processing or queue is not
* empty (depending the {@link #isQueueEnabled()} parameter) to notify the task has been
......
src/main/java/icy/type/DataIterator.java
View file @ 0fd9147f
......@@ -39,7 +39,7 @@ public interface DataIterator
public void next();
/**
* Returns <tt>true</tt> if the iterator has no more elements.
* Returns <i>true</i> if the iterator has no more elements.
*/
public boolean done();
......
src/main/java/icy/type/Position2DIterator.java
View file @ 0fd9147f
......@@ -27,7 +27,7 @@ public interface Position2DIterator
public void next() throws NoSuchElementException;
/**
* Returns <tt>true</tt> if the iterator has no more elements.
* Returns <i>true</i> if the iterator has no more elements.
*/
public boolean done();
......
src/main/java/icy/type/Position5DIterator.java
View file @ 0fd9147f
......@@ -28,7 +28,7 @@ public interface Position5DIterator
public void next() throws NoSuchElementException;
/**
* Returns <tt>true</tt> if the iterator has no more elements.
* Returns <i>true</i> if the iterator has no more elements.
*/
public boolean done();
......
src/main/java/icy/util/StringUtil.java
View file @ 0fd9147f
......@@ -620,7 +620,7 @@ public class StringUtil
}
/**
* Returns a <tt>String</tt> object representing the specified
* Returns a <i>String</i> object representing the specified
* boolean. If the specified boolean is <code>true</code>, then
* the string {@code "true"} will be returned, otherwise the
* string {@code "false"} will be returned.
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment