Javadocs.
This commit is contained in:
@@ -10,6 +10,7 @@ public interface FileSystems extends NativeIntegration {
|
|||||||
/**
|
/**
|
||||||
* Returns the set of all file systems for the current machine.
|
* Returns the set of all file systems for the current machine.
|
||||||
*
|
*
|
||||||
|
* @return The set of file systems. Never returns null.
|
||||||
* @throws NativeException On failure.
|
* @throws NativeException On failure.
|
||||||
*/
|
*/
|
||||||
@ThreadSafe
|
@ThreadSafe
|
||||||
|
|||||||
@@ -56,7 +56,7 @@ public class Native {
|
|||||||
/**
|
/**
|
||||||
* Locates a native integration of the given type.
|
* Locates a native integration of the given type.
|
||||||
*
|
*
|
||||||
* @return The native integration.
|
* @return The native integration. Never returns null.
|
||||||
* @throws NativeIntegrationUnavailableException When the given native integration is not available on the current
|
* @throws NativeIntegrationUnavailableException When the given native integration is not available on the current
|
||||||
* machine.
|
* machine.
|
||||||
* @throws NativeException On failure to load the native integration.
|
* @throws NativeException On failure to load the native integration.
|
||||||
|
|||||||
@@ -37,6 +37,7 @@ public interface Terminal {
|
|||||||
/**
|
/**
|
||||||
* Returns the size of the terminal. Supported by all terminals.
|
* Returns the size of the terminal. Supported by all terminals.
|
||||||
*
|
*
|
||||||
|
* @return The current terminal size. Never returns null.
|
||||||
* @throws NativeException On failure.
|
* @throws NativeException On failure.
|
||||||
*/
|
*/
|
||||||
@ThreadSafe
|
@ThreadSafe
|
||||||
|
|||||||
@@ -25,6 +25,7 @@ public interface Terminals extends NativeIntegration {
|
|||||||
/**
|
/**
|
||||||
* Returns the terminal attached to the given output.
|
* Returns the terminal attached to the given output.
|
||||||
*
|
*
|
||||||
|
* @return The terminal. Never returns null.
|
||||||
* @throws NativeException When the output is not attached to a terminal.
|
* @throws NativeException When the output is not attached to a terminal.
|
||||||
*/
|
*/
|
||||||
@ThreadSafe
|
@ThreadSafe
|
||||||
|
|||||||
@@ -1,7 +1,11 @@
|
|||||||
package net.rubygrapefruit.platform;
|
package net.rubygrapefruit.platform;
|
||||||
|
|
||||||
|
import java.lang.annotation.ElementType;
|
||||||
|
import java.lang.annotation.Target;
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Indicates that the given class or method is thread safe.
|
* Indicates that the given class or method is thread safe.
|
||||||
*/
|
*/
|
||||||
|
@Target({ElementType.TYPE, ElementType.METHOD})
|
||||||
public @interface ThreadSafe {
|
public @interface ThreadSafe {
|
||||||
}
|
}
|
||||||
|
|||||||
Reference in New Issue
Block a user